blob: 5774bfc8657bdf13ee41fd34f71ac0c2ec6971b5 [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
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200666#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
667 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
668 const unsigned char seq_num_placeholder[] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
669#endif
670
Ronald Cron6f135e12021-12-08 16:57:54 +0100671#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100672 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000673 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
674 * which differs from the length of the TLSInnerPlaintext
675 * by the length of the authentication tag. */
676 ad_len_field += taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +0100677 } else
Ronald Cron6f135e12021-12-08 16:57:54 +0100678#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100679 {
Glenn Strauss07c64162022-03-14 12:34:51 -0400680 ((void) tls_version);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000681 ((void) taglen);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200682
Manuel Pégourié-Gonnard61336842022-11-25 11:12:38 +0100683#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
685 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200686 // seq_num_placeholder
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 memcpy(cur, seq_num_placeholder, sizeof(seq_num_placeholder));
688 cur += sizeof(seq_num_placeholder);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200689
690 // tls12_cid type
691 *cur = rec->type;
692 cur++;
693
694 // cid_length
695 *cur = rec->cid_len;
696 cur++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100697 } else
Manuel Pégourié-Gonnard61336842022-11-25 11:12:38 +0100698#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200699 {
700 // epoch + sequence number
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 memcpy(cur, rec->ctr, sizeof(rec->ctr));
702 cur += sizeof(rec->ctr);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200703 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100704 }
705
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200706 // type
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100707 *cur = rec->type;
708 cur++;
709
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200710 // version
Gilles Peskine449bd832023-01-11 14:50:10 +0100711 memcpy(cur, rec->ver, sizeof(rec->ver));
712 cur += sizeof(rec->ver);
Hanno Beckercab87e62019-04-29 13:52:53 +0100713
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200714#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
715 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 1
716
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200718 // CID
719 memcpy(cur, rec->cid, rec->cid_len);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100720 cur += rec->cid_len;
721
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200722 // cid_length
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100723 *cur = rec->cid_len;
724 cur++;
725
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200726 // length of inner plaintext
727 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
728 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100729 } else
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200730#elif defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
731 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
732
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200734 // epoch + sequence number
735 memcpy(cur, rec->ctr, sizeof(rec->ctr));
736 cur += sizeof(rec->ctr);
737
738 // CID
Gilles Peskine449bd832023-01-11 14:50:10 +0100739 memcpy(cur, rec->cid, rec->cid_len);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200740 cur += rec->cid_len;
741
742 // length of inner plaintext
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100744 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100745 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100746#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100747 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100748 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100749 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100750 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100751
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +0000752 *add_data_len = (size_t) (cur - add_data);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000753}
754
Valerio Settie5707042023-10-11 11:54:42 +0200755#if defined(MBEDTLS_SSL_HAVE_AEAD)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200756MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker17263802020-05-28 07:05:48 +0100757static int ssl_transform_aead_dynamic_iv_is_explicit(
Gilles Peskine449bd832023-01-11 14:50:10 +0100758 mbedtls_ssl_transform const *transform)
Hanno Beckerdf8be222020-05-21 15:30:57 +0100759{
Gilles Peskine449bd832023-01-11 14:50:10 +0100760 return transform->ivlen != transform->fixed_ivlen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100761}
762
Hanno Becker17263802020-05-28 07:05:48 +0100763/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
764 *
765 * Concretely, this occurs in two variants:
766 *
767 * a) Fixed and dynamic IV lengths add up to total IV length, giving
768 * IV = fixed_iv || dynamic_iv
769 *
Hanno Becker15952812020-06-04 13:31:46 +0100770 * This variant is used in TLS 1.2 when used with GCM or CCM.
771 *
Hanno Becker17263802020-05-28 07:05:48 +0100772 * b) Fixed IV lengths matches total IV length, giving
773 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100774 *
775 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
776 *
777 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100778 *
779 * This function has the precondition that
780 *
781 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
782 *
783 * which has to be ensured by the caller. If this precondition
784 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100785 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100786static void ssl_build_record_nonce(unsigned char *dst_iv,
787 size_t dst_iv_len,
788 unsigned char const *fixed_iv,
789 size_t fixed_iv_len,
790 unsigned char const *dynamic_iv,
791 size_t dynamic_iv_len)
Hanno Becker17263802020-05-28 07:05:48 +0100792{
Hanno Beckerdf8be222020-05-21 15:30:57 +0100793 /* Start with Fixed IV || 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100794 memset(dst_iv, 0, dst_iv_len);
795 memcpy(dst_iv, fixed_iv, fixed_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100796
Hanno Becker17263802020-05-28 07:05:48 +0100797 dst_iv += dst_iv_len - dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 mbedtls_xor(dst_iv, dst_iv, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100799}
Valerio Settie5707042023-10-11 11:54:42 +0200800#endif /* MBEDTLS_SSL_HAVE_AEAD */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100801
Gilles Peskine449bd832023-01-11 14:50:10 +0100802int mbedtls_ssl_encrypt_buf(mbedtls_ssl_context *ssl,
803 mbedtls_ssl_transform *transform,
Ben Taylor602b2962025-03-07 15:52:50 +0000804 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +0000805{
Neil Armstrong136f8402022-03-30 10:58:01 +0200806 mbedtls_ssl_mode_t ssl_mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100807 int auth_done = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100808 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200809 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 * the description of ssl_extract_add_data_from_record().
811 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200812#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
813 unsigned char add_data[23 + MBEDTLS_SSL_CID_OUT_LEN_MAX];
814#else
815 unsigned char add_data[13];
816#endif
Hanno Beckercab87e62019-04-29 13:52:53 +0100817 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000818 size_t post_avail;
819
820 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000821#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200822 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000823 ((void) ssl);
824#endif
825
Gilles Peskine449bd832023-01-11 14:50:10 +0100826 MBEDTLS_SSL_DEBUG_MSG(2, ("=> encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +0000827
Gilles Peskine449bd832023-01-11 14:50:10 +0100828 if (transform == NULL) {
829 MBEDTLS_SSL_DEBUG_MSG(1, ("no transform provided to encrypt_buf"));
830 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000831 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100832 if (rec == NULL
Hanno Becker43c24b82019-05-01 09:45:57 +0100833 || rec->buf == NULL
834 || rec->buf_len < rec->data_offset
835 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100836#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100837 || rec->cid_len != 0
838#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100839 ) {
840 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to encrypt_buf"));
841 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100842 }
843
Gilles Peskine449bd832023-01-11 14:50:10 +0100844 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Neil Armstrong136f8402022-03-30 10:58:01 +0200845
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000846 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +0100847 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
848 MBEDTLS_SSL_DEBUG_BUF(4, "before encrypt: output payload",
849 data, rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000850
Gilles Peskine449bd832023-01-11 14:50:10 +0100851 if (rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
852 MBEDTLS_SSL_DEBUG_MSG(1, ("Record content %" MBEDTLS_PRINTF_SIZET
853 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
854 rec->data_len,
855 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
856 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000857 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100858
Hanno Becker92313402020-05-20 13:58:58 +0100859 /* The following two code paths implement the (D)TLSInnerPlaintext
860 * structure present in TLS 1.3 and DTLS 1.2 + CID.
861 *
862 * See ssl_build_inner_plaintext() for more information.
863 *
864 * Note that this changes `rec->data_len`, and hence
865 * `post_avail` needs to be recalculated afterwards.
866 *
867 * Note also that the two code paths cannot occur simultaneously
868 * since they apply to different versions of the protocol. There
869 * is hence no risk of double-addition of the inner plaintext.
870 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100871#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100872 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker13996922020-05-28 16:15:19 +0100873 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +0100874 ssl_compute_padding_length(rec->data_len,
875 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
876 if (ssl_build_inner_plaintext(data,
877 &rec->data_len,
878 post_avail,
879 rec->type,
880 padding) != 0) {
881 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerccc13d02020-05-04 12:30:04 +0100882 }
883
884 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
885 }
Ronald Cron6f135e12021-12-08 16:57:54 +0100886#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100887
Hanno Beckera0e20d02019-05-15 14:03:01 +0100888#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100889 /*
890 * Add CID information
891 */
892 rec->cid_len = transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100893 memcpy(rec->cid, transform->out_cid, transform->out_cid_len);
894 MBEDTLS_SSL_DEBUG_BUF(3, "CID", rec->cid, rec->cid_len);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100895
Gilles Peskine449bd832023-01-11 14:50:10 +0100896 if (rec->cid_len != 0) {
Hanno Becker13996922020-05-28 16:15:19 +0100897 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +0100898 ssl_compute_padding_length(rec->data_len,
899 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100900 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100901 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100902 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100903 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100904 * Note that this changes `rec->data_len`, and hence
905 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100906 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100907 if (ssl_build_inner_plaintext(data,
908 &rec->data_len,
909 post_avail,
910 rec->type,
911 padding) != 0) {
912 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100913 }
914
915 rec->type = MBEDTLS_SSL_MSG_CID;
916 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100917#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100918
Gilles Peskine449bd832023-01-11 14:50:10 +0100919 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100920
Paul Bakker5121ce52009-01-03 21:22:43 +0000921 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100922 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000923 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000924#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +0100925 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
926 ssl_mode == MBEDTLS_SSL_MODE_CBC) {
927 if (post_avail < transform->maclen) {
928 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
929 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000930 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200931#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200932 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100933 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstrong26e6d672022-02-23 09:30:33 +0100934 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
935 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
936 size_t sign_mac_length = 0;
Hanno Becker992b6872017-11-09 18:57:39 +0000937
Gilles Peskine449bd832023-01-11 14:50:10 +0100938 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
939 transform->tls_version,
940 transform->taglen);
Hanno Becker992b6872017-11-09 18:57:39 +0000941
Gilles Peskine449bd832023-01-11 14:50:10 +0100942 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
943 transform->psa_mac_alg);
944 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100945 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100946 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100947
Gilles Peskine449bd832023-01-11 14:50:10 +0100948 status = psa_mac_update(&operation, add_data, add_data_len);
949 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100950 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100951 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100952
Gilles Peskine449bd832023-01-11 14:50:10 +0100953 status = psa_mac_update(&operation, data, rec->data_len);
954 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100955 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100957
Gilles Peskine449bd832023-01-11 14:50:10 +0100958 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
959 &sign_mac_length);
960 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100961 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100962 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000963
Gilles Peskine449bd832023-01-11 14:50:10 +0100964 memcpy(data + rec->data_len, mac, transform->maclen);
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200965#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200966
Gilles Peskine449bd832023-01-11 14:50:10 +0100967 MBEDTLS_SSL_DEBUG_BUF(4, "computed mac", data + rec->data_len,
968 transform->maclen);
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200969
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000970 rec->data_len += transform->maclen;
971 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100972 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100973
Gilles Peskine449bd832023-01-11 14:50:10 +0100974hmac_failed_etm_disabled:
975 mbedtls_platform_zeroize(mac, transform->maclen);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500976 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +0100977 status = psa_mac_abort(&operation);
978 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500979 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +0100980 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100981 if (ret != 0) {
982 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_hmac_xxx", ret);
983 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100984 }
Paul Bakker577e0062013-08-28 11:57:20 +0200985 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000986#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000987
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200988 /*
989 * Encrypt
990 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000991#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
993 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
994 "including %d bytes of padding",
995 rec->data_len, 0));
Paul Bakker5121ce52009-01-03 21:22:43 +0000996
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +0100997 /* The only supported stream cipher is "NULL",
998 * so there's nothing to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100999 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001000#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001001
Valerio Settie5707042023-10-11 11:54:42 +02001002#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01001003 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001004 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001005 unsigned char *dynamic_iv;
1006 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +01001007 int dynamic_iv_is_explicit =
Gilles Peskine449bd832023-01-11 14:50:10 +01001008 ssl_transform_aead_dynamic_iv_is_explicit(transform);
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001009 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001010 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001011
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +01001012 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 if (post_avail < transform->taglen) {
1014 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1015 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001016 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001017
Paul Bakker68884e32013-01-07 18:20:04 +01001018 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001019 * Build nonce for AEAD encryption.
1020 *
1021 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1022 * part of the IV is prepended to the ciphertext and
1023 * can be chosen freely - in particular, it need not
1024 * agree with the record sequence number.
1025 * However, since ChaChaPoly as well as all AEAD modes
1026 * in TLS 1.3 use the record sequence number as the
1027 * dynamic part of the nonce, we uniformly use the
1028 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +01001029 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001030 dynamic_iv = rec->ctr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001031 dynamic_iv_len = sizeof(rec->ctr);
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001032
Gilles Peskine449bd832023-01-11 14:50:10 +01001033 ssl_build_record_nonce(iv, sizeof(iv),
1034 transform->iv_enc,
1035 transform->fixed_ivlen,
1036 dynamic_iv,
1037 dynamic_iv_len);
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +01001038
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001039 /*
1040 * Build additional data for AEAD encryption.
1041 * This depends on the TLS version.
1042 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001043 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1044 transform->tls_version,
1045 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001046
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (internal)",
1048 iv, transform->ivlen);
1049 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (transmitted)",
1050 dynamic_iv,
1051 dynamic_iv_is_explicit ? dynamic_iv_len : 0);
1052 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1053 add_data, add_data_len);
1054 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1055 "including 0 bytes of padding",
1056 rec->data_len));
Paul Bakkerca4ab492012-04-18 14:23:57 +00001057
Paul Bakker68884e32013-01-07 18:20:04 +01001058 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001059 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001060 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 status = psa_aead_encrypt(transform->psa_key_enc,
1062 transform->psa_alg,
1063 iv, transform->ivlen,
1064 add_data, add_data_len,
1065 data, rec->data_len,
1066 data, rec->buf_len - (data - rec->buf),
1067 &rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001068
Gilles Peskine449bd832023-01-11 14:50:10 +01001069 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001070 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_encrypt_buf", ret);
1072 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001073 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001074
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 MBEDTLS_SSL_DEBUG_BUF(4, "after encrypt: tag",
1076 data + rec->data_len - transform->taglen,
1077 transform->taglen);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001078 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001079 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001080
1081 /*
1082 * Prefix record content with dynamic IV in case it is explicit.
1083 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 if (dynamic_iv_is_explicit != 0) {
1085 if (rec->data_offset < dynamic_iv_len) {
1086 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1087 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001088 }
1089
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 memcpy(data - dynamic_iv_len, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001091 rec->data_offset -= dynamic_iv_len;
1092 rec->data_len += dynamic_iv_len;
1093 }
1094
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001095 auth_done++;
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 } else
Valerio Settie5707042023-10-11 11:54:42 +02001097#endif /* MBEDTLS_SSL_HAVE_AEAD */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001098#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1100 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00001101 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001102 size_t padlen, i;
1103 size_t olen;
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001104 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001105 size_t part_len;
1106 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001107
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001108 /* Currently we're always using minimal padding
1109 * (up to 255 bytes would be allowed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001110 padlen = transform->ivlen - (rec->data_len + 1) % transform->ivlen;
1111 if (padlen == transform->ivlen) {
Paul Bakker5121ce52009-01-03 21:22:43 +00001112 padlen = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001113 }
1114
Gilles Peskine449bd832023-01-11 14:50:10 +01001115 /* Check there's enough space in the buffer for the padding. */
1116 if (post_avail < padlen + 1) {
1117 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1118 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1119 }
1120
1121 for (i = 0; i <= padlen; i++) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001122 data[rec->data_len + i] = (unsigned char) padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001124
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001125 rec->data_len += padlen + 1;
1126 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001127
TRodziewicz0f82ec62021-05-12 17:49:18 +02001128#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001129 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +02001130 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +00001131 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001132 */
TRodziewicz345165c2021-07-06 13:42:11 +02001133
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 if (rec->data_offset < transform->ivlen) {
1135 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1136 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
TRodziewicz345165c2021-07-06 13:42:11 +02001137 }
1138
1139 /*
1140 * Generate IV
1141 */
Ben Taylor602b2962025-03-07 15:52:50 +00001142 ret = psa_generate_random(transform->iv_enc, transform->ivlen);
Gilles Peskine449bd832023-01-11 14:50:10 +01001143 if (ret != 0) {
1144 return ret;
1145 }
TRodziewicz345165c2021-07-06 13:42:11 +02001146
Gilles Peskine449bd832023-01-11 14:50:10 +01001147 memcpy(data - transform->ivlen, transform->iv_enc, transform->ivlen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001148#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001149
Gilles Peskine449bd832023-01-11 14:50:10 +01001150 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1151 "including %"
1152 MBEDTLS_PRINTF_SIZET
1153 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
1154 rec->data_len, transform->ivlen,
1155 padlen + 1));
Paul Bakker5121ce52009-01-03 21:22:43 +00001156
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 status = psa_cipher_encrypt_setup(&cipher_op,
1158 transform->psa_key_enc, transform->psa_alg);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001159
Gilles Peskine449bd832023-01-11 14:50:10 +01001160 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001161 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001162 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_encrypt_setup", ret);
1163 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001164 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001165
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 status = psa_cipher_set_iv(&cipher_op, transform->iv_enc, transform->ivlen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001167
Gilles Peskine449bd832023-01-11 14:50:10 +01001168 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001169 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1171 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001172
1173 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001174
Gilles Peskine449bd832023-01-11 14:50:10 +01001175 status = psa_cipher_update(&cipher_op,
1176 data, rec->data_len,
1177 data, rec->data_len, &olen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001178
Gilles Peskine449bd832023-01-11 14:50:10 +01001179 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001180 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001181 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1182 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001183
1184 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001185
Gilles Peskine449bd832023-01-11 14:50:10 +01001186 status = psa_cipher_finish(&cipher_op,
1187 data + olen, rec->data_len - olen,
1188 &part_len);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001189
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001191 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001192 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1193 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001194
1195 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001196
1197 olen += part_len;
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001198
Gilles Peskine449bd832023-01-11 14:50:10 +01001199 if (rec->data_len != olen) {
1200 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1201 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001202 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001203
TRodziewicz0f82ec62021-05-12 17:49:18 +02001204 data -= transform->ivlen;
1205 rec->data_offset -= transform->ivlen;
1206 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001207
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001208#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001209 if (auth_done == 0) {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001210 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001211 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1212 size_t sign_mac_length = 0;
Hanno Becker3d8c9072018-01-05 16:24:22 +00001213
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001214 /* MAC(MAC_write_key, add_data, IV, ENC(content + padding + padding_length))
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001215 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001216
Gilles Peskine449bd832023-01-11 14:50:10 +01001217 if (post_avail < transform->maclen) {
1218 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1219 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001220 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001221
Gilles Peskine449bd832023-01-11 14:50:10 +01001222 ssl_extract_add_data_from_record(add_data, &add_data_len,
1223 rec, transform->tls_version,
1224 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001225
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
1227 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1228 add_data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001229 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1230 transform->psa_mac_alg);
1231 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001232 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001233 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001234
Gilles Peskine449bd832023-01-11 14:50:10 +01001235 status = psa_mac_update(&operation, add_data, add_data_len);
1236 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001237 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001238 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001239
Gilles Peskine449bd832023-01-11 14:50:10 +01001240 status = psa_mac_update(&operation, data, rec->data_len);
1241 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001242 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001243 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001244
Gilles Peskine449bd832023-01-11 14:50:10 +01001245 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1246 &sign_mac_length);
1247 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001248 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001249 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001250
Gilles Peskine449bd832023-01-11 14:50:10 +01001251 memcpy(data + rec->data_len, mac, transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001252
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001253 rec->data_len += transform->maclen;
1254 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001255 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001256
Gilles Peskine449bd832023-01-11 14:50:10 +01001257hmac_failed_etm_enabled:
1258 mbedtls_platform_zeroize(mac, transform->maclen);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001259 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 status = psa_mac_abort(&operation);
1261 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001262 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001263 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001264 if (ret != 0) {
1265 MBEDTLS_SSL_DEBUG_RET(1, "HMAC calculation failed", ret);
1266 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001267 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001268 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001269#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01001270 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001271#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001272 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001273 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1274 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001275 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001276
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001277 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01001278 if (auth_done != 1) {
1279 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1280 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001281 }
1282
Gilles Peskine449bd832023-01-11 14:50:10 +01001283 MBEDTLS_SSL_DEBUG_MSG(2, ("<= encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001284
Gilles Peskine449bd832023-01-11 14:50:10 +01001285 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001286}
1287
Gilles Peskine449bd832023-01-11 14:50:10 +01001288int mbedtls_ssl_decrypt_buf(mbedtls_ssl_context const *ssl,
1289 mbedtls_ssl_transform *transform,
1290 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00001291{
Valerio Settie5707042023-10-11 11:54:42 +02001292#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) || defined(MBEDTLS_SSL_HAVE_AEAD)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001293 size_t olen;
Valerio Settie5707042023-10-11 11:54:42 +02001294#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC || MBEDTLS_SSL_HAVE_AEAD */
Neil Armstrong136f8402022-03-30 10:58:01 +02001295 mbedtls_ssl_mode_t ssl_mode;
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001296 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001297
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001298 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001299#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001300 size_t padlen = 0;
1301 mbedtls_ct_condition_t correct = MBEDTLS_CT_TRUE;
Paul Bakker1e5369c2013-12-19 16:40:57 +01001302#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001303 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001304 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +01001305 * the description of ssl_extract_add_data_from_record().
1306 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001307#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1308 unsigned char add_data[23 + MBEDTLS_SSL_CID_IN_LEN_MAX];
1309#else
1310 unsigned char add_data[13];
1311#endif
Hanno Beckercab87e62019-04-29 13:52:53 +01001312 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001313
Hanno Beckera18d1322018-01-03 14:27:32 +00001314#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001315 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001316 ((void) ssl);
1317#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001318
Gilles Peskine449bd832023-01-11 14:50:10 +01001319 MBEDTLS_SSL_DEBUG_MSG(2, ("=> decrypt buf"));
1320 if (rec == NULL ||
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001321 rec->buf == NULL ||
1322 rec->buf_len < rec->data_offset ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001323 rec->buf_len - rec->data_offset < rec->data_len) {
1324 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to decrypt_buf"));
1325 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001326 }
1327
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001328 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01001329 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Paul Bakker5121ce52009-01-03 21:22:43 +00001330
Hanno Beckera0e20d02019-05-15 14:03:01 +01001331#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001332 /*
1333 * Match record's CID with incoming CID.
1334 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 if (rec->cid_len != transform->in_cid_len ||
1336 memcmp(rec->cid, transform->in_cid, rec->cid_len) != 0) {
1337 return MBEDTLS_ERR_SSL_UNEXPECTED_CID;
Hanno Becker938489a2019-05-08 13:02:22 +01001338 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001339#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001340
Hanno Beckerd086bf02021-03-22 13:01:27 +00001341#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001342 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001343 if (rec->data_len < transform->maclen) {
1344 MBEDTLS_SSL_DEBUG_MSG(1,
1345 ("Record too short for MAC:"
1346 " %" MBEDTLS_PRINTF_SIZET " < %" MBEDTLS_PRINTF_SIZET,
1347 rec->data_len, transform->maclen));
1348 return MBEDTLS_ERR_SSL_INVALID_MAC;
1349 }
1350
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001351 /* The only supported stream cipher is "NULL",
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001352 * so there's no encryption to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001353 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001354#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Valerio Settie5707042023-10-11 11:54:42 +02001355#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01001356 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001357 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001358 unsigned char *dynamic_iv;
1359 size_t dynamic_iv_len;
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001360 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001361
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001362 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001363 * Extract dynamic part of nonce for AEAD decryption.
1364 *
1365 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1366 * part of the IV is prepended to the ciphertext and
1367 * can be chosen freely - in particular, it need not
1368 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001369 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001370 dynamic_iv_len = sizeof(rec->ctr);
1371 if (ssl_transform_aead_dynamic_iv_is_explicit(transform) == 1) {
1372 if (rec->data_len < dynamic_iv_len) {
1373 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1374 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
1375 rec->data_len,
1376 dynamic_iv_len));
1377 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001378 }
1379 dynamic_iv = data;
1380
1381 data += dynamic_iv_len;
1382 rec->data_offset += dynamic_iv_len;
1383 rec->data_len -= dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001384 } else {
Hanno Becker17263802020-05-28 07:05:48 +01001385 dynamic_iv = rec->ctr;
1386 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001387
1388 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001389 if (rec->data_len < transform->taglen) {
1390 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1391 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
1392 rec->data_len,
1393 transform->taglen));
1394 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001395 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001396 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001397
Hanno Beckerdf8be222020-05-21 15:30:57 +01001398 /*
1399 * Prepare nonce from dynamic and static parts.
1400 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 ssl_build_record_nonce(iv, sizeof(iv),
1402 transform->iv_dec,
1403 transform->fixed_ivlen,
1404 dynamic_iv,
1405 dynamic_iv_len);
Paul Bakker68884e32013-01-07 18:20:04 +01001406
Hanno Beckerdf8be222020-05-21 15:30:57 +01001407 /*
1408 * Build additional data for AEAD encryption.
1409 * This depends on the TLS version.
1410 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001411 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1412 transform->tls_version,
1413 transform->taglen);
1414 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1415 add_data, add_data_len);
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001416
Hanno Beckerd96a6522019-07-10 13:55:25 +01001417 /* Because of the check above, we know that there are
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001418 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001419 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001420 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001421 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001422
Gilles Peskine449bd832023-01-11 14:50:10 +01001423 MBEDTLS_SSL_DEBUG_BUF(4, "IV used", iv, transform->ivlen);
1424 MBEDTLS_SSL_DEBUG_BUF(4, "TAG used", data + rec->data_len,
1425 transform->taglen);
Paul Bakker68884e32013-01-07 18:20:04 +01001426
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001427 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001428 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001429 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001430 status = psa_aead_decrypt(transform->psa_key_dec,
1431 transform->psa_alg,
1432 iv, transform->ivlen,
1433 add_data, add_data_len,
1434 data, rec->data_len + transform->taglen,
1435 data, rec->buf_len - (data - rec->buf),
1436 &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001437
Gilles Peskine449bd832023-01-11 14:50:10 +01001438 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001439 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001440 MBEDTLS_SSL_DEBUG_RET(1, "psa_aead_decrypt", ret);
1441 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001442 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001443
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001444 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001445
Hanno Beckerd96a6522019-07-10 13:55:25 +01001446 /* Double-check that AEAD decryption doesn't change content length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001447 if (olen != rec->data_len) {
1448 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1449 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001450 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001451 } else
Valerio Settie5707042023-10-11 11:54:42 +02001452#endif /* MBEDTLS_SSL_HAVE_AEAD */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001453#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001454 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1455 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001456 size_t minlen = 0;
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001457 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001458 size_t part_len;
1459 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001460
Paul Bakker5121ce52009-01-03 21:22:43 +00001461 /*
Paul Bakker45829992013-01-03 14:52:21 +01001462 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001463 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001464#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001465 /* The ciphertext is prefixed with the CBC IV. */
1466 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001467#endif
Paul Bakker45829992013-01-03 14:52:21 +01001468
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001469 /* Size considerations:
1470 *
1471 * - The CBC cipher text must not be empty and hence
1472 * at least of size transform->ivlen.
1473 *
1474 * Together with the potential IV-prefix, this explains
1475 * the first of the two checks below.
1476 *
1477 * - The record must contain a MAC, either in plain or
1478 * encrypted, depending on whether Encrypt-then-MAC
1479 * is used or not.
1480 * - If it is, the message contains the IV-prefix,
1481 * the CBC ciphertext, and the MAC.
1482 * - If it is not, the padded plaintext, and hence
1483 * the CBC ciphertext, has at least length maclen + 1
1484 * because there is at least the padding length byte.
1485 *
1486 * As the CBC ciphertext is not empty, both cases give the
1487 * lower bound minlen + maclen + 1 on the record size, which
1488 * we test for in the second check below.
1489 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001490 if (rec->data_len < minlen + transform->ivlen ||
1491 rec->data_len < minlen + transform->maclen + 1) {
1492 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1493 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1494 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
1495 "+ 1 ) ( + expl IV )",
1496 rec->data_len,
1497 transform->ivlen,
1498 transform->maclen));
1499 return MBEDTLS_ERR_SSL_INVALID_MAC;
Paul Bakker45829992013-01-03 14:52:21 +01001500 }
1501
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001502 /*
1503 * Authenticate before decrypt if enabled
1504 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001505#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001506 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001507 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001508
Gilles Peskine449bd832023-01-11 14:50:10 +01001509 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001510
Hanno Beckerd96a6522019-07-10 13:55:25 +01001511 /* Update data_len in tandem with add_data.
1512 *
1513 * The subtraction is safe because of the previous check
1514 * data_len >= minlen + maclen + 1.
1515 *
1516 * Afterwards, we know that data + data_len is followed by at
1517 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001518 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001519 *
1520 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001521 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1523 transform->tls_version,
1524 transform->taglen);
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001525
Hanno Beckerd96a6522019-07-10 13:55:25 +01001526 /* Calculate expected MAC. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001527 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1528 add_data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 status = psa_mac_verify_setup(&operation, transform->psa_mac_dec,
1530 transform->psa_mac_alg);
1531 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001532 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001533 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001534
Gilles Peskine449bd832023-01-11 14:50:10 +01001535 status = psa_mac_update(&operation, add_data, add_data_len);
1536 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001537 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001538 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001539
Gilles Peskine449bd832023-01-11 14:50:10 +01001540 status = psa_mac_update(&operation, data, rec->data_len);
1541 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001542 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001543 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001544
1545 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001546 status = psa_mac_verify_finish(&operation, data + rec->data_len,
1547 transform->maclen);
1548 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001549 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001550 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001551 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001552
Gilles Peskine449bd832023-01-11 14:50:10 +01001553hmac_failed_etm_enabled:
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001554 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 status = psa_mac_abort(&operation);
1556 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001557 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001558 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001559 if (ret != 0) {
1560 if (ret != MBEDTLS_ERR_SSL_INVALID_MAC) {
1561 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_hmac_xxx", ret);
1562 }
1563 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001564 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001565 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001566#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001567
1568 /*
1569 * Check length sanity
1570 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001571
1572 /* We know from above that data_len > minlen >= 0,
1573 * so the following check in particular implies that
1574 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001575 if (rec->data_len % transform->ivlen != 0) {
1576 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1577 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
1578 rec->data_len, transform->ivlen));
1579 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001580 }
1581
TRodziewicz0f82ec62021-05-12 17:49:18 +02001582#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001583 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001584 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001585 */
TRodziewicz345165c2021-07-06 13:42:11 +02001586 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001587 memcpy(transform->iv_dec, data, transform->ivlen);
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001588
TRodziewicz345165c2021-07-06 13:42:11 +02001589 data += transform->ivlen;
1590 rec->data_offset += transform->ivlen;
1591 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001592#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001593
Hanno Beckerd96a6522019-07-10 13:55:25 +01001594 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1595
Gilles Peskine449bd832023-01-11 14:50:10 +01001596 status = psa_cipher_decrypt_setup(&cipher_op,
1597 transform->psa_key_dec, transform->psa_alg);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001598
Gilles Peskine449bd832023-01-11 14:50:10 +01001599 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001600 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001601 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_decrypt_setup", ret);
1602 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001603 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001604
Gilles Peskine449bd832023-01-11 14:50:10 +01001605 status = psa_cipher_set_iv(&cipher_op, transform->iv_dec, transform->ivlen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001606
Gilles Peskine449bd832023-01-11 14:50:10 +01001607 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001608 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001609 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1610 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001611 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001612
Gilles Peskine449bd832023-01-11 14:50:10 +01001613 status = psa_cipher_update(&cipher_op,
1614 data, rec->data_len,
1615 data, rec->data_len, &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001616
Gilles Peskine449bd832023-01-11 14:50:10 +01001617 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001618 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001619 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1620 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001621 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001622
Gilles Peskine449bd832023-01-11 14:50:10 +01001623 status = psa_cipher_finish(&cipher_op,
1624 data + olen, rec->data_len - olen,
1625 &part_len);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001626
Gilles Peskine449bd832023-01-11 14:50:10 +01001627 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001628 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001629 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1630 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001631 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001632
1633 olen += part_len;
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001634
Hanno Beckerd96a6522019-07-10 13:55:25 +01001635 /* Double-check that length hasn't changed during decryption. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001636 if (rec->data_len != olen) {
1637 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1638 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001639 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001640
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001641 /* Safe since data_len >= minlen + maclen + 1, so after having
1642 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001643 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1644 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001645 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001646
Gilles Peskine449bd832023-01-11 14:50:10 +01001647 if (auth_done == 1) {
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001648 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001649 rec->data_len,
1650 padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001651 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001652 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Gilles Peskine449bd832023-01-11 14:50:10 +01001653 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001654#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001655 if (rec->data_len < transform->maclen + padlen + 1) {
1656 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1657 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1658 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
1659 rec->data_len,
1660 transform->maclen,
1661 padlen + 1));
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001662 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001663#endif
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001664 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001665 rec->data_len,
1666 transform->maclen + padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001667 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001668 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Paul Bakker45829992013-01-03 14:52:21 +01001669 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001670
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001671 padlen++;
1672
1673 /* Regardless of the validity of the padding,
1674 * we have data_len >= padlen here. */
1675
TRodziewicz0f82ec62021-05-12 17:49:18 +02001676#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001677 /* The padding check involves a series of up to 256
Gilles Peskine449bd832023-01-11 14:50:10 +01001678 * consecutive memory reads at the end of the record
1679 * plaintext buffer. In order to hide the length and
1680 * validity of the padding, always perform exactly
1681 * `min(256,plaintext_len)` reads (but take into account
1682 * only the last `padlen` bytes for the padding check). */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001683 size_t pad_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001684 volatile unsigned char * const check = data;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001685
1686 /* Index of first padding byte; it has been ensured above
Gilles Peskine449bd832023-01-11 14:50:10 +01001687 * that the subtraction is safe. */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001688 size_t const padding_idx = rec->data_len - padlen;
1689 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1690 size_t const start_idx = rec->data_len - num_checks;
1691 size_t idx;
1692
Gilles Peskine449bd832023-01-11 14:50:10 +01001693 for (idx = start_idx; idx < rec->data_len; idx++) {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001694 /* pad_count += (idx >= padding_idx) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001695 * (check[idx] == padlen - 1);
1696 */
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001697 const mbedtls_ct_condition_t a = mbedtls_ct_uint_ge(idx, padding_idx);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001698 size_t increment = mbedtls_ct_size_if_else_0(a, 1);
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001699 const mbedtls_ct_condition_t b = mbedtls_ct_uint_eq(check[idx], padlen - 1);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001700 increment = mbedtls_ct_size_if_else_0(b, increment);
Dave Rodgmana81373f2023-05-17 12:36:01 +01001701 pad_count += increment;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001702 }
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001703 correct = mbedtls_ct_bool_and(mbedtls_ct_uint_eq(pad_count, padlen), correct);
Paul Bakkere47b34b2013-02-27 14:48:00 +01001704
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001705#if defined(MBEDTLS_SSL_DEBUG_ALL)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001706 if (padlen > 0 && correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001707 MBEDTLS_SSL_DEBUG_MSG(1, ("bad padding byte detected"));
1708 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001709#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001710 padlen = mbedtls_ct_size_if_else_0(correct, padlen);
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001711
TRodziewicz0f82ec62021-05-12 17:49:18 +02001712#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001713
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001714 /* If the padding was found to be invalid, padlen == 0
1715 * and the subtraction is safe. If the padding was found valid,
1716 * padlen hasn't been changed and the previous assertion
1717 * data_len >= padlen still holds. */
1718 rec->data_len -= padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001719 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001720#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001721 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001722 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1723 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001724 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001725
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001726#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 MBEDTLS_SSL_DEBUG_BUF(4, "raw buffer after decryption",
1728 data, rec->data_len);
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001729#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001730
1731 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001732 * Authenticate if not done yet.
1733 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001734 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001735#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 if (auth_done == 0) {
Paul Elliott5260ce22022-05-09 18:15:54 +01001737 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
1738 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01001739
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001740 /* For CBC+MAC, If the initial value of padlen was such that
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001741 * data_len < maclen + padlen + 1, then padlen
1742 * got reset to 1, and the initial check
1743 * data_len >= minlen + maclen + 1
1744 * guarantees that at this point we still
1745 * have at least data_len >= maclen.
1746 *
1747 * If the initial value of padlen was such that
1748 * data_len >= maclen + padlen + 1, then we have
1749 * subtracted either padlen + 1 (if the padding was correct)
1750 * or 0 (if the padding was incorrect) since then,
1751 * hence data_len >= maclen in any case.
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001752 *
1753 * For stream ciphers, we checked above that
1754 * data_len >= maclen.
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001755 */
1756 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001757 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1758 transform->tls_version,
1759 transform->taglen);
Paul Bakker5121ce52009-01-03 21:22:43 +00001760
TRodziewicz0f82ec62021-05-12 17:49:18 +02001761#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001762 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001763 * The next two sizes are the minimum and maximum values of
1764 * data_len over all padlen values.
1765 *
1766 * They're independent of padlen, since we previously did
1767 * data_len -= padlen.
1768 *
1769 * Note that max_len + maclen is never more than the buffer
1770 * length, as we previously did in_msglen -= maclen too.
1771 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001772 const size_t max_len = rec->data_len + padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001773 const size_t min_len = (max_len > 256) ? max_len - 256 : 0;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001774
Gilles Peskine449bd832023-01-11 14:50:10 +01001775 ret = mbedtls_ct_hmac(transform->psa_mac_dec,
1776 transform->psa_mac_alg,
1777 add_data, add_data_len,
1778 data, rec->data_len, min_len, max_len,
1779 mac_expect);
Gilles Peskine449bd832023-01-11 14:50:10 +01001780 if (ret != 0) {
1781 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ct_hmac", ret);
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001782 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001783 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001784
Gilles Peskine449bd832023-01-11 14:50:10 +01001785 mbedtls_ct_memcpy_offset(mac_peer, data,
1786 rec->data_len,
1787 min_len, max_len,
1788 transform->maclen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001789#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001790
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001791#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001792 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect, transform->maclen);
1793 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", mac_peer, transform->maclen);
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001794#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001795
Gilles Peskine449bd832023-01-11 14:50:10 +01001796 if (mbedtls_ct_memcmp(mac_peer, mac_expect,
1797 transform->maclen) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001798#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001799 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Paul Bakkere47b34b2013-02-27 14:48:00 +01001800#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001801 correct = MBEDTLS_CT_FALSE;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001802 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001803 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001804
Gilles Peskine449bd832023-01-11 14:50:10 +01001805hmac_failed_etm_disabled:
1806 mbedtls_platform_zeroize(mac_peer, transform->maclen);
1807 mbedtls_platform_zeroize(mac_expect, transform->maclen);
1808 if (ret != 0) {
1809 return ret;
1810 }
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001811 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001812
1813 /*
1814 * Finally check the correct flag
1815 */
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001816 if (correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001817 return MBEDTLS_ERR_SSL_INVALID_MAC;
1818 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001819#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001820
1821 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01001822 if (auth_done != 1) {
1823 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1824 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001825 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001826
Ronald Cron6f135e12021-12-08 16:57:54 +01001827#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001828 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Beckerccc13d02020-05-04 12:30:04 +01001829 /* Remove inner padding and infer true content type. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
1831 &rec->type);
Hanno Beckerccc13d02020-05-04 12:30:04 +01001832
Gilles Peskine449bd832023-01-11 14:50:10 +01001833 if (ret != 0) {
1834 return MBEDTLS_ERR_SSL_INVALID_RECORD;
1835 }
Hanno Beckerccc13d02020-05-04 12:30:04 +01001836 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001837#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001838
Hanno Beckera0e20d02019-05-15 14:03:01 +01001839#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01001840 if (rec->cid_len != 0) {
1841 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
1842 &rec->type);
1843 if (ret != 0) {
1844 return MBEDTLS_ERR_SSL_INVALID_RECORD;
1845 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001846 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001847#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001848
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 MBEDTLS_SSL_DEBUG_MSG(2, ("<= decrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001850
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001852}
1853
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001854#undef MAC_NONE
1855#undef MAC_PLAINTEXT
1856#undef MAC_CIPHERTEXT
1857
Paul Bakker5121ce52009-01-03 21:22:43 +00001858/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001859 * Fill the input message buffer by appending data to it.
1860 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001861 *
1862 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1863 * available (from this read and/or a previous one). Otherwise, an error code
1864 * is returned (possibly EOF or WANT_READ).
1865 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001866 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1867 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1868 * since we always read a whole datagram at once.
1869 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001870 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001871 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001872 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001873int mbedtls_ssl_fetch_input(mbedtls_ssl_context *ssl, size_t nb_want)
Paul Bakker5121ce52009-01-03 21:22:43 +00001874{
Janos Follath865b3eb2019-12-16 11:46:15 +00001875 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001876 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001877#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1878 size_t in_buf_len = ssl->in_buf_len;
1879#else
1880 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1881#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001882
Gilles Peskine449bd832023-01-11 14:50:10 +01001883 MBEDTLS_SSL_DEBUG_MSG(2, ("=> fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001884
Gilles Peskine449bd832023-01-11 14:50:10 +01001885 if (ssl->f_recv == NULL && ssl->f_recv_timeout == NULL) {
1886 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
1887 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001888 }
1889
Gilles Peskine449bd832023-01-11 14:50:10 +01001890 if (nb_want > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
1891 MBEDTLS_SSL_DEBUG_MSG(1, ("requesting more data than fits"));
1892 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001893 }
1894
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001895#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001896 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001897 uint32_t timeout;
1898
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001899 /*
1900 * The point is, we need to always read a full datagram at once, so we
1901 * sometimes read more then requested, and handle the additional data.
1902 * It could be the rest of the current record (while fetching the
1903 * header) and/or some other records in the same datagram.
1904 */
1905
1906 /*
1907 * Move to the next record in the already read datagram if applicable
1908 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001909 if (ssl->next_record_offset != 0) {
1910 if (ssl->in_left < ssl->next_record_offset) {
1911 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1912 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001913 }
1914
1915 ssl->in_left -= ssl->next_record_offset;
1916
Gilles Peskine449bd832023-01-11 14:50:10 +01001917 if (ssl->in_left != 0) {
1918 MBEDTLS_SSL_DEBUG_MSG(2, ("next record in same datagram, offset: %"
1919 MBEDTLS_PRINTF_SIZET,
1920 ssl->next_record_offset));
1921 memmove(ssl->in_hdr,
1922 ssl->in_hdr + ssl->next_record_offset,
1923 ssl->in_left);
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001924 }
1925
1926 ssl->next_record_offset = 0;
1927 }
1928
Gilles Peskine449bd832023-01-11 14:50:10 +01001929 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
1930 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
1931 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001932
1933 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001934 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001935 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001936 if (nb_want <= ssl->in_left) {
1937 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
1938 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001939 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001940
1941 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001942 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001943 * are not at the beginning of a new record, the caller did something
1944 * wrong.
1945 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001946 if (ssl->in_left != 0) {
1947 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1948 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001949 }
1950
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001951 /*
1952 * Don't even try to read if time's out already.
1953 * This avoids by-passing the timer when repeatedly receiving messages
1954 * that will end up being dropped.
1955 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001956 if (mbedtls_ssl_check_timer(ssl) != 0) {
1957 MBEDTLS_SSL_DEBUG_MSG(2, ("timer has expired"));
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001958 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 } else {
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00001960 len = in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001961
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001963 timeout = ssl->handshake->retransmit_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01001964 } else {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001965 timeout = ssl->conf->read_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001967
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 MBEDTLS_SSL_DEBUG_MSG(3, ("f_recv_timeout: %lu ms", (unsigned long) timeout));
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001969
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 if (ssl->f_recv_timeout != NULL) {
1971 ret = ssl->f_recv_timeout(ssl->p_bio, ssl->in_hdr, len,
1972 timeout);
1973 } else {
1974 ret = ssl->f_recv(ssl->p_bio, ssl->in_hdr, len);
1975 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001976
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001978
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 if (ret == 0) {
1980 return MBEDTLS_ERR_SSL_CONN_EOF;
1981 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001982 }
1983
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 if (ret == MBEDTLS_ERR_SSL_TIMEOUT) {
1985 MBEDTLS_SSL_DEBUG_MSG(2, ("timeout"));
1986 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001987
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
1989 if (ssl_double_retransmit_timeout(ssl) != 0) {
1990 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake timeout"));
1991 return MBEDTLS_ERR_SSL_TIMEOUT;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001992 }
1993
Gilles Peskine449bd832023-01-11 14:50:10 +01001994 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
1995 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
1996 return ret;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001997 }
1998
Gilles Peskine449bd832023-01-11 14:50:10 +01001999 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002000 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002001#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 else if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
2003 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
2004 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
2005 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
2006 ret);
2007 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002008 }
2009
Gilles Peskine449bd832023-01-11 14:50:10 +01002010 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002011 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002012#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002013 }
2014
Gilles Peskine449bd832023-01-11 14:50:10 +01002015 if (ret < 0) {
2016 return ret;
2017 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002018
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002019 ssl->in_left = ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002020 } else
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002021#endif
2022 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002023 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2024 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2025 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002026
Gilles Peskine449bd832023-01-11 14:50:10 +01002027 while (ssl->in_left < nb_want) {
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002028 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002029
Gilles Peskine449bd832023-01-11 14:50:10 +01002030 if (mbedtls_ssl_check_timer(ssl) != 0) {
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002031 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002032 } else {
2033 if (ssl->f_recv_timeout != NULL) {
2034 ret = ssl->f_recv_timeout(ssl->p_bio,
2035 ssl->in_hdr + ssl->in_left, len,
2036 ssl->conf->read_timeout);
2037 } else {
2038 ret = ssl->f_recv(ssl->p_bio,
2039 ssl->in_hdr + ssl->in_left, len);
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002040 }
2041 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002042
Gilles Peskine449bd832023-01-11 14:50:10 +01002043 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2044 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2045 ssl->in_left, nb_want));
2046 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002047
Gilles Peskine449bd832023-01-11 14:50:10 +01002048 if (ret == 0) {
2049 return MBEDTLS_ERR_SSL_CONN_EOF;
2050 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002051
Gilles Peskine449bd832023-01-11 14:50:10 +01002052 if (ret < 0) {
2053 return ret;
2054 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002055
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002056 if ((size_t) ret > len) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002057 MBEDTLS_SSL_DEBUG_MSG(1,
2058 ("f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2059 " were requested",
2060 ret, len));
2061 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16035bd15cb2018-02-28 04:30:59 -08002062 }
2063
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002064 ssl->in_left += ret;
2065 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002066 }
2067
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002069
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002071}
2072
2073/*
2074 * Flush any data not yet written
2075 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002076int mbedtls_ssl_flush_output(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002077{
Janos Follath865b3eb2019-12-16 11:46:15 +00002078 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002079 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002080
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 MBEDTLS_SSL_DEBUG_MSG(2, ("=> flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002082
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 if (ssl->f_send == NULL) {
2084 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2085 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002086 }
2087
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002088 /* Avoid incrementing counter if data is flushed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002089 if (ssl->out_left == 0) {
2090 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
2091 return 0;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002092 }
2093
Gilles Peskine449bd832023-01-11 14:50:10 +01002094 while (ssl->out_left > 0) {
2095 MBEDTLS_SSL_DEBUG_MSG(2, ("message length: %" MBEDTLS_PRINTF_SIZET
2096 ", out_left: %" MBEDTLS_PRINTF_SIZET,
2097 mbedtls_ssl_out_hdr_len(ssl) + ssl->out_msglen, ssl->out_left));
Paul Bakker5121ce52009-01-03 21:22:43 +00002098
Hanno Becker2b1e3542018-08-06 11:19:13 +01002099 buf = ssl->out_hdr - ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 ret = ssl->f_send(ssl->p_bio, buf, ssl->out_left);
Paul Bakker186751d2012-05-08 13:16:14 +00002101
Gilles Peskine449bd832023-01-11 14:50:10 +01002102 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", ret);
Paul Bakker5121ce52009-01-03 21:22:43 +00002103
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 if (ret <= 0) {
2105 return ret;
2106 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002107
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002108 if ((size_t) ret > ssl->out_left) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002109 MBEDTLS_SSL_DEBUG_MSG(1,
2110 ("f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2111 " bytes were sent",
2112 ret, ssl->out_left));
2113 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16034bbaeb42018-02-22 04:29:04 -08002114 }
2115
Paul Bakker5121ce52009-01-03 21:22:43 +00002116 ssl->out_left -= ret;
2117 }
2118
Hanno Becker2b1e3542018-08-06 11:19:13 +01002119#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002121 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 } else
Hanno Becker2b1e3542018-08-06 11:19:13 +01002123#endif
2124 {
2125 ssl->out_hdr = ssl->out_buf + 8;
2126 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002128
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002130
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002132}
2133
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002134/*
2135 * Functions to handle the DTLS retransmission state machine
2136 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002137#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002138/*
2139 * Append current handshake message to current outgoing flight
2140 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002141MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002142static int ssl_flight_append(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002143{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002144 mbedtls_ssl_flight_item *msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002145 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_flight_append"));
2146 MBEDTLS_SSL_DEBUG_BUF(4, "message appended to flight",
2147 ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002148
2149 /* Allocate space for current message */
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 if ((msg = mbedtls_calloc(1, sizeof(mbedtls_ssl_flight_item))) == NULL) {
2151 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2152 sizeof(mbedtls_ssl_flight_item)));
2153 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002154 }
2155
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 if ((msg->p = mbedtls_calloc(1, ssl->out_msglen)) == NULL) {
2157 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2158 ssl->out_msglen));
2159 mbedtls_free(msg);
2160 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002161 }
2162
2163 /* Copy current handshake message with headers */
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 memcpy(msg->p, ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002165 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002166 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002167 msg->next = NULL;
2168
2169 /* Append to the current flight */
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 if (ssl->handshake->flight == NULL) {
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002171 ssl->handshake->flight = msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002173 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 while (cur->next != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002175 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002177 cur->next = msg;
2178 }
2179
Gilles Peskine449bd832023-01-11 14:50:10 +01002180 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_flight_append"));
2181 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002182}
2183
2184/*
2185 * Free the current flight of handshake messages
2186 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002187void mbedtls_ssl_flight_free(mbedtls_ssl_flight_item *flight)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002188{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002189 mbedtls_ssl_flight_item *cur = flight;
2190 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002191
Gilles Peskine449bd832023-01-11 14:50:10 +01002192 while (cur != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002193 next = cur->next;
2194
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 mbedtls_free(cur->p);
2196 mbedtls_free(cur);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002197
2198 cur = next;
2199 }
2200}
2201
2202/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002203 * Swap transform_out and out_ctr with the alternative ones
2204 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002205MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002206static int ssl_swap_epochs(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002207{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002208 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002209 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002210
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 if (ssl->transform_out == ssl->handshake->alt_transform_out) {
2212 MBEDTLS_SSL_DEBUG_MSG(3, ("skip swap epochs"));
2213 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002214 }
2215
Gilles Peskine449bd832023-01-11 14:50:10 +01002216 MBEDTLS_SSL_DEBUG_MSG(3, ("swap epochs"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002217
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002218 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002219 tmp_transform = ssl->transform_out;
2220 ssl->transform_out = ssl->handshake->alt_transform_out;
2221 ssl->handshake->alt_transform_out = tmp_transform;
2222
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002223 /* Swap epoch + sequence_number */
Gilles Peskine449bd832023-01-11 14:50:10 +01002224 memcpy(tmp_out_ctr, ssl->cur_out_ctr, sizeof(tmp_out_ctr));
2225 memcpy(ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2226 sizeof(ssl->cur_out_ctr));
2227 memcpy(ssl->handshake->alt_out_ctr, tmp_out_ctr,
2228 sizeof(ssl->handshake->alt_out_ctr));
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002229
2230 /* Adjust to the newly activated transform */
Gilles Peskine449bd832023-01-11 14:50:10 +01002231 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002232
Gilles Peskine449bd832023-01-11 14:50:10 +01002233 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002234}
2235
2236/*
2237 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002238 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002239int mbedtls_ssl_resend(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002240{
2241 int ret = 0;
2242
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 ret = mbedtls_ssl_flight_transmit(ssl);
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002246
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002248
Gilles Peskine449bd832023-01-11 14:50:10 +01002249 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002250}
2251
2252/*
2253 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002254 *
2255 * Need to remember the current message in case flush_output returns
2256 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002257 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002258 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002259int mbedtls_ssl_flight_transmit(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002260{
Janos Follath865b3eb2019-12-16 11:46:15 +00002261 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_flight_transmit"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002263
Gilles Peskine449bd832023-01-11 14:50:10 +01002264 if (ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING) {
2265 MBEDTLS_SSL_DEBUG_MSG(2, ("initialise flight transmission"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002266
2267 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002268 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 ret = ssl_swap_epochs(ssl);
2270 if (ret != 0) {
2271 return ret;
2272 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002273
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002274 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002275 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002276
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 while (ssl->handshake->cur_msg != NULL) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002278 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002279 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002280
Hanno Beckere1dcb032018-08-17 16:47:58 +01002281 int const is_finished =
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 (cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2283 cur->p[0] == MBEDTLS_SSL_HS_FINISHED);
Hanno Beckere1dcb032018-08-17 16:47:58 +01002284
Ronald Cron00d012f22022-03-08 15:57:12 +01002285 int const force_flush = ssl->disable_datagram_packing == 1 ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
Hanno Becker04da1892018-08-14 13:22:10 +01002287
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002288 /* Swap epochs before sending Finished: we can't do it after
2289 * sending ChangeCipherSpec, in case write returns WANT_READ.
2290 * Must be done before copying, may change out_msg pointer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 if (is_finished && ssl->handshake->cur_msg_p == (cur->p + 12)) {
2292 MBEDTLS_SSL_DEBUG_MSG(2, ("swap epochs to send finished message"));
2293 ret = ssl_swap_epochs(ssl);
2294 if (ret != 0) {
2295 return ret;
2296 }
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002297 }
2298
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 ret = ssl_get_remaining_payload_in_datagram(ssl);
2300 if (ret < 0) {
2301 return ret;
2302 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002303 max_frag_len = (size_t) ret;
2304
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002305 /* CCS is copied as is, while HS messages may need fragmentation */
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 if (cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2307 if (max_frag_len == 0) {
2308 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2309 return ret;
2310 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002311
2312 continue;
2313 }
2314
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 memcpy(ssl->out_msg, cur->p, cur->len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002316 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002317 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002318
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002319 /* Update position inside current message */
2320 ssl->handshake->cur_msg_p += cur->len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002322 const unsigned char * const p = ssl->handshake->cur_msg_p;
2323 const size_t hs_len = cur->len - 12;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002324 const size_t frag_off = (size_t) (p - (cur->p + 12));
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002325 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002326 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002327
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 if ((max_frag_len < 12) || (max_frag_len == 12 && hs_len != 0)) {
2329 if (is_finished) {
2330 ret = ssl_swap_epochs(ssl);
2331 if (ret != 0) {
2332 return ret;
2333 }
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002334 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002335
Gilles Peskine449bd832023-01-11 14:50:10 +01002336 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2337 return ret;
2338 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002339
2340 continue;
2341 }
2342 max_hs_frag_len = max_frag_len - 12;
2343
2344 cur_hs_frag_len = rem_len > max_hs_frag_len ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 max_hs_frag_len : rem_len;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002346
Gilles Peskine449bd832023-01-11 14:50:10 +01002347 if (frag_off == 0 && cur_hs_frag_len != hs_len) {
2348 MBEDTLS_SSL_DEBUG_MSG(2, ("fragmenting handshake message (%u > %u)",
2349 (unsigned) cur_hs_frag_len,
2350 (unsigned) max_hs_frag_len));
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002351 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002352
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002353 /* Messages are stored with handshake headers as if not fragmented,
2354 * copy beginning of headers then fill fragmentation fields.
2355 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 memcpy(ssl->out_msg, cur->p, 6);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002357
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 ssl->out_msg[6] = MBEDTLS_BYTE_2(frag_off);
2359 ssl->out_msg[7] = MBEDTLS_BYTE_1(frag_off);
2360 ssl->out_msg[8] = MBEDTLS_BYTE_0(frag_off);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002361
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 ssl->out_msg[9] = MBEDTLS_BYTE_2(cur_hs_frag_len);
2363 ssl->out_msg[10] = MBEDTLS_BYTE_1(cur_hs_frag_len);
2364 ssl->out_msg[11] = MBEDTLS_BYTE_0(cur_hs_frag_len);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002365
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 MBEDTLS_SSL_DEBUG_BUF(3, "handshake header", ssl->out_msg, 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002367
Hanno Becker3f7b9732018-08-28 09:53:25 +01002368 /* Copy the handshake message content and set records fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 memcpy(ssl->out_msg + 12, p, cur_hs_frag_len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002370 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002371 ssl->out_msgtype = cur->type;
2372
2373 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002374 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002375 }
2376
2377 /* If done with the current message move to the next one if any */
Gilles Peskine449bd832023-01-11 14:50:10 +01002378 if (ssl->handshake->cur_msg_p >= cur->p + cur->len) {
2379 if (cur->next != NULL) {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002380 ssl->handshake->cur_msg = cur->next;
2381 ssl->handshake->cur_msg_p = cur->next->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002383 ssl->handshake->cur_msg = NULL;
2384 ssl->handshake->cur_msg_p = NULL;
2385 }
2386 }
2387
2388 /* Actually send the message out */
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2390 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
2391 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002392 }
2393 }
2394
Gilles Peskine449bd832023-01-11 14:50:10 +01002395 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2396 return ret;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002397 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002398
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 /* Update state and set timer */
2400 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
2401 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
2402 } else {
2403 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
2404 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
2405 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002406
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_flight_transmit"));
2408
2409 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002410}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002411
2412/*
2413 * To be called when the last message of an incoming flight is received.
2414 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002415void mbedtls_ssl_recv_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002416{
2417 /* We won't need to resend that one any more */
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 mbedtls_ssl_flight_free(ssl->handshake->flight);
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002419 ssl->handshake->flight = NULL;
2420 ssl->handshake->cur_msg = NULL;
2421
2422 /* The next incoming flight will start with this msg_seq */
2423 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2424
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002425 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002426 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002427
Hanno Becker0271f962018-08-16 13:23:47 +01002428 /* Clear future message buffering structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002429 mbedtls_ssl_buffering_free(ssl);
Hanno Becker0271f962018-08-16 13:23:47 +01002430
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002431 /* Cancel timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002433
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2435 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002436 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002438 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002440}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002441
2442/*
2443 * To be called when the last message of an outgoing flight is send.
2444 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002445void mbedtls_ssl_send_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002446{
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 ssl_reset_retransmit_timeout(ssl);
2448 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002449
Gilles Peskine449bd832023-01-11 14:50:10 +01002450 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2451 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002452 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002454 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002455 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002456}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002457#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002458
Paul Bakker5121ce52009-01-03 21:22:43 +00002459/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002460 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002461 */
Dave Rodgmanc37ad442023-11-03 23:36:06 +00002462int mbedtls_ssl_start_handshake_msg(mbedtls_ssl_context *ssl, unsigned char hs_type,
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 unsigned char **buf, size_t *buf_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002464{
2465 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002466 * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002467 * ...
2468 * HandshakeType msg_type;
2469 * uint24 length;
2470 * ...
2471 */
2472 *buf = ssl->out_msg + 4;
2473 *buf_len = MBEDTLS_SSL_OUT_CONTENT_LEN - 4;
2474
2475 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2476 ssl->out_msg[0] = hs_type;
2477
Gilles Peskine449bd832023-01-11 14:50:10 +01002478 return 0;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002479}
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002480
2481/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002482 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002483 *
2484 * - fill in handshake headers
2485 * - update handshake checksum
2486 * - DTLS: save message for resending
2487 * - then pass to the record layer
2488 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002489 * DTLS: except for HelloRequest, messages are only queued, and will only be
2490 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002491 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002492 * Inputs:
2493 * - ssl->out_msglen: 4 + actual handshake message len
2494 * (4 is the size of handshake headers for TLS)
2495 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2496 * - ssl->out_msg + 4: the handshake message body
2497 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002498 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002499 * - ssl->out_msglen: the length of the record contents
2500 * (including handshake headers but excluding record headers)
2501 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002502 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002503int mbedtls_ssl_write_handshake_msg_ext(mbedtls_ssl_context *ssl,
2504 int update_checksum,
2505 int force_flush)
Paul Bakker5121ce52009-01-03 21:22:43 +00002506{
Janos Follath865b3eb2019-12-16 11:46:15 +00002507 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002508 const size_t hs_len = ssl->out_msglen - 4;
2509 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002510
Gilles Peskine449bd832023-01-11 14:50:10 +01002511 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002512
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002513 /*
2514 * Sanity checks
2515 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 if (ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
2517 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2518 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2519 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002520 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002521
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002522 /* Whenever we send anything different from a
2523 * HelloRequest we should be in a handshake - double check. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002524 if (!(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2525 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST) &&
2526 ssl->handshake == NULL) {
2527 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2528 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002529 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002530
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002531#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002532 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002533 ssl->handshake != NULL &&
Gilles Peskine449bd832023-01-11 14:50:10 +01002534 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
2535 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2536 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002537 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002538#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002539
Hanno Beckerb50a2532018-08-06 11:52:54 +01002540 /* Double-check that we did not exceed the bounds
2541 * of the outgoing record buffer.
2542 * This should never fail as the various message
2543 * writing functions must obey the bounds of the
2544 * outgoing record buffer, but better be safe.
2545 *
2546 * Note: We deliberately do not check for the MTU or MFL here.
2547 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 if (ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2549 MBEDTLS_SSL_DEBUG_MSG(1, ("Record too large: "
2550 "size %" MBEDTLS_PRINTF_SIZET
2551 ", maximum %" MBEDTLS_PRINTF_SIZET,
2552 ssl->out_msglen,
2553 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
2554 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerb50a2532018-08-06 11:52:54 +01002555 }
2556
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002557 /*
2558 * Fill handshake headers
2559 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 if (ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
2561 ssl->out_msg[1] = MBEDTLS_BYTE_2(hs_len);
2562 ssl->out_msg[2] = MBEDTLS_BYTE_1(hs_len);
2563 ssl->out_msg[3] = MBEDTLS_BYTE_0(hs_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00002564
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002565 /*
2566 * DTLS has additional fields in the Handshake layer,
2567 * between the length field and the actual payload:
2568 * uint16 message_seq;
2569 * uint24 fragment_offset;
2570 * uint24 fragment_length;
2571 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002572#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002574 /* Make room for the additional DTLS fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002575 if (MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8) {
2576 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS handshake message too large: "
2577 "size %" MBEDTLS_PRINTF_SIZET ", maximum %"
2578 MBEDTLS_PRINTF_SIZET,
2579 hs_len,
2580 (size_t) (MBEDTLS_SSL_OUT_CONTENT_LEN - 12)));
2581 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9648f8b2017-09-18 10:55:54 +01002582 }
2583
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 memmove(ssl->out_msg + 12, ssl->out_msg + 4, hs_len);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002585 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002586
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002587 /* Write message_seq and update it, except for HelloRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01002588 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST) {
2589 MBEDTLS_PUT_UINT16_BE(ssl->handshake->out_msg_seq, ssl->out_msg, 4);
2590 ++(ssl->handshake->out_msg_seq);
2591 } else {
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002592 ssl->out_msg[4] = 0;
2593 ssl->out_msg[5] = 0;
2594 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002595
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002596 /* Handshake hashes are computed without fragmentation,
2597 * so set frag_offset = 0 and frag_len = hs_len for now */
Gilles Peskine449bd832023-01-11 14:50:10 +01002598 memset(ssl->out_msg + 6, 0x00, 3);
2599 memcpy(ssl->out_msg + 9, ssl->out_msg + 1, 3);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002600 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002601#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002602
Hanno Becker0207e532018-08-28 10:28:28 +01002603 /* Update running hashes of handshake messages seen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002604 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002605 ret = ssl->handshake->update_checksum(ssl, ssl->out_msg,
2606 ssl->out_msglen);
2607 if (ret != 0) {
2608 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
2609 return ret;
2610 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002611 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002612 }
2613
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002614 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002615#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002616 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2617 !(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2618 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST)) {
2619 if ((ret = ssl_flight_append(ssl)) != 0) {
2620 MBEDTLS_SSL_DEBUG_RET(1, "ssl_flight_append", ret);
2621 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002622 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002623 } else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002624#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002625 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002626 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2627 MBEDTLS_SSL_DEBUG_RET(1, "ssl_write_record", ret);
2628 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002629 }
2630 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002631
Gilles Peskine449bd832023-01-11 14:50:10 +01002632 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002633
Gilles Peskine449bd832023-01-11 14:50:10 +01002634 return 0;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002635}
2636
Gilles Peskine449bd832023-01-11 14:50:10 +01002637int mbedtls_ssl_finish_handshake_msg(mbedtls_ssl_context *ssl,
2638 size_t buf_len, size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002639{
2640 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2641 size_t msg_with_header_len;
2642 ((void) buf_len);
2643
2644 /* Add reserved 4 bytes for handshake header */
2645 msg_with_header_len = msg_len + 4;
2646 ssl->out_msglen = msg_with_header_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002647 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_write_handshake_msg_ext(ssl, 0, 0));
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002648
2649cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002650 return ret;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002651}
2652
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002653/*
2654 * Record layer functions
2655 */
2656
2657/*
2658 * Write current record.
2659 *
2660 * Uses:
2661 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2662 * - ssl->out_msglen: length of the record content (excl headers)
2663 * - ssl->out_msg: record content
2664 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002665int mbedtls_ssl_write_record(mbedtls_ssl_context *ssl, int force_flush)
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002666{
2667 int ret, done = 0;
2668 size_t len = ssl->out_msglen;
Ronald Cron00d012f22022-03-08 15:57:12 +01002669 int flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002670
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write record"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002672
Gilles Peskine449bd832023-01-11 14:50:10 +01002673 if (!done) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002674 unsigned i;
2675 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002676#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2677 size_t out_buf_len = ssl->out_buf_len;
2678#else
2679 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2680#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002681 /* Skip writing the record content type to after the encryption,
2682 * as it may change when using the CID extension. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002683 mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
Ronald Cron6f135e12021-12-08 16:57:54 +01002684#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002685 /* TLS 1.3 still uses the TLS 1.2 version identifier
2686 * for backwards compatibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 if (tls_ver == MBEDTLS_SSL_VERSION_TLS1_3) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002688 tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002689 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002690#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002691 mbedtls_ssl_write_version(ssl->out_hdr + 1, ssl->conf->transport,
2692 tls_ver);
Hanno Becker6430faf2019-05-08 11:57:13 +01002693
Gilles Peskine449bd832023-01-11 14:50:10 +01002694 memcpy(ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
2695 MBEDTLS_PUT_UINT16_BE(len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002696
Gilles Peskine449bd832023-01-11 14:50:10 +01002697 if (ssl->transform_out != NULL) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002698 mbedtls_record rec;
2699
2700 rec.buf = ssl->out_iv;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002701 rec.buf_len = out_buf_len - (size_t) (ssl->out_iv - ssl->out_buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002702 rec.data_len = ssl->out_msglen;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002703 rec.data_offset = (size_t) (ssl->out_msg - rec.buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002704
Gilles Peskine449bd832023-01-11 14:50:10 +01002705 memcpy(&rec.ctr[0], ssl->out_ctr, sizeof(rec.ctr));
2706 mbedtls_ssl_write_version(rec.ver, ssl->conf->transport, tls_ver);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002707 rec.type = ssl->out_msgtype;
2708
Hanno Beckera0e20d02019-05-15 14:03:01 +01002709#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002710 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002711 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002712#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002713
Ben Taylor602b2962025-03-07 15:52:50 +00002714 if ((ret = mbedtls_ssl_encrypt_buf(ssl, ssl->transform_out, &rec)) != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002715 MBEDTLS_SSL_DEBUG_RET(1, "ssl_encrypt_buf", ret);
2716 return ret;
Paul Bakker05ef8352012-05-08 09:17:57 +00002717 }
2718
Gilles Peskine449bd832023-01-11 14:50:10 +01002719 if (rec.data_offset != 0) {
2720 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2721 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002722 }
2723
Hanno Becker6430faf2019-05-08 11:57:13 +01002724 /* Update the record content type and CID. */
2725 ssl->out_msgtype = rec.type;
Gilles Peskine449bd832023-01-11 14:50:10 +01002726#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
2727 memcpy(ssl->out_cid, rec.cid, rec.cid_len);
Hanno Beckera0e20d02019-05-15 14:03:01 +01002728#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002729 ssl->out_msglen = len = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002730 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002731 }
2732
Gilles Peskine449bd832023-01-11 14:50:10 +01002733 protected_record_size = len + mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker2b1e3542018-08-06 11:19:13 +01002734
2735#if defined(MBEDTLS_SSL_PROTO_DTLS)
2736 /* In case of DTLS, double-check that we don't exceed
2737 * the remaining space in the datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002738 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2739 ret = ssl_get_remaining_space_in_datagram(ssl);
2740 if (ret < 0) {
2741 return ret;
2742 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002743
Gilles Peskine449bd832023-01-11 14:50:10 +01002744 if (protected_record_size > (size_t) ret) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002745 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002746 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker2b1e3542018-08-06 11:19:13 +01002747 }
2748 }
2749#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002750
Hanno Becker6430faf2019-05-08 11:57:13 +01002751 /* Now write the potentially updated record content type. */
2752 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2753
Gilles Peskine449bd832023-01-11 14:50:10 +01002754 MBEDTLS_SSL_DEBUG_MSG(3, ("output record: msgtype = %u, "
2755 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
2756 ssl->out_hdr[0], ssl->out_hdr[1],
2757 ssl->out_hdr[2], len));
Paul Bakker05ef8352012-05-08 09:17:57 +00002758
Gilles Peskine449bd832023-01-11 14:50:10 +01002759 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
2760 ssl->out_hdr, protected_record_size);
Hanno Becker2b1e3542018-08-06 11:19:13 +01002761
2762 ssl->out_left += protected_record_size;
2763 ssl->out_hdr += protected_record_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01002764 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Hanno Becker2b1e3542018-08-06 11:19:13 +01002765
Gilles Peskine449bd832023-01-11 14:50:10 +01002766 for (i = 8; i > mbedtls_ssl_ep_len(ssl); i--) {
2767 if (++ssl->cur_out_ctr[i - 1] != 0) {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002768 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01002769 }
2770 }
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002771
Gabor Mezei96ae9262022-06-28 11:45:18 +02002772 /* The loop goes to its end if the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01002773 if (i == mbedtls_ssl_ep_len(ssl)) {
2774 MBEDTLS_SSL_DEBUG_MSG(1, ("outgoing message counter would wrap"));
2775 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker04484622018-08-06 09:49:38 +01002776 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002777 }
2778
Hanno Becker67bc7c32018-08-06 11:33:50 +01002779#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2781 flush == SSL_DONT_FORCE_FLUSH) {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002782 size_t remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 ret = ssl_get_remaining_payload_in_datagram(ssl);
2784 if (ret < 0) {
2785 MBEDTLS_SSL_DEBUG_RET(1, "ssl_get_remaining_payload_in_datagram",
2786 ret);
2787 return ret;
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002788 }
2789
2790 remaining = (size_t) ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 if (remaining == 0) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002792 flush = SSL_FORCE_FLUSH;
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 } else {
2794 MBEDTLS_SSL_DEBUG_MSG(2,
2795 ("Still %u bytes available in current datagram",
2796 (unsigned) remaining));
Hanno Becker67bc7c32018-08-06 11:33:50 +01002797 }
2798 }
2799#endif /* MBEDTLS_SSL_PROTO_DTLS */
2800
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 if ((flush == SSL_FORCE_FLUSH) &&
2802 (ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2803 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
2804 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00002805 }
2806
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write record"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002808
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002810}
2811
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002812#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002813
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002814MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002815static int ssl_hs_is_proper_fragment(mbedtls_ssl_context *ssl)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002816{
Gilles Peskine449bd832023-01-11 14:50:10 +01002817 if (ssl->in_msglen < ssl->in_hslen ||
2818 memcmp(ssl->in_msg + 6, "\0\0\0", 3) != 0 ||
2819 memcmp(ssl->in_msg + 9, ssl->in_msg + 1, 3) != 0) {
2820 return 1;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002821 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002822 return 0;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002823}
Hanno Becker44650b72018-08-16 12:51:11 +01002824
Gilles Peskine449bd832023-01-11 14:50:10 +01002825static uint32_t ssl_get_hs_frag_len(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01002826{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002827 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 9);
Hanno Becker44650b72018-08-16 12:51:11 +01002828}
2829
Gilles Peskine449bd832023-01-11 14:50:10 +01002830static uint32_t ssl_get_hs_frag_off(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01002831{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002832 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 6);
Hanno Becker44650b72018-08-16 12:51:11 +01002833}
2834
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002835MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002836static int ssl_check_hs_header(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01002837{
2838 uint32_t msg_len, frag_off, frag_len;
2839
Gilles Peskine449bd832023-01-11 14:50:10 +01002840 msg_len = ssl_get_hs_total_len(ssl);
2841 frag_off = ssl_get_hs_frag_off(ssl);
2842 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker44650b72018-08-16 12:51:11 +01002843
Gilles Peskine449bd832023-01-11 14:50:10 +01002844 if (frag_off > msg_len) {
2845 return -1;
2846 }
Hanno Becker44650b72018-08-16 12:51:11 +01002847
Gilles Peskine449bd832023-01-11 14:50:10 +01002848 if (frag_len > msg_len - frag_off) {
2849 return -1;
2850 }
Hanno Becker44650b72018-08-16 12:51:11 +01002851
Gilles Peskine449bd832023-01-11 14:50:10 +01002852 if (frag_len + 12 > ssl->in_msglen) {
2853 return -1;
2854 }
Hanno Becker44650b72018-08-16 12:51:11 +01002855
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 return 0;
Hanno Becker44650b72018-08-16 12:51:11 +01002857}
2858
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002859/*
2860 * Mark bits in bitmask (used for DTLS HS reassembly)
2861 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002862static void ssl_bitmask_set(unsigned char *mask, size_t offset, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002863{
2864 unsigned int start_bits, end_bits;
2865
Gilles Peskine449bd832023-01-11 14:50:10 +01002866 start_bits = 8 - (offset % 8);
2867 if (start_bits != 8) {
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002868 size_t first_byte_idx = offset / 8;
2869
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002870 /* Special case */
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 if (len <= start_bits) {
2872 for (; len != 0; len--) {
2873 mask[first_byte_idx] |= 1 << (start_bits - len);
2874 }
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002875
2876 /* Avoid potential issues with offset or len becoming invalid */
2877 return;
2878 }
2879
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002880 offset += start_bits; /* Now offset % 8 == 0 */
2881 len -= start_bits;
2882
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 for (; start_bits != 0; start_bits--) {
2884 mask[first_byte_idx] |= 1 << (start_bits - 1);
2885 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002886 }
2887
2888 end_bits = len % 8;
Gilles Peskine449bd832023-01-11 14:50:10 +01002889 if (end_bits != 0) {
2890 size_t last_byte_idx = (offset + len) / 8;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002891
2892 len -= end_bits; /* Now len % 8 == 0 */
2893
Gilles Peskine449bd832023-01-11 14:50:10 +01002894 for (; end_bits != 0; end_bits--) {
2895 mask[last_byte_idx] |= 1 << (8 - end_bits);
2896 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002897 }
2898
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 memset(mask + offset / 8, 0xFF, len / 8);
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002900}
2901
2902/*
2903 * Check that bitmask is full
2904 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002905MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002906static int ssl_bitmask_check(unsigned char *mask, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002907{
2908 size_t i;
2909
Gilles Peskine449bd832023-01-11 14:50:10 +01002910 for (i = 0; i < len / 8; i++) {
2911 if (mask[i] != 0xFF) {
2912 return -1;
2913 }
2914 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002915
Gilles Peskine449bd832023-01-11 14:50:10 +01002916 for (i = 0; i < len % 8; i++) {
2917 if ((mask[len / 8] & (1 << (7 - i))) == 0) {
2918 return -1;
2919 }
2920 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002921
Gilles Peskine449bd832023-01-11 14:50:10 +01002922 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002923}
2924
Hanno Becker56e205e2018-08-16 09:06:12 +01002925/* msg_len does not include the handshake header */
Gilles Peskine449bd832023-01-11 14:50:10 +01002926static size_t ssl_get_reassembly_buffer_size(size_t msg_len,
2927 unsigned add_bitmap)
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002928{
Hanno Becker56e205e2018-08-16 09:06:12 +01002929 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002930
Hanno Becker56e205e2018-08-16 09:06:12 +01002931 alloc_len = 12; /* Handshake header */
2932 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002933
Gilles Peskine449bd832023-01-11 14:50:10 +01002934 if (add_bitmap) {
2935 alloc_len += msg_len / 8 + (msg_len % 8 != 0); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002936
Gilles Peskine449bd832023-01-11 14:50:10 +01002937 }
2938 return alloc_len;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002939}
Hanno Becker56e205e2018-08-16 09:06:12 +01002940
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002941#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002942
Gilles Peskine449bd832023-01-11 14:50:10 +01002943static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl)
Hanno Becker12555c62018-08-16 12:47:53 +01002944{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002945 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 1);
Hanno Becker12555c62018-08-16 12:47:53 +01002946}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002947
Gilles Peskine449bd832023-01-11 14:50:10 +01002948int mbedtls_ssl_prepare_handshake_record(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002949{
Gilles Peskine7a176962025-02-28 21:59:12 +01002950 if (ssl->in_hsfraglen == 0) {
2951 /* The handshake message must at least include the header.
2952 * We may not have the full message yet in case of fragmentation.
2953 * To simplify the code, we insist on having the header (and in
2954 * particular the handshake message length) in the first
2955 * fragment. */
2956 if (ssl->in_msglen < mbedtls_ssl_hs_hdr_len(ssl)) {
2957 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake message too short: %" MBEDTLS_PRINTF_SIZET,
2958 ssl->in_msglen));
2959 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2960 }
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002961
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00002962 ssl->in_hslen = mbedtls_ssl_hs_hdr_len(ssl) + ssl_get_hs_total_len(ssl);
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00002963 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002964
Gilles Peskine449bd832023-01-11 14:50:10 +01002965 MBEDTLS_SSL_DEBUG_MSG(3, ("handshake message: msglen ="
2966 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %"
2967 MBEDTLS_PRINTF_SIZET,
2968 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen));
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002969
Gilles Peskine235eae92025-02-28 22:02:52 +01002970 if (ssl->transform_in != NULL) {
2971 MBEDTLS_SSL_DEBUG_MSG(4, ("decrypted handshake message:"
2972 " iv-buf=%d hdr-buf=%d hdr-buf=%d",
2973 (int) (ssl->in_iv - ssl->in_buf),
2974 (int) (ssl->in_hdr - ssl->in_buf),
2975 (int) (ssl->in_msg - ssl->in_buf)));
2976 }
2977
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002978#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00002980 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002981 unsigned int recv_msg_seq = MBEDTLS_GET_UINT16_BE(ssl->in_msg, 4);
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002982
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 if (ssl_check_hs_header(ssl) != 0) {
2984 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid handshake header"));
2985 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker44650b72018-08-16 12:51:11 +01002986 }
2987
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 if (ssl->handshake != NULL &&
2989 ((mbedtls_ssl_is_handshake_over(ssl) == 0 &&
2990 recv_msg_seq != ssl->handshake->in_msg_seq) ||
2991 (mbedtls_ssl_is_handshake_over(ssl) == 1 &&
2992 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO))) {
2993 if (recv_msg_seq > ssl->handshake->in_msg_seq) {
2994 MBEDTLS_SSL_DEBUG_MSG(2,
2995 (
2996 "received future handshake message of sequence number %u (next %u)",
2997 recv_msg_seq,
2998 ssl->handshake->in_msg_seq));
2999 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Becker9e1ec222018-08-15 15:54:43 +01003000 }
3001
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003002 /* Retransmit only on last message from previous flight, to avoid
3003 * too many retransmissions.
3004 * Besides, No sane server ever retransmits HelloVerifyRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 if (recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
3006 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST) {
3007 MBEDTLS_SSL_DEBUG_MSG(2, ("received message from last flight, "
3008 "message_seq = %u, start_of_flight = %u",
3009 recv_msg_seq,
3010 ssl->handshake->in_flight_start_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003011
Gilles Peskine449bd832023-01-11 14:50:10 +01003012 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
3013 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
3014 return ret;
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003015 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003016 } else {
3017 MBEDTLS_SSL_DEBUG_MSG(2, ("dropping out-of-sequence message: "
3018 "message_seq = %u, expected = %u",
3019 recv_msg_seq,
3020 ssl->handshake->in_msg_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003021 }
3022
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003024 }
3025 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003026
Hanno Becker6d97ef52018-08-16 13:09:04 +01003027 /* Message reassembly is handled alongside buffering of future
3028 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003029 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003030 * handshake logic layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 if (ssl_hs_is_proper_fragment(ssl) == 1) {
3032 MBEDTLS_SSL_DEBUG_MSG(2, ("found fragmented DTLS handshake message"));
3033 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003034 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003035 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003036#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskinee85ece62025-02-28 22:24:56 +01003037 {
3038 unsigned char *const reassembled_record_start =
3039 ssl->in_buf + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3040 unsigned char *const payload_start =
3041 reassembled_record_start + mbedtls_ssl_in_hdr_len(ssl);
3042 unsigned char *payload_end = payload_start + ssl->in_hsfraglen;
Gilles Peskine15c072f2025-03-06 19:03:00 +01003043 /* How many more bytes we want to have a complete handshake message. */
3044 const size_t hs_remain = ssl->in_hslen - ssl->in_hsfraglen;
3045 /* How many bytes of the current record are part of the first
3046 * handshake message. There may be more handshake messages (possibly
3047 * incomplete) in the same record; if so, we leave them after the
3048 * current record, and ssl_consume_current_message() will take
3049 * care of consuming the next handshake message. */
3050 const size_t hs_this_fragment_len =
3051 ssl->in_msglen > hs_remain ? hs_remain : ssl->in_msglen;
Gilles Peskinedab1cb52025-03-06 21:30:23 +01003052 (void) hs_this_fragment_len;
Gilles Peskinee85ece62025-02-28 22:24:56 +01003053
Gilles Peskineafb254c2025-03-06 19:23:22 +01003054 MBEDTLS_SSL_DEBUG_MSG(3,
3055 ("%s handshake fragment: %" MBEDTLS_PRINTF_SIZET
3056 ", %" MBEDTLS_PRINTF_SIZET
3057 "..%" MBEDTLS_PRINTF_SIZET
3058 " of %" MBEDTLS_PRINTF_SIZET,
3059 (ssl->in_hsfraglen != 0 ?
3060 "subsequent" :
3061 hs_this_fragment_len == ssl->in_hslen ?
3062 "sole" :
3063 "initial"),
3064 ssl->in_msglen,
3065 ssl->in_hsfraglen,
3066 ssl->in_hsfraglen + hs_this_fragment_len,
3067 ssl->in_hslen));
Gilles Peskinee85ece62025-02-28 22:24:56 +01003068
3069 /* Move the received handshake fragment to have the whole message
3070 * (at least the part received so far) in a single segment at a
3071 * known offset in the input buffer.
3072 * - When receiving a non-initial handshake fragment, append it to
3073 * the initial segment.
3074 * - Even the initial handshake fragment is moved, if it was
3075 * encrypted with an explicit IV: decryption leaves the payload
3076 * after the explicit IV, but here we move it to start where the
3077 * IV was.
3078 */
3079#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3080 size_t const in_buf_len = ssl->in_buf_len;
3081#else
3082 size_t const in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3083#endif
Gilles Peskine0851ec92025-03-06 15:15:20 +01003084 if (payload_end + ssl->in_msglen > ssl->in_buf + in_buf_len) {
Gilles Peskinee85ece62025-02-28 22:24:56 +01003085 MBEDTLS_SSL_DEBUG_MSG(1,
3086 ("Shouldn't happen: no room to move handshake fragment %"
3087 MBEDTLS_PRINTF_SIZET " from %p to %p (buf=%p len=%"
3088 MBEDTLS_PRINTF_SIZET ")",
3089 ssl->in_msglen,
Gilles Peskine90a95932025-02-25 23:57:20 +01003090 (void *) ssl->in_msg, (void *) payload_end,
3091 (void *) ssl->in_buf, in_buf_len));
Gilles Peskinee85ece62025-02-28 22:24:56 +01003092 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3093 }
3094 memmove(payload_end, ssl->in_msg, ssl->in_msglen);
3095
3096 ssl->in_hsfraglen += ssl->in_msglen;
3097 payload_end += ssl->in_msglen;
3098
3099 if (ssl->in_hsfraglen < ssl->in_hslen) {
3100 MBEDTLS_SSL_DEBUG_MSG(3, ("Prepare: waiting for more handshake fragments %"
3101 MBEDTLS_PRINTF_SIZET "/%"
3102 MBEDTLS_PRINTF_SIZET,
3103 ssl->in_hsfraglen, ssl->in_hslen));
3104 ssl->in_hdr = payload_end;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003105 ssl->in_msglen = 0;
3106 mbedtls_ssl_update_in_pointers(ssl);
3107 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Gilles Peskinee85ece62025-02-28 22:24:56 +01003108 } else {
3109 ssl->in_msglen = ssl->in_hsfraglen;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003110 ssl->in_hsfraglen = 0;
Gilles Peskinee85ece62025-02-28 22:24:56 +01003111 ssl->in_hdr = reassembled_record_start;
3112 mbedtls_ssl_update_in_pointers(ssl);
3113
3114 /* Update the record length in the fully reassembled record */
3115 if (ssl->in_msglen > 0xffff) {
3116 MBEDTLS_SSL_DEBUG_MSG(1,
Gilles Peskinee34ec862025-03-07 10:43:39 +01003117 ("Shouldn't happen: in_msglen=%"
Gilles Peskinee85ece62025-02-28 22:24:56 +01003118 MBEDTLS_PRINTF_SIZET " > 0xffff",
3119 ssl->in_msglen));
3120 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3121 }
3122 MBEDTLS_PUT_UINT16_BE(ssl->in_msglen, ssl->in_len, 0);
3123
Gilles Peskine15c072f2025-03-06 19:03:00 +01003124 size_t record_len = mbedtls_ssl_in_hdr_len(ssl) + ssl->in_msglen;
Gilles Peskinedab1cb52025-03-06 21:30:23 +01003125 (void) record_len;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003126 MBEDTLS_SSL_DEBUG_BUF(4, "reassembled record",
Gilles Peskine15c072f2025-03-06 19:03:00 +01003127 ssl->in_hdr, record_len);
3128 if (ssl->in_hslen < ssl->in_msglen) {
3129 MBEDTLS_SSL_DEBUG_MSG(3,
3130 ("More handshake messages in the record: "
Gilles Peskineb8f1e4b2025-03-06 21:32:08 +01003131 "%" MBEDTLS_PRINTF_SIZET " + %" MBEDTLS_PRINTF_SIZET,
Gilles Peskine15c072f2025-03-06 19:03:00 +01003132 ssl->in_hslen,
3133 ssl->in_msglen - ssl->in_hslen));
3134 }
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003135 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003136 }
3137
Gilles Peskine449bd832023-01-11 14:50:10 +01003138 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01003139}
3140
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003141int mbedtls_ssl_update_handshake_status(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01003142{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003143 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker0271f962018-08-16 13:23:47 +01003144 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003145
Gilles Peskine449bd832023-01-11 14:50:10 +01003146 if (mbedtls_ssl_is_handshake_over(ssl) == 0 && hs != NULL) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003147 ret = ssl->handshake->update_checksum(ssl, ssl->in_msg, ssl->in_hslen);
3148 if (ret != 0) {
3149 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
3150 return ret;
3151 }
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003152 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003153
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003154 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003155#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003156 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3157 ssl->handshake != NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01003158 unsigned offset;
3159 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003160
Hanno Becker0271f962018-08-16 13:23:47 +01003161 /* Increment handshake sequence number */
3162 hs->in_msg_seq++;
3163
3164 /*
3165 * Clear up handshake buffering and reassembly structure.
3166 */
3167
3168 /* Free first entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003169 ssl_buffering_free_slot(ssl, 0);
Hanno Becker0271f962018-08-16 13:23:47 +01003170
3171 /* Shift all other entries */
Gilles Peskine449bd832023-01-11 14:50:10 +01003172 for (offset = 0, hs_buf = &hs->buffering.hs[0];
Hanno Beckere605b192018-08-21 15:59:07 +01003173 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Gilles Peskine449bd832023-01-11 14:50:10 +01003174 offset++, hs_buf++) {
Hanno Becker0271f962018-08-16 13:23:47 +01003175 *hs_buf = *(hs_buf + 1);
3176 }
3177
3178 /* Create a fresh last entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003179 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003180 }
3181#endif
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003182 return 0;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003183}
3184
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003185/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003186 * DTLS anti-replay: RFC 6347 4.1.2.6
3187 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003188 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3189 * Bit n is set iff record number in_window_top - n has been seen.
3190 *
3191 * Usually, in_window_top is the last record number seen and the lsb of
3192 * in_window is set. The only exception is the initial state (record number 0
3193 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003194 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003195#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003196void mbedtls_ssl_dtls_replay_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003197{
3198 ssl->in_window_top = 0;
3199 ssl->in_window = 0;
3200}
3201
Gilles Peskine449bd832023-01-11 14:50:10 +01003202static inline uint64_t ssl_load_six_bytes(unsigned char *buf)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003203{
Gilles Peskine449bd832023-01-11 14:50:10 +01003204 return ((uint64_t) buf[0] << 40) |
3205 ((uint64_t) buf[1] << 32) |
3206 ((uint64_t) buf[2] << 24) |
3207 ((uint64_t) buf[3] << 16) |
3208 ((uint64_t) buf[4] << 8) |
3209 ((uint64_t) buf[5]);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003210}
3211
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003212MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003213static int mbedtls_ssl_dtls_record_replay_check(mbedtls_ssl_context *ssl, uint8_t *record_in_ctr)
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003214{
Janos Follath865b3eb2019-12-16 11:46:15 +00003215 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003216 unsigned char *original_in_ctr;
3217
3218 // save original in_ctr
3219 original_in_ctr = ssl->in_ctr;
3220
3221 // use counter from record
3222 ssl->in_ctr = record_in_ctr;
3223
Gilles Peskine449bd832023-01-11 14:50:10 +01003224 ret = mbedtls_ssl_dtls_replay_check((mbedtls_ssl_context const *) ssl);
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003225
3226 // restore the counter
3227 ssl->in_ctr = original_in_ctr;
3228
3229 return ret;
3230}
3231
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003232/*
3233 * Return 0 if sequence number is acceptable, -1 otherwise
3234 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003235int mbedtls_ssl_dtls_replay_check(mbedtls_ssl_context const *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003236{
Gilles Peskine449bd832023-01-11 14:50:10 +01003237 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003238 uint64_t bit;
3239
Gilles Peskine449bd832023-01-11 14:50:10 +01003240 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
3241 return 0;
3242 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003243
Gilles Peskine449bd832023-01-11 14:50:10 +01003244 if (rec_seqnum > ssl->in_window_top) {
3245 return 0;
3246 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003247
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003248 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003249
Gilles Peskine449bd832023-01-11 14:50:10 +01003250 if (bit >= 64) {
3251 return -1;
3252 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003253
Gilles Peskine449bd832023-01-11 14:50:10 +01003254 if ((ssl->in_window & ((uint64_t) 1 << bit)) != 0) {
3255 return -1;
3256 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003257
Gilles Peskine449bd832023-01-11 14:50:10 +01003258 return 0;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003259}
3260
3261/*
3262 * Update replay window on new validated record
3263 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003264void mbedtls_ssl_dtls_replay_update(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003265{
Gilles Peskine449bd832023-01-11 14:50:10 +01003266 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003267
Gilles Peskine449bd832023-01-11 14:50:10 +01003268 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003269 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01003270 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003271
Gilles Peskine449bd832023-01-11 14:50:10 +01003272 if (rec_seqnum > ssl->in_window_top) {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003273 /* Update window_top and the contents of the window */
3274 uint64_t shift = rec_seqnum - ssl->in_window_top;
3275
Gilles Peskine449bd832023-01-11 14:50:10 +01003276 if (shift >= 64) {
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003277 ssl->in_window = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003278 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003279 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003280 ssl->in_window |= 1;
3281 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003282
3283 ssl->in_window_top = rec_seqnum;
Gilles Peskine449bd832023-01-11 14:50:10 +01003284 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003285 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003286 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003287
Gilles Peskine449bd832023-01-11 14:50:10 +01003288 if (bit < 64) { /* Always true, but be extra sure */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003289 ssl->in_window |= (uint64_t) 1 << bit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003290 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003291 }
3292}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003293#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003294
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003295#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003296/*
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003297 * Check if a datagram looks like a ClientHello with a valid cookie,
3298 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003299 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003300 *
3301 * - if cookie is valid, return 0
3302 * - if ClientHello looks superficially valid but cookie is not,
3303 * fill obuf and set olen, then
3304 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3305 * - otherwise return a specific error code
3306 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003307MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003308MBEDTLS_STATIC_TESTABLE
3309int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003310 mbedtls_ssl_context *ssl,
3311 const unsigned char *cli_id, size_t cli_id_len,
3312 const unsigned char *in, size_t in_len,
3313 unsigned char *obuf, size_t buf_len, size_t *olen)
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003314{
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003315 size_t sid_len, cookie_len, epoch, fragment_offset;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003316 unsigned char *p;
3317
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003318 /*
3319 * Structure of ClientHello with record and handshake headers,
3320 * and expected values. We don't need to check a lot, more checks will be
3321 * done when actually parsing the ClientHello - skipping those checks
3322 * avoids code duplication and does not make cookie forging any easier.
3323 *
3324 * 0-0 ContentType type; copied, must be handshake
3325 * 1-2 ProtocolVersion version; copied
3326 * 3-4 uint16 epoch; copied, must be 0
3327 * 5-10 uint48 sequence_number; copied
3328 * 11-12 uint16 length; (ignored)
3329 *
3330 * 13-13 HandshakeType msg_type; (ignored)
3331 * 14-16 uint24 length; (ignored)
3332 * 17-18 uint16 message_seq; copied
3333 * 19-21 uint24 fragment_offset; copied, must be 0
3334 * 22-24 uint24 fragment_length; (ignored)
3335 *
3336 * 25-26 ProtocolVersion client_version; (ignored)
3337 * 27-58 Random random; (ignored)
3338 * 59-xx SessionID session_id; 1 byte len + sid_len content
3339 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3340 * ...
3341 *
3342 * Minimum length is 61 bytes.
3343 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003344 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: in_len=%u",
3345 (unsigned) in_len));
3346 MBEDTLS_SSL_DEBUG_BUF(4, "cli_id", cli_id, cli_id_len);
3347 if (in_len < 61) {
3348 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: record too short"));
3349 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003350 }
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003351
Gilles Peskine449bd832023-01-11 14:50:10 +01003352 epoch = MBEDTLS_GET_UINT16_BE(in, 3);
3353 fragment_offset = MBEDTLS_GET_UINT24_BE(in, 19);
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003354
Gilles Peskine449bd832023-01-11 14:50:10 +01003355 if (in[0] != MBEDTLS_SSL_MSG_HANDSHAKE || epoch != 0 ||
3356 fragment_offset != 0) {
3357 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: not a good ClientHello"));
3358 MBEDTLS_SSL_DEBUG_MSG(4, (" type=%u epoch=%u fragment_offset=%u",
3359 in[0], (unsigned) epoch,
3360 (unsigned) fragment_offset));
3361 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003362 }
3363
3364 sid_len = in[59];
Gilles Peskine449bd832023-01-11 14:50:10 +01003365 if (59 + 1 + sid_len + 1 > in_len) {
3366 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: sid_len=%u > %u",
3367 (unsigned) sid_len,
3368 (unsigned) in_len - 61));
3369 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003370 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003371 MBEDTLS_SSL_DEBUG_BUF(4, "sid received from network",
3372 in + 60, sid_len);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003373
3374 cookie_len = in[60 + sid_len];
Gilles Peskine449bd832023-01-11 14:50:10 +01003375 if (59 + 1 + sid_len + 1 + cookie_len > in_len) {
3376 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: cookie_len=%u > %u",
3377 (unsigned) cookie_len,
3378 (unsigned) (in_len - sid_len - 61)));
3379 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003380 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003381
Gilles Peskine449bd832023-01-11 14:50:10 +01003382 MBEDTLS_SSL_DEBUG_BUF(4, "cookie received from network",
3383 in + sid_len + 61, cookie_len);
3384 if (ssl->conf->f_cookie_check(ssl->conf->p_cookie,
3385 in + sid_len + 61, cookie_len,
3386 cli_id, cli_id_len) == 0) {
3387 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: valid"));
3388 return 0;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003389 }
3390
3391 /*
3392 * If we get here, we've got an invalid cookie, let's prepare HVR.
3393 *
3394 * 0-0 ContentType type; copied
3395 * 1-2 ProtocolVersion version; copied
3396 * 3-4 uint16 epoch; copied
3397 * 5-10 uint48 sequence_number; copied
3398 * 11-12 uint16 length; olen - 13
3399 *
3400 * 13-13 HandshakeType msg_type; hello_verify_request
3401 * 14-16 uint24 length; olen - 25
3402 * 17-18 uint16 message_seq; copied
3403 * 19-21 uint24 fragment_offset; copied
3404 * 22-24 uint24 fragment_length; olen - 25
3405 *
3406 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3407 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3408 *
3409 * Minimum length is 28.
3410 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003411 if (buf_len < 28) {
3412 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3413 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003414
3415 /* Copy most fields and adapt others */
Gilles Peskine449bd832023-01-11 14:50:10 +01003416 memcpy(obuf, in, 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003417 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3418 obuf[25] = 0xfe;
3419 obuf[26] = 0xff;
3420
3421 /* Generate and write actual cookie */
3422 p = obuf + 28;
Gilles Peskine449bd832023-01-11 14:50:10 +01003423 if (ssl->conf->f_cookie_write(ssl->conf->p_cookie,
3424 &p, obuf + buf_len,
3425 cli_id, cli_id_len) != 0) {
3426 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003427 }
3428
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00003429 *olen = (size_t) (p - obuf);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003430
3431 /* Go back and fill length fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01003432 obuf[27] = (unsigned char) (*olen - 28);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003433
Gilles Peskine449bd832023-01-11 14:50:10 +01003434 obuf[14] = obuf[22] = MBEDTLS_BYTE_2(*olen - 25);
3435 obuf[15] = obuf[23] = MBEDTLS_BYTE_1(*olen - 25);
3436 obuf[16] = obuf[24] = MBEDTLS_BYTE_0(*olen - 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003437
Gilles Peskine449bd832023-01-11 14:50:10 +01003438 MBEDTLS_PUT_UINT16_BE(*olen - 13, obuf, 11);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003439
Gilles Peskine449bd832023-01-11 14:50:10 +01003440 return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003441}
3442
3443/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003444 * Handle possible client reconnect with the same UDP quadruplet
3445 * (RFC 6347 Section 4.2.8).
3446 *
3447 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3448 * that looks like a ClientHello.
3449 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003450 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003451 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003452 * - if the input looks like a ClientHello with a valid cookie,
3453 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003454 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003455 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003456 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003457 * This function is called (through ssl_check_client_reconnect()) when an
3458 * unexpected record is found in ssl_get_next_record(), which will discard the
3459 * record if we return 0, and bubble up the return value otherwise (this
3460 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3461 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003462 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003463MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003464static int ssl_handle_possible_reconnect(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003465{
Janos Follath865b3eb2019-12-16 11:46:15 +00003466 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Matthias Schulz9916b062023-11-09 14:25:01 +01003467 size_t len = 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003468
Gilles Peskine449bd832023-01-11 14:50:10 +01003469 if (ssl->conf->f_cookie_write == NULL ||
3470 ssl->conf->f_cookie_check == NULL) {
Hanno Becker2fddd372019-07-10 14:37:41 +01003471 /* If we can't use cookies to verify reachability of the peer,
3472 * drop the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003473 MBEDTLS_SSL_DEBUG_MSG(1, ("no cookie callbacks, "
3474 "can't check reconnect validity"));
3475 return 0;
Hanno Becker2fddd372019-07-10 14:37:41 +01003476 }
3477
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003478 ret = mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003479 ssl,
3480 ssl->cli_id, ssl->cli_id_len,
3481 ssl->in_buf, ssl->in_left,
3482 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len);
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003483
Gilles Peskine449bd832023-01-11 14:50:10 +01003484 MBEDTLS_SSL_DEBUG_RET(2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003485
Gilles Peskine449bd832023-01-11 14:50:10 +01003486 if (ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED) {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003487 int send_ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003488 MBEDTLS_SSL_DEBUG_MSG(1, ("sending HelloVerifyRequest"));
3489 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3490 ssl->out_buf, len);
Brian J Murray1903fb32016-11-06 04:45:15 -08003491 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003492 * If the error is permanent we'll catch it later,
3493 * if it's not, then hopefully it'll work next time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003494 send_ret = ssl->f_send(ssl->p_bio, ssl->out_buf, len);
3495 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", send_ret);
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003496 (void) send_ret;
3497
Gilles Peskine449bd832023-01-11 14:50:10 +01003498 return 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003499 }
3500
Gilles Peskine449bd832023-01-11 14:50:10 +01003501 if (ret == 0) {
3502 MBEDTLS_SSL_DEBUG_MSG(1, ("cookie is valid, resetting context"));
3503 if ((ret = mbedtls_ssl_session_reset_int(ssl, 1)) != 0) {
3504 MBEDTLS_SSL_DEBUG_RET(1, "reset", ret);
3505 return ret;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003506 }
3507
Gilles Peskine449bd832023-01-11 14:50:10 +01003508 return MBEDTLS_ERR_SSL_CLIENT_RECONNECT;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003509 }
3510
Gilles Peskine449bd832023-01-11 14:50:10 +01003511 return ret;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003512}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003513#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003514
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003515MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003516static int ssl_check_record_type(uint8_t record_type)
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003517{
Gilles Peskine449bd832023-01-11 14:50:10 +01003518 if (record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003519 record_type != MBEDTLS_SSL_MSG_ALERT &&
3520 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003521 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
3522 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003523 }
3524
Gilles Peskine449bd832023-01-11 14:50:10 +01003525 return 0;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003526}
3527
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003528/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003529 * ContentType type;
3530 * ProtocolVersion version;
3531 * uint16 epoch; // DTLS only
3532 * uint48 sequence_number; // DTLS only
3533 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003534 *
3535 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003536 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003537 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3538 *
3539 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003540 * 1. proceed with the record if this function returns 0
3541 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3542 * 3. return CLIENT_RECONNECT if this function return that value
3543 * 4. drop the whole datagram if this function returns anything else.
3544 * Point 2 is needed when the peer is resending, and we have already received
3545 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003546 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003547MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003548static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
3549 unsigned char *buf,
3550 size_t len,
3551 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00003552{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003553 mbedtls_ssl_protocol_version tls_version;
Paul Bakker5121ce52009-01-03 21:22:43 +00003554
Hanno Beckere5e7e782019-07-11 12:29:35 +01003555 size_t const rec_hdr_type_offset = 0;
3556 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003557
Hanno Beckere5e7e782019-07-11 12:29:35 +01003558 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3559 rec_hdr_type_len;
3560 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003561
Hanno Beckere5e7e782019-07-11 12:29:35 +01003562 size_t const rec_hdr_ctr_len = 8;
3563#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003564 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003565 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3566 rec_hdr_version_len;
3567
Hanno Beckera0e20d02019-05-15 14:03:01 +01003568#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003569 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3570 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003571 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003572#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3573#endif /* MBEDTLS_SSL_PROTO_DTLS */
3574
3575 size_t rec_hdr_len_offset; /* To be determined */
3576 size_t const rec_hdr_len_len = 2;
3577
3578 /*
3579 * Check minimum lengths for record header.
3580 */
3581
3582#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003583 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003584 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003585 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003586#endif /* MBEDTLS_SSL_PROTO_DTLS */
3587 {
3588 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3589 }
3590
Gilles Peskine449bd832023-01-11 14:50:10 +01003591 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3592 MBEDTLS_SSL_DEBUG_MSG(1,
3593 (
3594 "datagram of length %u too small to hold DTLS record header of length %u",
3595 (unsigned) len,
3596 (unsigned) (rec_hdr_len_len + rec_hdr_len_len)));
3597 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003598 }
3599
3600 /*
3601 * Parse and validate record content type
3602 */
3603
Gilles Peskine449bd832023-01-11 14:50:10 +01003604 rec->type = buf[rec_hdr_type_offset];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003605
3606 /* Check record content type */
3607#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3608 rec->cid_len = 0;
3609
Gilles Peskine449bd832023-01-11 14:50:10 +01003610 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003611 ssl->conf->cid_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003612 rec->type == MBEDTLS_SSL_MSG_CID) {
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003613 /* Shift pointers to account for record header including CID
3614 * struct {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02003615 * ContentType outer_type = tls12_cid;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003616 * ProtocolVersion version;
3617 * uint16 epoch;
3618 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003619 * opaque cid[cid_length]; // Additional field compared to
3620 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003621 * uint16 length;
3622 * opaque enc_content[DTLSCiphertext.length];
3623 * } DTLSCiphertext;
3624 */
3625
3626 /* So far, we only support static CID lengths
3627 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003628 rec_hdr_cid_len = ssl->conf->cid_len;
3629 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003630
Gilles Peskine449bd832023-01-11 14:50:10 +01003631 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3632 MBEDTLS_SSL_DEBUG_MSG(1,
3633 (
3634 "datagram of length %u too small to hold DTLS record header including CID, length %u",
3635 (unsigned) len,
3636 (unsigned) (rec_hdr_len_offset + rec_hdr_len_len)));
3637 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere538d822019-07-10 14:50:10 +01003638 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003639
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003640 /* configured CID len is guaranteed at most 255, see
3641 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3642 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003643 memcpy(rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len);
3644 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003645#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003646 {
Gilles Peskine449bd832023-01-11 14:50:10 +01003647 if (ssl_check_record_type(rec->type)) {
3648 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type %u",
3649 (unsigned) rec->type));
3650 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003651 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003652 }
3653
Hanno Beckere5e7e782019-07-11 12:29:35 +01003654 /*
3655 * Parse and validate record version
3656 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003657 rec->ver[0] = buf[rec_hdr_version_offset + 0];
3658 rec->ver[1] = buf[rec_hdr_version_offset + 1];
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003659 tls_version = (mbedtls_ssl_protocol_version) mbedtls_ssl_read_version(
3660 buf + rec_hdr_version_offset,
3661 ssl->conf->transport);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003662
Gilles Peskine449bd832023-01-11 14:50:10 +01003663 if (tls_version > ssl->conf->max_tls_version) {
3664 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS version mismatch: got %u, expected max %u",
3665 (unsigned) tls_version,
3666 (unsigned) ssl->conf->max_tls_version));
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003667
Gilles Peskine449bd832023-01-11 14:50:10 +01003668 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Paul Bakker5121ce52009-01-03 21:22:43 +00003669 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003670 /*
3671 * Parse/Copy record sequence number.
3672 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003673
Hanno Beckere5e7e782019-07-11 12:29:35 +01003674#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003675 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003676 /* Copy explicit record sequence number from input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003677 memcpy(&rec->ctr[0], buf + rec_hdr_ctr_offset,
3678 rec_hdr_ctr_len);
3679 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003680#endif /* MBEDTLS_SSL_PROTO_DTLS */
3681 {
3682 /* Copy implicit record sequence number from SSL context structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003683 memcpy(&rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003684 }
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003685
Hanno Beckere5e7e782019-07-11 12:29:35 +01003686 /*
3687 * Parse record length.
3688 */
3689
Hanno Beckere5e7e782019-07-11 12:29:35 +01003690 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003691 rec->data_len = MBEDTLS_GET_UINT16_BE(buf, rec_hdr_len_offset);
Gilles Peskine449bd832023-01-11 14:50:10 +01003692 MBEDTLS_SSL_DEBUG_BUF(4, "input record header", buf, rec->data_offset);
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003693
Gilles Peskine449bd832023-01-11 14:50:10 +01003694 MBEDTLS_SSL_DEBUG_MSG(3, ("input record: msgtype = %u, "
3695 "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3696 rec->type, (unsigned) tls_version, rec->data_len));
Hanno Beckere5e7e782019-07-11 12:29:35 +01003697
3698 rec->buf = buf;
3699 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003700
Gilles Peskine449bd832023-01-11 14:50:10 +01003701 if (rec->data_len == 0) {
Gilles Peskine7c1dbef2025-03-07 20:48:01 +01003702 MBEDTLS_SSL_DEBUG_MSG(1, ("rejecting empty record"));
Gilles Peskine449bd832023-01-11 14:50:10 +01003703 return MBEDTLS_ERR_SSL_INVALID_RECORD;
3704 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003705
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003706 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003707 * DTLS-related tests.
3708 * Check epoch before checking length constraint because
3709 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3710 * message gets duplicated before the corresponding Finished message,
3711 * the second ChangeCipherSpec should be discarded because it belongs
3712 * to an old epoch, but not because its length is shorter than
3713 * the minimum record length for packets using the new record transform.
3714 * Note that these two kinds of failures are handled differently,
3715 * as an unexpected record is silently skipped but an invalid
3716 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003717 */
3718#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003719 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003720 rec_epoch = MBEDTLS_GET_UINT16_BE(rec->ctr, 0);
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003721
Hanno Becker955a5c92019-07-10 17:12:07 +01003722 /* Check that the datagram is large enough to contain a record
3723 * of the advertised length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003724 if (len < rec->data_offset + rec->data_len) {
3725 MBEDTLS_SSL_DEBUG_MSG(1,
3726 (
3727 "Datagram of length %u too small to contain record of advertised length %u.",
3728 (unsigned) len,
3729 (unsigned) (rec->data_offset + rec->data_len)));
3730 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker955a5c92019-07-10 17:12:07 +01003731 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003732
Hanno Becker37cfe732019-07-10 17:20:01 +01003733 /* Records from other, non-matching epochs are silently discarded.
3734 * (The case of same-port Client reconnects must be considered in
3735 * the caller). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003736 if (rec_epoch != ssl->in_epoch) {
3737 MBEDTLS_SSL_DEBUG_MSG(1, ("record from another epoch: "
3738 "expected %u, received %lu",
3739 ssl->in_epoch, (unsigned long) rec_epoch));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003740
Hanno Becker552f7472019-07-19 10:59:12 +01003741 /* Records from the next epoch are considered for buffering
3742 * (concretely: early Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003743 if (rec_epoch == (unsigned) ssl->in_epoch + 1) {
3744 MBEDTLS_SSL_DEBUG_MSG(2, ("Consider record for buffering"));
3745 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003746 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003747
Gilles Peskine449bd832023-01-11 14:50:10 +01003748 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003749 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003750#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003751 /* For records from the correct epoch, check whether their
3752 * sequence number has been seen before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003753 else if (mbedtls_ssl_dtls_record_replay_check((mbedtls_ssl_context *) ssl,
3754 &rec->ctr[0]) != 0) {
3755 MBEDTLS_SSL_DEBUG_MSG(1, ("replayed record"));
3756 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003757 }
3758#endif
3759 }
3760#endif /* MBEDTLS_SSL_PROTO_DTLS */
3761
Gilles Peskine449bd832023-01-11 14:50:10 +01003762 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003763}
Paul Bakker5121ce52009-01-03 21:22:43 +00003764
Paul Bakker5121ce52009-01-03 21:22:43 +00003765
Hanno Becker2fddd372019-07-10 14:37:41 +01003766#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003767MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003768static int ssl_check_client_reconnect(mbedtls_ssl_context *ssl)
Hanno Becker2fddd372019-07-10 14:37:41 +01003769{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003770 unsigned int rec_epoch = MBEDTLS_GET_UINT16_BE(ssl->in_ctr, 0);
Hanno Becker2fddd372019-07-10 14:37:41 +01003771
3772 /*
3773 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3774 * access the first byte of record content (handshake type), as we
3775 * have an active transform (possibly iv_len != 0), so use the
3776 * fact that the record header len is 13 instead.
3777 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003778 if (rec_epoch == 0 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003779 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003780 mbedtls_ssl_is_handshake_over(ssl) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003781 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3782 ssl->in_left > 13 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003783 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO) {
3784 MBEDTLS_SSL_DEBUG_MSG(1, ("possible client reconnect "
3785 "from the same port"));
3786 return ssl_handle_possible_reconnect(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003787 }
3788
Gilles Peskine449bd832023-01-11 14:50:10 +01003789 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003790}
Hanno Becker2fddd372019-07-10 14:37:41 +01003791#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003792
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003793/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003794 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003795 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003796MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003797static int ssl_prepare_record_content(mbedtls_ssl_context *ssl,
3798 mbedtls_record *rec)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003799{
3800 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003801
Gilles Peskine449bd832023-01-11 14:50:10 +01003802 MBEDTLS_SSL_DEBUG_BUF(4, "input record from network",
3803 rec->buf, rec->buf_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00003804
Ronald Cron7e38cba2021-11-24 12:43:39 +01003805 /*
3806 * In TLS 1.3, always treat ChangeCipherSpec records
3807 * as unencrypted. The only thing we do with them is
3808 * check the length and content and ignore them.
3809 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003810#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003811 if (ssl->transform_in != NULL &&
3812 ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3813 if (rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01003814 done = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003815 }
Ronald Cron7e38cba2021-11-24 12:43:39 +01003816 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003817#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003818
Gilles Peskine449bd832023-01-11 14:50:10 +01003819 if (!done && ssl->transform_in != NULL) {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003820 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003821
Gilles Peskine449bd832023-01-11 14:50:10 +01003822 if ((ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in,
3823 rec)) != 0) {
3824 MBEDTLS_SSL_DEBUG_RET(1, "ssl_decrypt_buf", ret);
Hanno Becker8367ccc2019-05-14 11:30:10 +01003825
Ronald Cron2995d352024-01-18 16:59:39 +01003826#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
3827 /*
3828 * Although the server rejected early data, it might receive early
3829 * data as long as it has not received the client Finished message.
3830 * It is encrypted with early keys and should be ignored as stated
3831 * in section 4.2.10 of RFC 8446:
3832 *
3833 * "Ignore the extension and return a regular 1-RTT response. The
3834 * server then skips past early data by attempting to deprotect
3835 * received records using the handshake traffic key, discarding
3836 * records which fail deprotection (up to the configured
3837 * max_early_data_size). Once a record is deprotected successfully,
3838 * it is treated as the start of the client's second flight and the
3839 * server proceeds as with an ordinary 1-RTT handshake."
3840 */
3841 if ((old_msg_type == MBEDTLS_SSL_MSG_APPLICATION_DATA) &&
3842 (ssl->discard_early_data_record ==
3843 MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD)) {
3844 MBEDTLS_SSL_DEBUG_MSG(
3845 3, ("EarlyData: deprotect and discard app data records."));
Ronald Cron919e5962024-02-08 15:48:29 +01003846
3847 ret = mbedtls_ssl_tls13_check_early_data_len(ssl, rec->data_len);
3848 if (ret != 0) {
3849 return ret;
3850 }
Ronald Cron2995d352024-01-18 16:59:39 +01003851 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3852 }
3853#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
3854
Hanno Beckera0e20d02019-05-15 14:03:01 +01003855#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01003856 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
Hanno Becker8367ccc2019-05-14 11:30:10 +01003857 ssl->conf->ignore_unexpected_cid
Gilles Peskine449bd832023-01-11 14:50:10 +01003858 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
3859 MBEDTLS_SSL_DEBUG_MSG(3, ("ignoring unexpected CID"));
Hanno Becker16ded982019-05-08 13:02:55 +01003860 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003861 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003862#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003863
Ronald Cron71c6e652024-02-05 16:48:10 +01003864 /*
3865 * The decryption of the record failed, no reason to ignore it,
3866 * return in error with the decryption error code.
3867 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003868 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003869 }
3870
Ronald Cron2995d352024-01-18 16:59:39 +01003871#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
3872 /*
3873 * If the server were discarding protected records that it fails to
3874 * deprotect because it has rejected early data, as we have just
3875 * deprotected successfully a record, the server has to resume normal
3876 * operation and fail the connection if the deprotection of a record
3877 * fails.
3878 */
3879 if (ssl->discard_early_data_record ==
3880 MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD) {
3881 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
3882 }
3883#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
3884
Gilles Peskine449bd832023-01-11 14:50:10 +01003885 if (old_msg_type != rec->type) {
3886 MBEDTLS_SSL_DEBUG_MSG(4, ("record type after decrypt (before %d): %d",
3887 old_msg_type, rec->type));
Hanno Becker6430faf2019-05-08 11:57:13 +01003888 }
3889
Gilles Peskine449bd832023-01-11 14:50:10 +01003890 MBEDTLS_SSL_DEBUG_BUF(4, "input payload after decrypt",
3891 rec->buf + rec->data_offset, rec->data_len);
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003892
Hanno Beckera0e20d02019-05-15 14:03:01 +01003893#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003894 /* We have already checked the record content type
3895 * in ssl_parse_record_header(), failing or silently
3896 * dropping the record in the case of an unknown type.
3897 *
3898 * Since with the use of CIDs, the record content type
3899 * might change during decryption, re-check the record
3900 * content type, but treat a failure as fatal this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003901 if (ssl_check_record_type(rec->type)) {
3902 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type"));
3903 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker6430faf2019-05-08 11:57:13 +01003904 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003905#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003906
Gilles Peskine449bd832023-01-11 14:50:10 +01003907 if (rec->data_len == 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003908#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003909 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
3910 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003911 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01003912 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid zero-length message type: %d", ssl->in_msgtype));
3913 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003914 }
3915#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3916
3917 ssl->nb_zero++;
3918
3919 /*
3920 * Three or more empty messages may be a DoS attack
3921 * (excessive CPU consumption).
3922 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003923 if (ssl->nb_zero > 3) {
3924 MBEDTLS_SSL_DEBUG_MSG(1, ("received four consecutive empty "
3925 "messages, possible DoS attack"));
Hanno Becker6e7700d2019-05-08 10:38:32 +01003926 /* Treat the records as if they were not properly authenticated,
3927 * thereby failing the connection if we see more than allowed
3928 * by the configured bad MAC threshold. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003929 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003930 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003931 } else {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003932 ssl->nb_zero = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003933 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003934
3935#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003936 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003937 ; /* in_ctr read from peer, not maintained internally */
Gilles Peskine449bd832023-01-11 14:50:10 +01003938 } else
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003939#endif
3940 {
3941 unsigned i;
Gilles Peskine449bd832023-01-11 14:50:10 +01003942 for (i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3943 i > mbedtls_ssl_ep_len(ssl); i--) {
3944 if (++ssl->in_ctr[i - 1] != 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003945 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003946 }
Jerry Yuae0b2e22021-10-08 15:21:19 +08003947 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003948
3949 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01003950 if (i == mbedtls_ssl_ep_len(ssl)) {
3951 MBEDTLS_SSL_DEBUG_MSG(1, ("incoming message counter would wrap"));
3952 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003953 }
3954 }
3955
Paul Bakker5121ce52009-01-03 21:22:43 +00003956 }
3957
Jerry Yuf57d14b2023-11-15 16:40:09 +08003958#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
3959 /*
3960 * Although the server rejected early data because it needed to send an
3961 * HelloRetryRequest message, it might receive early data as long as it has
3962 * not received the client Finished message.
3963 * The early data is encrypted with early keys and should be ignored as
3964 * stated in section 4.2.10 of RFC 8446 (second case):
3965 *
3966 * "The server then ignores early data by skipping all records with an
3967 * external content type of "application_data" (indicating that they are
3968 * encrypted), up to the configured max_early_data_size. Ignore application
3969 * data message before 2nd ClientHello when early_data was received in 1st
3970 * ClientHello."
3971 */
3972 if (ssl->discard_early_data_record == MBEDTLS_SSL_EARLY_DATA_DISCARD) {
3973 if (rec->type == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Ronald Cron01d273d2024-02-09 16:17:10 +01003974
3975 ret = mbedtls_ssl_tls13_check_early_data_len(ssl, rec->data_len);
3976 if (ret != 0) {
3977 return ret;
3978 }
3979
Jerry Yuf57d14b2023-11-15 16:40:09 +08003980 MBEDTLS_SSL_DEBUG_MSG(
3981 3, ("EarlyData: Ignore application message before 2nd ClientHello"));
Ronald Crondb944a72024-03-08 11:32:53 +01003982
Jerry Yuf57d14b2023-11-15 16:40:09 +08003983 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3984 } else if (rec->type == MBEDTLS_SSL_MSG_HANDSHAKE) {
3985 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
3986 }
3987 }
3988#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
3989
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003990#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003991 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3992 mbedtls_ssl_dtls_replay_update(ssl);
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003993 }
3994#endif
3995
Hanno Beckerd96e10b2019-07-09 17:30:02 +01003996 /* Check actual (decrypted) record content length against
3997 * configured maximum. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003998 if (rec->data_len > MBEDTLS_SSL_IN_CONTENT_LEN) {
3999 MBEDTLS_SSL_DEBUG_MSG(1, ("bad message length"));
4000 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004001 }
4002
Gilles Peskine449bd832023-01-11 14:50:10 +01004003 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004004}
4005
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004006/*
4007 * Read a record.
4008 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004009 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
4010 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
4011 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004012 */
Hanno Becker1097b342018-08-15 14:09:41 +01004013
4014/* Helper functions for mbedtls_ssl_read_record(). */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004015MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004016static int ssl_consume_current_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004017MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004018static int ssl_get_next_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004019MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004020static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl);
Hanno Becker4162b112018-08-15 14:05:04 +01004021
Gilles Peskine449bd832023-01-11 14:50:10 +01004022int mbedtls_ssl_read_record(mbedtls_ssl_context *ssl,
4023 unsigned update_hs_digest)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004024{
Janos Follath865b3eb2019-12-16 11:46:15 +00004025 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004026
Gilles Peskine449bd832023-01-11 14:50:10 +01004027 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read record"));
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004028
Gilles Peskine449bd832023-01-11 14:50:10 +01004029 if (ssl->keep_current_message == 0) {
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004030 do {
Simon Butcher99000142016-10-13 17:21:01 +01004031
Gilles Peskine449bd832023-01-11 14:50:10 +01004032 ret = ssl_consume_current_message(ssl);
4033 if (ret != 0) {
4034 return ret;
4035 }
Hanno Becker26994592018-08-15 14:14:59 +01004036
Gilles Peskine449bd832023-01-11 14:50:10 +01004037 if (ssl_record_is_in_progress(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004038 int dtls_have_buffered = 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004039#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere74d5562018-08-15 14:26:08 +01004040
Hanno Becker40f50842018-08-15 14:48:01 +01004041 /* We only check for buffered messages if the
4042 * current datagram is fully consumed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004043 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4044 ssl_next_record_is_in_datagram(ssl) == 0) {
4045 if (ssl_load_buffered_message(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004046 dtls_have_buffered = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004047 }
Hanno Becker40f50842018-08-15 14:48:01 +01004048 }
4049
Hanno Becker40f50842018-08-15 14:48:01 +01004050#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004051 if (dtls_have_buffered == 0) {
4052 ret = ssl_get_next_record(ssl);
4053 if (ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING) {
Hanno Becker40f50842018-08-15 14:48:01 +01004054 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01004055 }
Hanno Becker40f50842018-08-15 14:48:01 +01004056
Gilles Peskine449bd832023-01-11 14:50:10 +01004057 if (ret != 0) {
4058 MBEDTLS_SSL_DEBUG_RET(1, ("ssl_get_next_record"), ret);
4059 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004060 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004061 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004062 }
4063
Gilles Peskine449bd832023-01-11 14:50:10 +01004064 ret = mbedtls_ssl_handle_message_type(ssl);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004065
Hanno Becker40f50842018-08-15 14:48:01 +01004066#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004067 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
Hanno Becker40f50842018-08-15 14:48:01 +01004068 /* Buffer future message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004069 ret = ssl_buffer_message(ssl);
4070 if (ret != 0) {
4071 return ret;
4072 }
Hanno Becker40f50842018-08-15 14:48:01 +01004073
4074 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4075 }
4076#endif /* MBEDTLS_SSL_PROTO_DTLS */
4077
Gilles Peskine449bd832023-01-11 14:50:10 +01004078 } while (MBEDTLS_ERR_SSL_NON_FATAL == ret ||
4079 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004080
Gilles Peskine449bd832023-01-11 14:50:10 +01004081 if (0 != ret) {
4082 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_handle_message_type"), ret);
4083 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004084 }
4085
Gilles Peskine449bd832023-01-11 14:50:10 +01004086 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
4087 update_hs_digest == 1) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01004088 ret = mbedtls_ssl_update_handshake_status(ssl);
4089 if (0 != ret) {
4090 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_update_handshake_status"), ret);
4091 return ret;
4092 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004093 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004094 } else {
4095 MBEDTLS_SSL_DEBUG_MSG(2, ("reuse previously read message"));
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004096 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004097 }
4098
Gilles Peskine449bd832023-01-11 14:50:10 +01004099 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read record"));
Simon Butcher99000142016-10-13 17:21:01 +01004100
Gilles Peskine449bd832023-01-11 14:50:10 +01004101 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004102}
4103
Hanno Becker40f50842018-08-15 14:48:01 +01004104#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004105MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004106static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004107{
Gilles Peskine449bd832023-01-11 14:50:10 +01004108 if (ssl->in_left > ssl->next_record_offset) {
4109 return 1;
4110 }
Simon Butcher99000142016-10-13 17:21:01 +01004111
Gilles Peskine449bd832023-01-11 14:50:10 +01004112 return 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004113}
4114
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004115MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004116static int ssl_load_buffered_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004117{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004118 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004119 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004120 int ret = 0;
4121
Gilles Peskine449bd832023-01-11 14:50:10 +01004122 if (hs == NULL) {
4123 return -1;
4124 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004125
Gilles Peskine449bd832023-01-11 14:50:10 +01004126 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_message"));
Hanno Beckere00ae372018-08-20 09:39:42 +01004127
Gilles Peskine449bd832023-01-11 14:50:10 +01004128 if (ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4129 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004130 /* Check if we have seen a ChangeCipherSpec before.
4131 * If yes, synthesize a CCS record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004132 if (!hs->buffering.seen_ccs) {
4133 MBEDTLS_SSL_DEBUG_MSG(2, ("CCS not seen in the current flight"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004134 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004135 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004136 }
4137
Gilles Peskine449bd832023-01-11 14:50:10 +01004138 MBEDTLS_SSL_DEBUG_MSG(2, ("Injecting buffered CCS message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004139 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4140 ssl->in_msglen = 1;
4141 ssl->in_msg[0] = 1;
4142
4143 /* As long as they are equal, the exact value doesn't matter. */
4144 ssl->in_left = 0;
4145 ssl->next_record_offset = 0;
4146
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004147 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004148 goto exit;
4149 }
Hanno Becker37f95322018-08-16 13:55:32 +01004150
Hanno Beckerb8f50142018-08-28 10:01:34 +01004151#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004152 /* Debug only */
4153 {
4154 unsigned offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004155 for (offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
Hanno Becker37f95322018-08-16 13:55:32 +01004156 hs_buf = &hs->buffering.hs[offset];
Gilles Peskine449bd832023-01-11 14:50:10 +01004157 if (hs_buf->is_valid == 1) {
4158 MBEDTLS_SSL_DEBUG_MSG(2, ("Future message with sequence number %u %s buffered.",
4159 hs->in_msg_seq + offset,
4160 hs_buf->is_complete ? "fully" : "partially"));
Hanno Becker37f95322018-08-16 13:55:32 +01004161 }
4162 }
4163 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004164#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004165
4166 /* Check if we have buffered and/or fully reassembled the
4167 * next handshake message. */
4168 hs_buf = &hs->buffering.hs[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01004169 if ((hs_buf->is_valid == 1) && (hs_buf->is_complete == 1)) {
Hanno Becker37f95322018-08-16 13:55:32 +01004170 /* Synthesize a record containing the buffered HS message. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004171 size_t msg_len = MBEDTLS_GET_UINT24_BE(hs_buf->data, 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004172
4173 /* Double-check that we haven't accidentally buffered
4174 * a message that doesn't fit into the input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004175 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
4176 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4177 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004178 }
4179
Gilles Peskine449bd832023-01-11 14:50:10 +01004180 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message has been buffered - load"));
4181 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered handshake message (incl. header)",
4182 hs_buf->data, msg_len + 12);
Hanno Becker37f95322018-08-16 13:55:32 +01004183
4184 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4185 ssl->in_hslen = msg_len + 12;
4186 ssl->in_msglen = msg_len + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01004187 memcpy(ssl->in_msg, hs_buf->data, ssl->in_hslen);
Hanno Becker37f95322018-08-16 13:55:32 +01004188
4189 ret = 0;
4190 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004191 } else {
Ari Weiler-Ofek67aa9592025-06-10 16:59:44 +01004192 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message %u not or only partially buffered",
Gilles Peskine449bd832023-01-11 14:50:10 +01004193 hs->in_msg_seq));
Hanno Becker37f95322018-08-16 13:55:32 +01004194 }
4195
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004196 ret = -1;
4197
4198exit:
4199
Gilles Peskine449bd832023-01-11 14:50:10 +01004200 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_message"));
4201 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004202}
4203
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004204MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004205static int ssl_buffer_make_space(mbedtls_ssl_context *ssl,
4206 size_t desired)
Hanno Beckera02b0b42018-08-21 17:20:27 +01004207{
4208 int offset;
4209 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004210 MBEDTLS_SSL_DEBUG_MSG(2, ("Attempt to free buffered messages to have %u bytes available",
4211 (unsigned) desired));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004212
Hanno Becker01315ea2018-08-21 17:22:17 +01004213 /* Get rid of future records epoch first, if such exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004214 ssl_free_buffered_record(ssl);
Hanno Becker01315ea2018-08-21 17:22:17 +01004215
4216 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004217 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4218 hs->buffering.total_bytes_buffered)) {
4219 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing future epoch record"));
4220 return 0;
Hanno Becker01315ea2018-08-21 17:22:17 +01004221 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004222
Hanno Becker4f432ad2018-08-28 10:02:32 +01004223 /* We don't have enough space to buffer the next expected handshake
4224 * message. Remove buffers used for future messages to gain space,
4225 * starting with the most distant one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004226 for (offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4227 offset >= 0; offset--) {
4228 MBEDTLS_SSL_DEBUG_MSG(2,
4229 (
4230 "Free buffering slot %d to make space for reassembly of next handshake message",
4231 offset));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004232
Gilles Peskine449bd832023-01-11 14:50:10 +01004233 ssl_buffering_free_slot(ssl, (uint8_t) offset);
Hanno Beckera02b0b42018-08-21 17:20:27 +01004234
4235 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004236 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4237 hs->buffering.total_bytes_buffered)) {
4238 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing buffered HS messages"));
4239 return 0;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004240 }
4241 }
4242
Gilles Peskine449bd832023-01-11 14:50:10 +01004243 return -1;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004244}
4245
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004246MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004247static int ssl_buffer_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004248{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004249 int ret = 0;
4250 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4251
Gilles Peskine449bd832023-01-11 14:50:10 +01004252 if (hs == NULL) {
4253 return 0;
4254 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004255
Gilles Peskine449bd832023-01-11 14:50:10 +01004256 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_buffer_message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004257
Gilles Peskine449bd832023-01-11 14:50:10 +01004258 switch (ssl->in_msgtype) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004259 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
Gilles Peskine449bd832023-01-11 14:50:10 +01004260 MBEDTLS_SSL_DEBUG_MSG(2, ("Remember CCS message"));
Hanno Beckere678eaa2018-08-21 14:57:46 +01004261
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004262 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004263 break;
4264
4265 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004266 {
4267 unsigned recv_msg_seq_offset;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004268 unsigned recv_msg_seq = MBEDTLS_GET_UINT16_BE(ssl->in_msg, 4);
Hanno Becker37f95322018-08-16 13:55:32 +01004269 mbedtls_ssl_hs_buffer *hs_buf;
4270 size_t msg_len = ssl->in_hslen - 12;
4271
4272 /* We should never receive an old handshake
4273 * message - double-check nonetheless. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004274 if (recv_msg_seq < ssl->handshake->in_msg_seq) {
4275 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4276 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004277 }
4278
4279 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
Gilles Peskine449bd832023-01-11 14:50:10 +01004280 if (recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Becker37f95322018-08-16 13:55:32 +01004281 /* Silently ignore -- message too far in the future */
Gilles Peskine449bd832023-01-11 14:50:10 +01004282 MBEDTLS_SSL_DEBUG_MSG(2,
4283 ("Ignore future HS message with sequence number %u, "
4284 "buffering window %u - %u",
4285 recv_msg_seq, ssl->handshake->in_msg_seq,
4286 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS -
4287 1));
Hanno Becker37f95322018-08-16 13:55:32 +01004288
4289 goto exit;
4290 }
4291
Gilles Peskine449bd832023-01-11 14:50:10 +01004292 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering HS message with sequence number %u, offset %u ",
4293 recv_msg_seq, recv_msg_seq_offset));
Hanno Becker37f95322018-08-16 13:55:32 +01004294
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 hs_buf = &hs->buffering.hs[recv_msg_seq_offset];
Hanno Becker37f95322018-08-16 13:55:32 +01004296
4297 /* Check if the buffering for this seq nr has already commenced. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 if (!hs_buf->is_valid) {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004299 size_t reassembly_buf_sz;
4300
Hanno Becker37f95322018-08-16 13:55:32 +01004301 hs_buf->is_fragmented =
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 (ssl_hs_is_proper_fragment(ssl) == 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004303
4304 /* We copy the message back into the input buffer
4305 * after reassembly, so check that it's not too large.
4306 * This is an implementation-specific limitation
4307 * and not one from the standard, hence it is not
4308 * checked in ssl_check_hs_header(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004309 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
Hanno Becker37f95322018-08-16 13:55:32 +01004310 /* Ignore message */
4311 goto exit;
4312 }
4313
Hanno Beckere0b150f2018-08-21 15:51:03 +01004314 /* Check if we have enough space to buffer the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004315 if (hs->buffering.total_bytes_buffered >
4316 MBEDTLS_SSL_DTLS_MAX_BUFFERING) {
4317 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4318 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004319 }
4320
Gilles Peskine449bd832023-01-11 14:50:10 +01004321 reassembly_buf_sz = ssl_get_reassembly_buffer_size(msg_len,
4322 hs_buf->is_fragmented);
Hanno Beckere0b150f2018-08-21 15:51:03 +01004323
Gilles Peskine449bd832023-01-11 14:50:10 +01004324 if (reassembly_buf_sz > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4325 hs->buffering.total_bytes_buffered)) {
4326 if (recv_msg_seq_offset > 0) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004327 /* If we can't buffer a future message because
4328 * of space limitations -- ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004329 MBEDTLS_SSL_DEBUG_MSG(2,
4330 ("Buffering of future message of size %"
4331 MBEDTLS_PRINTF_SIZET
4332 " would exceed the compile-time limit %"
4333 MBEDTLS_PRINTF_SIZET
4334 " (already %" MBEDTLS_PRINTF_SIZET
4335 " bytes buffered) -- ignore\n",
4336 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4337 hs->buffering.total_bytes_buffered));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004338 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004339 } else {
4340 MBEDTLS_SSL_DEBUG_MSG(2,
4341 ("Buffering of future message of size %"
4342 MBEDTLS_PRINTF_SIZET
4343 " would exceed the compile-time limit %"
4344 MBEDTLS_PRINTF_SIZET
4345 " (already %" MBEDTLS_PRINTF_SIZET
4346 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
4347 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4348 hs->buffering.total_bytes_buffered));
Hanno Beckere1801392018-08-21 16:51:05 +01004349 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004350
Gilles Peskine449bd832023-01-11 14:50:10 +01004351 if (ssl_buffer_make_space(ssl, reassembly_buf_sz) != 0) {
4352 MBEDTLS_SSL_DEBUG_MSG(2,
4353 ("Reassembly of next message of size %"
4354 MBEDTLS_PRINTF_SIZET
4355 " (%" MBEDTLS_PRINTF_SIZET
4356 " with bitmap) would exceed"
4357 " the compile-time limit %"
4358 MBEDTLS_PRINTF_SIZET
4359 " (already %" MBEDTLS_PRINTF_SIZET
4360 " bytes buffered) -- fail\n",
4361 msg_len,
4362 reassembly_buf_sz,
4363 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4364 hs->buffering.total_bytes_buffered));
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004365 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4366 goto exit;
4367 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004368 }
4369
Gilles Peskine449bd832023-01-11 14:50:10 +01004370 MBEDTLS_SSL_DEBUG_MSG(2,
4371 ("initialize reassembly, total length = %"
4372 MBEDTLS_PRINTF_SIZET,
4373 msg_len));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004374
Gilles Peskine449bd832023-01-11 14:50:10 +01004375 hs_buf->data = mbedtls_calloc(1, reassembly_buf_sz);
4376 if (hs_buf->data == NULL) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004377 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004378 goto exit;
4379 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004380 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004381
4382 /* Prepare final header: copy msg_type, length and message_seq,
4383 * then add standardised fragment_offset and fragment_length */
Gilles Peskine449bd832023-01-11 14:50:10 +01004384 memcpy(hs_buf->data, ssl->in_msg, 6);
4385 memset(hs_buf->data + 6, 0, 3);
4386 memcpy(hs_buf->data + 9, hs_buf->data + 1, 3);
Hanno Becker37f95322018-08-16 13:55:32 +01004387
4388 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004389
4390 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Gilles Peskine449bd832023-01-11 14:50:10 +01004391 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004392 /* Make sure msg_type and length are consistent */
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 if (memcmp(hs_buf->data, ssl->in_msg, 4) != 0) {
4394 MBEDTLS_SSL_DEBUG_MSG(1, ("Fragment header mismatch - ignore"));
Hanno Becker37f95322018-08-16 13:55:32 +01004395 /* Ignore */
4396 goto exit;
4397 }
4398 }
4399
Gilles Peskine449bd832023-01-11 14:50:10 +01004400 if (!hs_buf->is_complete) {
Hanno Becker37f95322018-08-16 13:55:32 +01004401 size_t frag_len, frag_off;
4402 unsigned char * const msg = hs_buf->data + 12;
4403
4404 /*
4405 * Check and copy current fragment
4406 */
4407
4408 /* Validation of header fields already done in
4409 * mbedtls_ssl_prepare_handshake_record(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004410 frag_off = ssl_get_hs_frag_off(ssl);
4411 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker37f95322018-08-16 13:55:32 +01004412
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 MBEDTLS_SSL_DEBUG_MSG(2, ("adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4414 ", length = %" MBEDTLS_PRINTF_SIZET,
4415 frag_off, frag_len));
4416 memcpy(msg + frag_off, ssl->in_msg + 12, frag_len);
Hanno Becker37f95322018-08-16 13:55:32 +01004417
Gilles Peskine449bd832023-01-11 14:50:10 +01004418 if (hs_buf->is_fragmented) {
Hanno Becker37f95322018-08-16 13:55:32 +01004419 unsigned char * const bitmask = msg + msg_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004420 ssl_bitmask_set(bitmask, frag_off, frag_len);
4421 hs_buf->is_complete = (ssl_bitmask_check(bitmask,
4422 msg_len) == 0);
4423 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004424 hs_buf->is_complete = 1;
4425 }
4426
Gilles Peskine449bd832023-01-11 14:50:10 +01004427 MBEDTLS_SSL_DEBUG_MSG(2, ("message %scomplete",
4428 hs_buf->is_complete ? "" : "not yet "));
Hanno Becker37f95322018-08-16 13:55:32 +01004429 }
4430
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004431 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004432 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004433
4434 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004435 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004436 break;
4437 }
4438
4439exit:
4440
Gilles Peskine449bd832023-01-11 14:50:10 +01004441 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_buffer_message"));
4442 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004443}
4444#endif /* MBEDTLS_SSL_PROTO_DTLS */
4445
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004446MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004447static int ssl_consume_current_message(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004448{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004449 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004450 * Consume last content-layer message and potentially
4451 * update in_msglen which keeps track of the contents'
4452 * consumption state.
4453 *
4454 * (1) Handshake messages:
4455 * Remove last handshake message, move content
4456 * and adapt in_msglen.
4457 *
4458 * (2) Alert messages:
4459 * Consume whole record content, in_msglen = 0.
4460 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004461 * (3) Change cipher spec:
4462 * Consume whole record content, in_msglen = 0.
4463 *
4464 * (4) Application data:
4465 * Don't do anything - the record layer provides
4466 * the application data as a stream transport
4467 * and consumes through mbedtls_ssl_read only.
4468 *
4469 */
4470
4471 /* Case (1): Handshake messages */
Gilles Peskine449bd832023-01-11 14:50:10 +01004472 if (ssl->in_hslen != 0) {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004473 /* Hard assertion to be sure that no application data
4474 * is in flight, as corrupting ssl->in_msglen during
4475 * ssl->in_offt != NULL is fatal. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004476 if (ssl->in_offt != NULL) {
4477 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4478 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004479 }
4480
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00004481 if (ssl->in_hsfraglen != 0) {
4482 /* Not all handshake fragments have arrived, do not consume. */
Gilles Peskine9bdc8aa2025-02-28 21:29:59 +01004483 MBEDTLS_SSL_DEBUG_MSG(3, ("Consume: waiting for more handshake fragments %"
4484 MBEDTLS_PRINTF_SIZET "/%" MBEDTLS_PRINTF_SIZET,
4485 ssl->in_hsfraglen, ssl->in_hslen));
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00004486 return 0;
4487 }
4488
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004489 /*
4490 * Get next Handshake message in the current record
4491 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004492
Hanno Becker4a810fb2017-05-24 16:27:30 +01004493 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004494 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004495 * current handshake content: If DTLS handshake
4496 * fragmentation is used, that's the fragment
4497 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004498 * size here is faulty and should be changed at
4499 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004500 * (2) While it doesn't seem to cause problems, one
4501 * has to be very careful not to assume that in_hslen
4502 * is always <= in_msglen in a sensible communication.
4503 * Again, it's wrong for DTLS handshake fragmentation.
4504 * The following check is therefore mandatory, and
4505 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004506 * Additionally, ssl->in_hslen might be arbitrarily out of
4507 * bounds after handling a DTLS message with an unexpected
4508 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004509 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004510 if (ssl->in_hslen < ssl->in_msglen) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004511 ssl->in_msglen -= ssl->in_hslen;
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 memmove(ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4513 ssl->in_msglen);
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00004514 MBEDTLS_PUT_UINT16_BE(ssl->in_msglen, ssl->in_len, 0);
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004515
Gilles Peskine449bd832023-01-11 14:50:10 +01004516 MBEDTLS_SSL_DEBUG_BUF(4, "remaining content in record",
4517 ssl->in_msg, ssl->in_msglen);
4518 } else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004519 ssl->in_msglen = 0;
4520 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004521
Hanno Becker4a810fb2017-05-24 16:27:30 +01004522 ssl->in_hslen = 0;
4523 }
4524 /* Case (4): Application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004525 else if (ssl->in_offt != NULL) {
4526 return 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01004527 }
4528 /* Everything else (CCS & Alerts) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004530 ssl->in_msglen = 0;
4531 }
4532
Gilles Peskine449bd832023-01-11 14:50:10 +01004533 return 0;
Hanno Becker1097b342018-08-15 14:09:41 +01004534}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004535
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004536MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004537static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl)
Hanno Beckere74d5562018-08-15 14:26:08 +01004538{
Gilles Peskine449bd832023-01-11 14:50:10 +01004539 if (ssl->in_msglen > 0) {
4540 return 1;
4541 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004542
Gilles Peskine449bd832023-01-11 14:50:10 +01004543 return 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01004544}
4545
Hanno Becker5f066e72018-08-16 14:56:31 +01004546#if defined(MBEDTLS_SSL_PROTO_DTLS)
4547
Gilles Peskine449bd832023-01-11 14:50:10 +01004548static void ssl_free_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004549{
4550 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 if (hs == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004552 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004553 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004554
Gilles Peskine449bd832023-01-11 14:50:10 +01004555 if (hs->buffering.future_record.data != NULL) {
Hanno Becker01315ea2018-08-21 17:22:17 +01004556 hs->buffering.total_bytes_buffered -=
4557 hs->buffering.future_record.len;
4558
Gilles Peskine449bd832023-01-11 14:50:10 +01004559 mbedtls_free(hs->buffering.future_record.data);
Hanno Becker01315ea2018-08-21 17:22:17 +01004560 hs->buffering.future_record.data = NULL;
4561 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004562}
4563
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004564MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004565static int ssl_load_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004566{
4567 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004568 unsigned char *rec;
Hanno Becker5f066e72018-08-16 14:56:31 +01004569 size_t rec_len;
4570 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004571#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4572 size_t in_buf_len = ssl->in_buf_len;
4573#else
4574 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4575#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004576 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4577 return 0;
4578 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004579
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 if (hs == NULL) {
4581 return 0;
4582 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004583
Hanno Becker5f066e72018-08-16 14:56:31 +01004584 rec = hs->buffering.future_record.data;
4585 rec_len = hs->buffering.future_record.len;
4586 rec_epoch = hs->buffering.future_record.epoch;
4587
Gilles Peskine449bd832023-01-11 14:50:10 +01004588 if (rec == NULL) {
4589 return 0;
4590 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004591
Hanno Becker4cb782d2018-08-20 11:19:05 +01004592 /* Only consider loading future records if the
4593 * input buffer is empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004594 if (ssl_next_record_is_in_datagram(ssl) == 1) {
4595 return 0;
4596 }
Hanno Becker4cb782d2018-08-20 11:19:05 +01004597
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_record"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004599
Gilles Peskine449bd832023-01-11 14:50:10 +01004600 if (rec_epoch != ssl->in_epoch) {
4601 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffered record not from current epoch."));
Hanno Becker5f066e72018-08-16 14:56:31 +01004602 goto exit;
4603 }
4604
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 MBEDTLS_SSL_DEBUG_MSG(2, ("Found buffered record from current epoch - load"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004606
4607 /* Double-check that the record is not too large */
Gilles Peskine449bd832023-01-11 14:50:10 +01004608 if (rec_len > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
4609 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4610 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker5f066e72018-08-16 14:56:31 +01004611 }
4612
Gilles Peskine449bd832023-01-11 14:50:10 +01004613 memcpy(ssl->in_hdr, rec, rec_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004614 ssl->in_left = rec_len;
4615 ssl->next_record_offset = 0;
4616
Gilles Peskine449bd832023-01-11 14:50:10 +01004617 ssl_free_buffered_record(ssl);
Hanno Becker5f066e72018-08-16 14:56:31 +01004618
4619exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004620 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_record"));
4621 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004622}
4623
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004624MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004625static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
4626 mbedtls_record const *rec)
Hanno Becker5f066e72018-08-16 14:56:31 +01004627{
4628 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004629
4630 /* Don't buffer future records outside handshakes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 if (hs == NULL) {
4632 return 0;
4633 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004634
4635 /* Only buffer handshake records (we are only interested
4636 * in Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004637 if (rec->type != MBEDTLS_SSL_MSG_HANDSHAKE) {
4638 return 0;
4639 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004640
4641 /* Don't buffer more than one future epoch record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004642 if (hs->buffering.future_record.data != NULL) {
4643 return 0;
4644 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004645
Hanno Becker01315ea2018-08-21 17:22:17 +01004646 /* Don't buffer record if there's not enough buffering space remaining. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 if (rec->buf_len > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4648 hs->buffering.total_bytes_buffered)) {
4649 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4650 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4651 " (already %" MBEDTLS_PRINTF_SIZET
4652 " bytes buffered) -- ignore\n",
4653 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4654 hs->buffering.total_bytes_buffered));
4655 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004656 }
4657
Hanno Becker5f066e72018-08-16 14:56:31 +01004658 /* Buffer record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004659 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffer record from epoch %u",
4660 ssl->in_epoch + 1U));
4661 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered record", rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004662
4663 /* ssl_parse_record_header() only considers records
4664 * of the next epoch as candidates for buffering. */
4665 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004666 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004667
4668 hs->buffering.future_record.data =
Gilles Peskine449bd832023-01-11 14:50:10 +01004669 mbedtls_calloc(1, hs->buffering.future_record.len);
4670 if (hs->buffering.future_record.data == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004671 /* If we run out of RAM trying to buffer a
4672 * record from the next epoch, just ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004674 }
4675
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 memcpy(hs->buffering.future_record.data, rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004677
Hanno Becker519f15d2019-07-11 12:43:20 +01004678 hs->buffering.total_bytes_buffered += rec->buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004679 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004680}
4681
4682#endif /* MBEDTLS_SSL_PROTO_DTLS */
4683
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004684MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004685static int ssl_get_next_record(mbedtls_ssl_context *ssl)
Hanno Becker1097b342018-08-15 14:09:41 +01004686{
Janos Follath865b3eb2019-12-16 11:46:15 +00004687 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004688 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004689
Hanno Becker5f066e72018-08-16 14:56:31 +01004690#if defined(MBEDTLS_SSL_PROTO_DTLS)
4691 /* We might have buffered a future record; if so,
4692 * and if the epoch matches now, load it.
4693 * On success, this call will set ssl->in_left to
4694 * the length of the buffered record, so that
4695 * the calls to ssl_fetch_input() below will
4696 * essentially be no-ops. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004697 ret = ssl_load_buffered_record(ssl);
4698 if (ret != 0) {
4699 return ret;
4700 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004701#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004702
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004703 /* Ensure that we have enough space available for the default form
4704 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4705 * with no space for CIDs counted in). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004706 ret = mbedtls_ssl_fetch_input(ssl, mbedtls_ssl_in_hdr_len(ssl));
4707 if (ret != 0) {
4708 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4709 return ret;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004710 }
4711
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 ret = ssl_parse_record_header(ssl, ssl->in_hdr, ssl->in_left, &rec);
4713 if (ret != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004714#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004715 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4716 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
4717 ret = ssl_buffer_future_record(ssl, &rec);
4718 if (ret != 0) {
4719 return ret;
4720 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004721
4722 /* Fall through to handling of unexpected records */
4723 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4724 }
4725
Gilles Peskine449bd832023-01-11 14:50:10 +01004726 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD) {
Hanno Becker2fddd372019-07-10 14:37:41 +01004727#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004728 /* Reset in pointers to default state for TLS/DTLS records,
4729 * assuming no CID and no offset between record content and
4730 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004731 mbedtls_ssl_update_in_pointers(ssl);
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004732
Hanno Becker7ae20e02019-07-12 08:33:49 +01004733 /* Setup internal message pointers from record structure. */
4734 ssl->in_msgtype = rec.type;
4735#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4736 ssl->in_len = ssl->in_cid + rec.cid_len;
4737#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4738 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4739 ssl->in_msglen = rec.data_len;
4740
Gilles Peskine449bd832023-01-11 14:50:10 +01004741 ret = ssl_check_client_reconnect(ssl);
4742 MBEDTLS_SSL_DEBUG_RET(2, "ssl_check_client_reconnect", ret);
4743 if (ret != 0) {
4744 return ret;
4745 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004746#endif
4747
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004748 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004749 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004750
Gilles Peskine449bd832023-01-11 14:50:10 +01004751 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding unexpected record "
4752 "(header)"));
4753 } else {
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004754 /* Skip invalid record and the rest of the datagram */
4755 ssl->next_record_offset = 0;
4756 ssl->in_left = 0;
4757
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record "
4759 "(header)"));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004760 }
4761
4762 /* Get next record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004763 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4764 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004765#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004766 {
Gilles Peskine449bd832023-01-11 14:50:10 +01004767 return ret;
Hanno Becker2fddd372019-07-10 14:37:41 +01004768 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004769 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004770
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004771#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004772 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckera8814792019-07-10 15:01:45 +01004773 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004774 ssl->next_record_offset = rec.buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004775 if (ssl->next_record_offset < ssl->in_left) {
4776 MBEDTLS_SSL_DEBUG_MSG(3, ("more than one record within datagram"));
Hanno Beckere65ce782017-05-22 14:47:48 +01004777 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004778 } else
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004779#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004780 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004781 /*
4782 * Fetch record contents from underlying transport.
4783 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004784 ret = mbedtls_ssl_fetch_input(ssl, rec.buf_len);
4785 if (ret != 0) {
4786 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4787 return ret;
Hanno Beckera8814792019-07-10 15:01:45 +01004788 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004789
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004790 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004791 }
4792
4793 /*
4794 * Decrypt record contents.
4795 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004796
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 if ((ret = ssl_prepare_record_content(ssl, &rec)) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004798#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004800 /* Silently discard invalid records */
Gilles Peskine449bd832023-01-11 14:50:10 +01004801 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004802 /* Except when waiting for Finished as a bad mac here
4803 * probably means something went wrong in the handshake
4804 * (eg wrong psk used, mitm downgrade attempt, etc.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 if (ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4806 ssl->state == MBEDTLS_SSL_SERVER_FINISHED) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004807#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4809 mbedtls_ssl_send_alert_message(ssl,
4810 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4811 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004812 }
4813#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 return ret;
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004815 }
4816
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 if (ssl->conf->badmac_limit != 0 &&
4818 ++ssl->badmac_seen >= ssl->conf->badmac_limit) {
4819 MBEDTLS_SSL_DEBUG_MSG(1, ("too many records with bad MAC"));
4820 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004821 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004822
Hanno Becker4a810fb2017-05-24 16:27:30 +01004823 /* As above, invalid records cause
4824 * dismissal of the whole datagram. */
4825
4826 ssl->next_record_offset = 0;
4827 ssl->in_left = 0;
4828
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record (mac)"));
4830 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004831 }
4832
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 return ret;
4834 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004835#endif
4836 {
4837 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004838#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004839 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4840 mbedtls_ssl_send_alert_message(ssl,
4841 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4842 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004843 }
4844#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 return ret;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004846 }
4847 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004848
Hanno Becker44d89b22019-07-12 09:40:44 +01004849
4850 /* Reset in pointers to default state for TLS/DTLS records,
4851 * assuming no CID and no offset between record content and
4852 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004853 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker44d89b22019-07-12 09:40:44 +01004854#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4855 ssl->in_len = ssl->in_cid + rec.cid_len;
4856#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004857 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004858
Hanno Becker8685c822019-07-12 09:37:30 +01004859 /* The record content type may change during decryption,
4860 * so re-read it. */
4861 ssl->in_msgtype = rec.type;
4862 /* Also update the input buffer, because unfortunately
4863 * the server-side ssl_parse_client_hello() reparses the
4864 * record header when receiving a ClientHello initiating
4865 * a renegotiation. */
4866 ssl->in_hdr[0] = rec.type;
4867 ssl->in_msg = rec.buf + rec.data_offset;
4868 ssl->in_msglen = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004869 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->in_len, 0);
Hanno Becker8685c822019-07-12 09:37:30 +01004870
Gilles Peskine449bd832023-01-11 14:50:10 +01004871 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004872}
4873
Gilles Peskine449bd832023-01-11 14:50:10 +01004874int mbedtls_ssl_handle_message_type(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004875{
Janos Follath865b3eb2019-12-16 11:46:15 +00004876 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004877
Manuel Pégourié-Gonnarde26a0602025-03-05 12:52:18 +01004878 /* If we're in the middle of a fragmented TLS handshake message,
4879 * we don't accept any other message type. For TLS 1.3, the spec forbids
4880 * interleaving other message types between handshake fragments. For TLS
4881 * 1.2, the spec does not forbid it but we do. */
4882 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM &&
4883 ssl->in_hsfraglen != 0 &&
4884 ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
4885 MBEDTLS_SSL_DEBUG_MSG(1, ("non-handshake message in the middle"
4886 " of a fragmented handshake message"));
4887 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
4888 }
4889
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004890 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004891 * Handle particular types of records
4892 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004893 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
4894 if ((ret = mbedtls_ssl_prepare_handshake_record(ssl)) != 0) {
4895 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004896 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004897 }
4898
Gilles Peskine449bd832023-01-11 14:50:10 +01004899 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
4900 if (ssl->in_msglen != 1) {
4901 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
4902 ssl->in_msglen));
4903 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004904 }
4905
Gilles Peskine449bd832023-01-11 14:50:10 +01004906 if (ssl->in_msg[0] != 1) {
4907 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, content: %02x",
4908 ssl->in_msg[0]));
4909 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004910 }
4911
4912#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere678eaa2018-08-21 14:57:46 +01004914 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01004915 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
4916 if (ssl->handshake == NULL) {
4917 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping ChangeCipherSpec outside handshake"));
4918 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004919 }
4920
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 MBEDTLS_SSL_DEBUG_MSG(1, ("received out-of-order ChangeCipherSpec - remember"));
4922 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004923 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004924#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004925
Ronald Cron6f135e12021-12-08 16:57:54 +01004926#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004927 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine9ca9b922024-09-13 16:03:41 +02004928 MBEDTLS_SSL_DEBUG_MSG(2,
Gilles Peskine449bd832023-01-11 14:50:10 +01004929 ("Ignore ChangeCipherSpec in TLS 1.3 compatibility mode"));
4930 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Ronald Cron7e38cba2021-11-24 12:43:39 +01004931 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004932#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01004933 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004934
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
4936 if (ssl->in_msglen != 2) {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004937 /* Note: Standard allows for more than one 2 byte alert
4938 to be packed in a single message, but Mbed TLS doesn't
4939 currently support this. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004940 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
4941 ssl->in_msglen));
4942 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004943 }
4944
Gilles Peskine449bd832023-01-11 14:50:10 +01004945 MBEDTLS_SSL_DEBUG_MSG(2, ("got an alert message, type: [%u:%u]",
4946 ssl->in_msg[0], ssl->in_msg[1]));
Paul Bakker5121ce52009-01-03 21:22:43 +00004947
4948 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004949 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004950 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004951 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL) {
4952 MBEDTLS_SSL_DEBUG_MSG(1, ("is a fatal alert message (msg %d)",
4953 ssl->in_msg[1]));
4954 return MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00004955 }
4956
Gilles Peskine449bd832023-01-11 14:50:10 +01004957 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4958 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY) {
4959 MBEDTLS_SSL_DEBUG_MSG(2, ("is a close notify message"));
4960 return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY;
Paul Bakker5121ce52009-01-03 21:22:43 +00004961 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004962
4963#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004964 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4965 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION) {
4966 MBEDTLS_SSL_DEBUG_MSG(2, ("is a no renegotiation alert"));
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004967 /* Will be handled when trying to parse ServerHello */
Gilles Peskine449bd832023-01-11 14:50:10 +01004968 return 0;
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004969 }
4970#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004971 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004972 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004973 }
4974
Hanno Beckerc76c6192017-06-06 10:03:17 +01004975#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004976 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker37ae9522019-05-03 16:54:26 +01004977 /* Drop unexpected ApplicationData records,
4978 * except at the beginning of renegotiations */
Gilles Peskine449bd832023-01-11 14:50:10 +01004979 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4980 mbedtls_ssl_is_handshake_over(ssl) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01004981#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004982 && !(ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4983 ssl->state == MBEDTLS_SSL_SERVER_HELLO)
Hanno Beckerc76c6192017-06-06 10:03:17 +01004984#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004985 ) {
4986 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping unexpected ApplicationData"));
4987 return MBEDTLS_ERR_SSL_NON_FATAL;
Hanno Becker37ae9522019-05-03 16:54:26 +01004988 }
4989
Gilles Peskine449bd832023-01-11 14:50:10 +01004990 if (ssl->handshake != NULL &&
4991 mbedtls_ssl_is_handshake_over(ssl) == 1) {
4992 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Hanno Becker37ae9522019-05-03 16:54:26 +01004993 }
4994 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01004995#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01004996
Gilles Peskine449bd832023-01-11 14:50:10 +01004997 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00004998}
4999
Gilles Peskine449bd832023-01-11 14:50:10 +01005000int mbedtls_ssl_send_fatal_handshake_failure(mbedtls_ssl_context *ssl)
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005001{
Gilles Peskine449bd832023-01-11 14:50:10 +01005002 return mbedtls_ssl_send_alert_message(ssl,
5003 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5004 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE);
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005005}
5006
Gilles Peskine449bd832023-01-11 14:50:10 +01005007int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
5008 unsigned char level,
5009 unsigned char message)
Paul Bakker0a925182012-04-16 06:46:41 +00005010{
Janos Follath865b3eb2019-12-16 11:46:15 +00005011 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00005012
Gilles Peskine449bd832023-01-11 14:50:10 +01005013 if (ssl == NULL || ssl->conf == NULL) {
5014 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5015 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005016
Gilles Peskine449bd832023-01-11 14:50:10 +01005017 if (ssl->out_left != 0) {
5018 return mbedtls_ssl_flush_output(ssl);
5019 }
Hanno Becker5e18f742018-08-06 11:35:16 +01005020
Gilles Peskine449bd832023-01-11 14:50:10 +01005021 MBEDTLS_SSL_DEBUG_MSG(2, ("=> send alert message"));
5022 MBEDTLS_SSL_DEBUG_MSG(3, ("send alert level=%u message=%u", level, message));
Paul Bakker0a925182012-04-16 06:46:41 +00005023
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005024 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00005025 ssl->out_msglen = 2;
5026 ssl->out_msg[0] = level;
5027 ssl->out_msg[1] = message;
5028
Gilles Peskine449bd832023-01-11 14:50:10 +01005029 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5030 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5031 return ret;
Paul Bakker0a925182012-04-16 06:46:41 +00005032 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005033 MBEDTLS_SSL_DEBUG_MSG(2, ("<= send alert message"));
Paul Bakker0a925182012-04-16 06:46:41 +00005034
Gilles Peskine449bd832023-01-11 14:50:10 +01005035 return 0;
Paul Bakker0a925182012-04-16 06:46:41 +00005036}
5037
Gilles Peskine449bd832023-01-11 14:50:10 +01005038int mbedtls_ssl_write_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005039{
Janos Follath865b3eb2019-12-16 11:46:15 +00005040 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005041
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005043
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005044 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00005045 ssl->out_msglen = 1;
5046 ssl->out_msg[0] = 1;
5047
Gilles Peskinef670ba52025-03-07 15:09:32 +01005048 mbedtls_ssl_handshake_increment_state(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00005049
Gilles Peskine449bd832023-01-11 14:50:10 +01005050 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
5051 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
5052 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005053 }
5054
Gilles Peskine449bd832023-01-11 14:50:10 +01005055 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005056
Gilles Peskine449bd832023-01-11 14:50:10 +01005057 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005058}
5059
Gilles Peskine449bd832023-01-11 14:50:10 +01005060int mbedtls_ssl_parse_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005061{
Janos Follath865b3eb2019-12-16 11:46:15 +00005062 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005063
Gilles Peskine449bd832023-01-11 14:50:10 +01005064 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005065
Gilles Peskine449bd832023-01-11 14:50:10 +01005066 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5067 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5068 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005069 }
5070
Gilles Peskine449bd832023-01-11 14:50:10 +01005071 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
5072 MBEDTLS_SSL_DEBUG_MSG(1, ("bad change cipher spec message"));
5073 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5074 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
5075 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005076 }
5077
Hanno Beckere678eaa2018-08-21 14:57:46 +01005078 /* CCS records are only accepted if they have length 1 and content '1',
5079 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005080
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005081 /*
5082 * Switch to our negotiated transform and session parameters for inbound
5083 * data.
5084 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005085 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for inbound data"));
Jerry Yu2e199812022-12-01 18:57:19 +08005086#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005087 ssl->transform_in = ssl->transform_negotiate;
Jerry Yu2e199812022-12-01 18:57:19 +08005088#endif
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005089 ssl->session_in = ssl->session_negotiate;
5090
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005091#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005092 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005093#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005094 mbedtls_ssl_dtls_replay_reset(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005095#endif
5096
5097 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005098 if (++ssl->in_epoch == 0) {
5099 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005100 /* This is highly unlikely to happen for legitimate reasons, so
5101 treat it as an attack and don't send an alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005103 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005104 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005105#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005106 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005107
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 mbedtls_ssl_update_in_pointers(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005109
Gilles Peskinef670ba52025-03-07 15:09:32 +01005110 mbedtls_ssl_handshake_increment_state(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00005111
Gilles Peskine449bd832023-01-11 14:50:10 +01005112 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005113
Gilles Peskine449bd832023-01-11 14:50:10 +01005114 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005115}
5116
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005117/* Once ssl->out_hdr as the address of the beginning of the
5118 * next outgoing record is set, deduce the other pointers.
5119 *
5120 * Note: For TLS, we save the implicit record sequence number
5121 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5122 * and the caller has to make sure there's space for this.
5123 */
5124
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005125static size_t ssl_transform_get_explicit_iv_len(
Gilles Peskine449bd832023-01-11 14:50:10 +01005126 mbedtls_ssl_transform const *transform)
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005127{
Gilles Peskine449bd832023-01-11 14:50:10 +01005128 return transform->ivlen - transform->fixed_ivlen;
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005129}
5130
Gilles Peskine449bd832023-01-11 14:50:10 +01005131void mbedtls_ssl_update_out_pointers(mbedtls_ssl_context *ssl,
5132 mbedtls_ssl_transform *transform)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005133{
5134#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005135 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005136 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005137#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005138 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005139 ssl->out_len = ssl->out_cid;
Gilles Peskine449bd832023-01-11 14:50:10 +01005140 if (transform != NULL) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005141 ssl->out_len += transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005142 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005143#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005144 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005145#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005146 ssl->out_iv = ssl->out_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005147 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005148#endif
5149 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005150 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005151#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005152 ssl->out_cid = ssl->out_len;
5153#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005154 ssl->out_iv = ssl->out_hdr + 5;
5155 }
5156
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005157 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005158 /* Adjust out_msg to make space for explicit IV, if used. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005159 if (transform != NULL) {
5160 ssl->out_msg += ssl_transform_get_explicit_iv_len(transform);
5161 }
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005162}
5163
5164/* Once ssl->in_hdr as the address of the beginning of the
5165 * next incoming record is set, deduce the other pointers.
5166 *
5167 * Note: For TLS, we save the implicit record sequence number
5168 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5169 * and the caller has to make sure there's space for this.
5170 */
5171
Gilles Peskine449bd832023-01-11 14:50:10 +01005172void mbedtls_ssl_update_in_pointers(mbedtls_ssl_context *ssl)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005173{
Hanno Becker79594fd2019-05-08 09:38:41 +01005174 /* This function sets the pointers to match the case
5175 * of unprotected TLS/DTLS records, with both ssl->in_iv
5176 * and ssl->in_msg pointing to the beginning of the record
5177 * content.
5178 *
5179 * When decrypting a protected record, ssl->in_msg
5180 * will be shifted to point to the beginning of the
5181 * record plaintext.
5182 */
5183
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005184#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005185 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005186 /* This sets the header pointers to match records
5187 * without CID. When we receive a record containing
5188 * a CID, the fields are shifted accordingly in
5189 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005190 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005191#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005192 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005193 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005194#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005195 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005196#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005197 ssl->in_iv = ssl->in_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005198 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005199#endif
5200 {
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005201 ssl->in_ctr = ssl->in_buf;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005202 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005203#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005204 ssl->in_cid = ssl->in_len;
5205#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005206 ssl->in_iv = ssl->in_hdr + 5;
5207 }
5208
Hanno Becker79594fd2019-05-08 09:38:41 +01005209 /* This will be adjusted at record decryption time. */
5210 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005211}
5212
Paul Bakker5121ce52009-01-03 21:22:43 +00005213/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005214 * Setup an SSL context
5215 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005216
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005217void mbedtls_ssl_reset_in_pointers(mbedtls_ssl_context *ssl)
5218{
5219#if defined(MBEDTLS_SSL_PROTO_DTLS)
5220 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5221 ssl->in_hdr = ssl->in_buf;
5222 } else
Deomid rojer Ryabkovcad11ad2025-01-18 15:58:57 +02005223#endif /* MBEDTLS_SSL_PROTO_DTLS */
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005224 {
5225 ssl->in_hdr = ssl->in_buf + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
5226 }
5227
5228 /* Derive other internal pointers. */
5229 mbedtls_ssl_update_in_pointers(ssl);
5230}
5231
5232void mbedtls_ssl_reset_out_pointers(mbedtls_ssl_context *ssl)
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005233{
5234 /* Set the incoming and outgoing record pointers. */
5235#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005236 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005237 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01005238 } else
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005239#endif /* MBEDTLS_SSL_PROTO_DTLS */
5240 {
Hanno Becker12078f42021-03-02 15:28:41 +00005241 ssl->out_ctr = ssl->out_buf;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005242 ssl->out_hdr = ssl->out_buf + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005243 }
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005244 /* Derive other internal pointers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005245 mbedtls_ssl_update_out_pointers(ssl, NULL /* no transform enabled */);
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005246}
5247
Paul Bakker5121ce52009-01-03 21:22:43 +00005248/*
5249 * SSL get accessors
5250 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005251size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005252{
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 return ssl->in_offt == NULL ? 0 : ssl->in_msglen;
Paul Bakker5121ce52009-01-03 21:22:43 +00005254}
5255
Gilles Peskine449bd832023-01-11 14:50:10 +01005256int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl)
Hanno Becker8b170a02017-10-10 11:51:19 +01005257{
5258 /*
5259 * Case A: We're currently holding back
5260 * a message for further processing.
5261 */
5262
Gilles Peskine449bd832023-01-11 14:50:10 +01005263 if (ssl->keep_current_message == 1) {
5264 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: record held back for processing"));
5265 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005266 }
5267
5268 /*
5269 * Case B: Further records are pending in the current datagram.
5270 */
5271
5272#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005273 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5274 ssl->in_left > ssl->next_record_offset) {
5275 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: more records within current datagram"));
5276 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005277 }
5278#endif /* MBEDTLS_SSL_PROTO_DTLS */
5279
5280 /*
5281 * Case C: A handshake message is being processed.
5282 */
5283
Gilles Peskine449bd832023-01-11 14:50:10 +01005284 if (ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen) {
5285 MBEDTLS_SSL_DEBUG_MSG(3,
5286 ("ssl_check_pending: more handshake messages within current record"));
5287 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005288 }
5289
5290 /*
5291 * Case D: An application data message is being processed
5292 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005293 if (ssl->in_offt != NULL) {
5294 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: application data record is being processed"));
5295 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005296 }
5297
5298 /*
5299 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005300 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005301 * we implement support for multiple alerts in single records.
5302 */
5303
Gilles Peskine449bd832023-01-11 14:50:10 +01005304 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: nothing pending"));
5305 return 0;
Hanno Becker8b170a02017-10-10 11:51:19 +01005306}
5307
Paul Bakker43ca69c2011-01-15 17:35:19 +00005308
Gilles Peskine449bd832023-01-11 14:50:10 +01005309int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005310{
Hanno Becker3136ede2018-08-17 15:28:19 +01005311 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005312 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005313 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005314 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5315 psa_key_type_t key_type;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005316
Gilles Peskine449bd832023-01-11 14:50:10 +01005317 size_t out_hdr_len = mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker5903de42019-05-03 14:46:38 +01005318
Gilles Peskine449bd832023-01-11 14:50:10 +01005319 if (transform == NULL) {
5320 return (int) out_hdr_len;
5321 }
Hanno Becker78640902018-08-13 16:35:15 +01005322
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005323
Gilles Peskine449bd832023-01-11 14:50:10 +01005324 if (transform->psa_alg == PSA_ALG_GCM ||
5325 transform->psa_alg == PSA_ALG_CCM ||
5326 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 8) ||
5327 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
5328 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005329 transform_expansion = transform->minlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01005330 } else if (transform->psa_alg == PSA_ALG_CBC_NO_PADDING) {
5331 (void) psa_get_key_attributes(transform->psa_key_enc, &attr);
5332 key_type = psa_get_key_type(&attr);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005333
Gilles Peskine449bd832023-01-11 14:50:10 +01005334 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005335
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005336 /* Expansion due to the addition of the MAC. */
5337 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005338
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005339 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005340 * Theoretically up to 256 bytes, but we never use
5341 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005342 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005343
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005344 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005345 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005346#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005347 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005348#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005349 } else {
5350 MBEDTLS_SSL_DEBUG_MSG(1,
5351 ("Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()"));
5352 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005353 }
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005354
Hanno Beckera0e20d02019-05-15 14:03:01 +01005355#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 if (transform->out_cid_len != 0) {
Hanno Becker6cbad552019-05-08 15:40:11 +01005357 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01005358 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005359#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005360
Gilles Peskine449bd832023-01-11 14:50:10 +01005361 return (int) (out_hdr_len + transform_expansion);
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005362}
5363
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005364#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005365/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005366 * Check record counters and renegotiate if they're above the limit.
5367 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005368MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005369static int ssl_check_ctr_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005370{
Gilles Peskine449bd832023-01-11 14:50:10 +01005371 size_t ep_len = mbedtls_ssl_ep_len(ssl);
Andres AG2196c7f2016-12-15 17:01:16 +00005372 int in_ctr_cmp;
5373 int out_ctr_cmp;
5374
Gilles Peskine449bd832023-01-11 14:50:10 +01005375 if (mbedtls_ssl_is_handshake_over(ssl) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005376 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Gilles Peskine449bd832023-01-11 14:50:10 +01005377 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5378 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005379 }
5380
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 in_ctr_cmp = memcmp(ssl->in_ctr + ep_len,
5382 &ssl->conf->renego_period[ep_len],
5383 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len);
5384 out_ctr_cmp = memcmp(&ssl->cur_out_ctr[ep_len],
Jerry Yud9a94fe2021-09-28 18:58:59 +08005385 &ssl->conf->renego_period[ep_len],
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 sizeof(ssl->cur_out_ctr) - ep_len);
Andres AG2196c7f2016-12-15 17:01:16 +00005387
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 if (in_ctr_cmp <= 0 && out_ctr_cmp <= 0) {
5389 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005390 }
5391
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 MBEDTLS_SSL_DEBUG_MSG(1, ("record counter limit reached: renegotiate"));
5393 return mbedtls_ssl_renegotiate(ssl);
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005394}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005395#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005396
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005397#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5398
Ronald Cron7df18bc2024-03-25 13:42:07 +01005399#if defined(MBEDTLS_SSL_CLI_C)
Jerry Yua0446a02022-07-13 11:22:55 +08005400MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Croncf47a152024-04-02 13:19:57 +02005401static int ssl_tls13_is_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005402{
5403
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 if ((ssl->in_hslen == mbedtls_ssl_hs_hdr_len(ssl)) ||
5405 (ssl->in_msg[0] != MBEDTLS_SSL_HS_NEW_SESSION_TICKET)) {
Ronald Croncf47a152024-04-02 13:19:57 +02005406 return 0;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005407 }
5408
Ronald Croncf47a152024-04-02 13:19:57 +02005409 return 1;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005410}
Ronald Cron7df18bc2024-03-25 13:42:07 +01005411#endif /* MBEDTLS_SSL_CLI_C */
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005412
Jerry Yua0446a02022-07-13 11:22:55 +08005413MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005414static int ssl_tls13_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005415{
5416
Gilles Peskine449bd832023-01-11 14:50:10 +01005417 MBEDTLS_SSL_DEBUG_MSG(3, ("received post-handshake message"));
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005418
Ronald Cron7df18bc2024-03-25 13:42:07 +01005419#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005420 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Ronald Croncf47a152024-04-02 13:19:57 +02005421 if (ssl_tls13_is_new_session_ticket(ssl)) {
Ronald Cron7df18bc2024-03-25 13:42:07 +01005422#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5423 MBEDTLS_SSL_DEBUG_MSG(3, ("NewSessionTicket received"));
5424 ssl->keep_current_message = 1;
5425
5426 mbedtls_ssl_handshake_set_state(ssl,
5427 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
5428 return MBEDTLS_ERR_SSL_WANT_READ;
5429#else
5430 MBEDTLS_SSL_DEBUG_MSG(3, ("Ignore NewSessionTicket, not supported."));
5431 return 0;
5432#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 }
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005434 }
Ronald Cron7df18bc2024-03-25 13:42:07 +01005435#endif /* MBEDTLS_SSL_CLI_C */
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005436
5437 /* Fail in all other cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005438 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005439}
5440#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5441
5442#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005443/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005444 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005445 * may only be sent for the purpose of initiating renegotiations.
5446 *
5447 * This function is introduced as a separate helper since the handling
5448 * of post-handshake handshake messages changes significantly in TLS 1.3,
5449 * and having a helper function allows to distinguish between TLS <= 1.2 and
5450 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5451 */
Jerry Yua0446a02022-07-13 11:22:55 +08005452MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005453static int ssl_tls12_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005454{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005455 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005456
5457 /*
5458 * - For client-side, expect SERVER_HELLO_REQUEST.
5459 * - For server-side, expect CLIENT_HELLO.
5460 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5461 */
5462
5463#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5465 (ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5466 ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl))) {
5467 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not HelloRequest)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005468
5469 /* With DTLS, drop the packet (probably from last handshake) */
5470#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005471 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5472 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005473 }
5474#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005475 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005476 }
5477#endif /* MBEDTLS_SSL_CLI_C */
5478
5479#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5481 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO) {
5482 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not ClientHello)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005483
5484 /* With DTLS, drop the packet (probably from last handshake) */
5485#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005486 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5487 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005488 }
5489#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005490 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005491 }
5492#endif /* MBEDTLS_SSL_SRV_C */
5493
5494#if defined(MBEDTLS_SSL_RENEGOTIATION)
5495 /* Determine whether renegotiation attempt should be accepted */
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 if (!(ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5497 (ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5498 ssl->conf->allow_legacy_renegotiation ==
5499 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION))) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005500 /*
5501 * Accept renegotiation request
5502 */
5503
5504 /* DTLS clients need to know renego is server-initiated */
5505#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5507 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005508 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5509 }
5510#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005511 ret = mbedtls_ssl_start_renegotiation(ssl);
5512 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5513 ret != 0) {
5514 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation",
5515 ret);
5516 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005517 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 } else
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005519#endif /* MBEDTLS_SSL_RENEGOTIATION */
5520 {
5521 /*
5522 * Refuse renegotiation
5523 */
5524
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 MBEDTLS_SSL_DEBUG_MSG(3, ("refusing renegotiation, sending alert"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005526
Gilles Peskine449bd832023-01-11 14:50:10 +01005527 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5528 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5529 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION)) != 0) {
5530 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005531 }
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005532 }
5533
Gilles Peskine449bd832023-01-11 14:50:10 +01005534 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005535}
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005536#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5537
5538MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005539static int ssl_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005540{
5541 /* Check protocol version and dispatch accordingly. */
5542#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005543 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
5544 return ssl_tls13_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005545 }
5546#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5547
5548#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005549 if (ssl->tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
5550 return ssl_tls12_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005551 }
5552#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5553
5554 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01005555 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005556}
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005557
Paul Bakker48916f92012-09-16 19:57:18 +00005558/*
Jerry Yu739a1d42022-12-08 21:10:25 +08005559 * brief Read at most 'len' application data bytes from the input
5560 * buffer.
5561 *
5562 * param ssl SSL context:
5563 * - First byte of application data not read yet in the input
5564 * buffer located at address `in_offt`.
5565 * - The number of bytes of data not read yet is `in_msglen`.
5566 * param buf buffer that will hold the data
5567 * param len maximum number of bytes to read
5568 *
5569 * note The function updates the fields `in_offt` and `in_msglen`
5570 * according to the number of bytes read.
5571 *
5572 * return The number of bytes read.
5573 */
5574static int ssl_read_application_data(
5575 mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
5576{
5577 size_t n = (len < ssl->in_msglen) ? len : ssl->in_msglen;
5578
5579 if (len != 0) {
5580 memcpy(buf, ssl->in_offt, n);
5581 ssl->in_msglen -= n;
5582 }
5583
5584 /* Zeroising the plaintext buffer to erase unused application data
5585 from the memory. */
5586 mbedtls_platform_zeroize(ssl->in_offt, n);
5587
5588 if (ssl->in_msglen == 0) {
5589 /* all bytes consumed */
5590 ssl->in_offt = NULL;
5591 ssl->keep_current_message = 0;
5592 } else {
5593 /* more data available */
5594 ssl->in_offt += n;
5595 }
5596
5597 return (int) n;
5598}
5599
5600/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005601 * Receive application data decrypted from the SSL layer
5602 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005603int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005604{
Janos Follath865b3eb2019-12-16 11:46:15 +00005605 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005606
Gilles Peskine449bd832023-01-11 14:50:10 +01005607 if (ssl == NULL || ssl->conf == NULL) {
5608 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5609 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005610
Gilles Peskine449bd832023-01-11 14:50:10 +01005611 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005612
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005613#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005614 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5615 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5616 return ret;
5617 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005618
Gilles Peskine449bd832023-01-11 14:50:10 +01005619 if (ssl->handshake != NULL &&
5620 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
5621 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
5622 return ret;
5623 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005624 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005625 }
5626#endif
5627
Hanno Becker4a810fb2017-05-24 16:27:30 +01005628 /*
5629 * Check if renegotiation is necessary and/or handshake is
5630 * in process. If yes, perform/continue, and fall through
5631 * if an unexpected packet is received while the client
5632 * is waiting for the ServerHello.
5633 *
5634 * (There is no equivalent to the last condition on
5635 * the server-side as it is not treated as within
5636 * a handshake while waiting for the ClientHello
5637 * after a renegotiation request.)
5638 */
5639
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005640#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005641 ret = ssl_check_ctr_renegotiate(ssl);
5642 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5643 ret != 0) {
5644 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5645 return ret;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005646 }
5647#endif
5648
Gilles Peskine449bd832023-01-11 14:50:10 +01005649 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5650 ret = mbedtls_ssl_handshake(ssl);
5651 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5652 ret != 0) {
5653 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5654 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005655 }
5656 }
5657
Hanno Beckere41158b2017-10-23 13:30:32 +01005658 /* Loop as long as no application data record is available */
Gilles Peskine449bd832023-01-11 14:50:10 +01005659 while (ssl->in_offt == NULL) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005660 /* Start timer if not already running */
Gilles Peskine449bd832023-01-11 14:50:10 +01005661 if (ssl->f_get_timer != NULL &&
5662 ssl->f_get_timer(ssl->p_timer) == -1) {
5663 mbedtls_ssl_set_timer(ssl, ssl->conf->read_timeout);
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005664 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005665
Gilles Peskine449bd832023-01-11 14:50:10 +01005666 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5667 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5668 return 0;
5669 }
Paul Bakker831a7552011-05-18 13:32:51 +00005670
Gilles Peskine449bd832023-01-11 14:50:10 +01005671 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5672 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005673 }
5674
Gilles Peskine449bd832023-01-11 14:50:10 +01005675 if (ssl->in_msglen == 0 &&
5676 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Paul Bakker5121ce52009-01-03 21:22:43 +00005677 /*
5678 * OpenSSL sends empty messages to randomize the IV
5679 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005680 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5681 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5682 return 0;
5683 }
Paul Bakker831a7552011-05-18 13:32:51 +00005684
Gilles Peskine449bd832023-01-11 14:50:10 +01005685 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5686 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005687 }
5688 }
5689
Gilles Peskine449bd832023-01-11 14:50:10 +01005690 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
5691 ret = ssl_handle_hs_message_post_handshake(ssl);
5692 if (ret != 0) {
5693 MBEDTLS_SSL_DEBUG_RET(1, "ssl_handle_hs_message_post_handshake",
5694 ret);
5695 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00005696 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005697
Hanno Beckerf26cc722021-04-21 07:30:13 +01005698 /* At this point, we don't know whether the renegotiation triggered
5699 * by the post-handshake message has been completed or not. The cases
5700 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005701 * 1) The renegotiation is complete. In this case, no new record
5702 * has been read yet.
5703 * 2) The renegotiation is incomplete because the client received
5704 * an application data record while awaiting the ServerHello.
5705 * 3) The renegotiation is incomplete because the client received
5706 * a non-handshake, non-application data message while awaiting
5707 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005708 *
5709 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005710 * - For 1), the next iteration will read a new record and check
5711 * if it's application data.
5712 * - For 2), the loop condition isn't satisfied as application data
5713 * is present, hence continue is the same as break
5714 * - For 3), the loop condition is satisfied and read_record
5715 * will re-deliver the message that was held back by the client
5716 * when expecting the ServerHello.
5717 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005718
Hanno Becker90333da2017-10-10 11:27:13 +01005719 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005720 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005721#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005722 else if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5723 if (ssl->conf->renego_max_records >= 0) {
5724 if (++ssl->renego_records_seen > ssl->conf->renego_max_records) {
5725 MBEDTLS_SSL_DEBUG_MSG(1, ("renegotiation requested, "
5726 "but not honored by client"));
5727 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005728 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005729 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005730 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005731#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005732
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005733 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
Gilles Peskine449bd832023-01-11 14:50:10 +01005734 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5735 MBEDTLS_SSL_DEBUG_MSG(2, ("ignoring non-fatal non-closure alert"));
5736 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005737 }
5738
Gilles Peskine449bd832023-01-11 14:50:10 +01005739 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
5740 MBEDTLS_SSL_DEBUG_MSG(1, ("bad application data message"));
5741 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005742 }
5743
5744 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005745
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005746 /* We're going to return something now, cancel timer,
5747 * except if handshake (renegotiation) is in progress */
Gilles Peskine449bd832023-01-11 14:50:10 +01005748 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5749 mbedtls_ssl_set_timer(ssl, 0);
5750 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005751
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005752#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005753 /* If we requested renego but received AppData, resend HelloRequest.
5754 * Do it now, after setting in_offt, to avoid taking this branch
5755 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005756#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005757 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5758 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5759 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
5760 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
5761 ret);
5762 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005763 }
5764 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005765#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005766#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005767 }
5768
Jerry Yu739a1d42022-12-08 21:10:25 +08005769 ret = ssl_read_application_data(ssl, buf, len);
Paul Bakker5121ce52009-01-03 21:22:43 +00005770
Gilles Peskine449bd832023-01-11 14:50:10 +01005771 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005772
Jerry Yu739a1d42022-12-08 21:10:25 +08005773 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005774}
5775
Jerry Yud9ca3542023-12-06 17:23:52 +08005776#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA)
5777int mbedtls_ssl_read_early_data(mbedtls_ssl_context *ssl,
5778 unsigned char *buf, size_t len)
5779{
Ronald Croned7d4bf2024-01-31 07:55:19 +01005780 if (ssl == NULL || (ssl->conf == NULL)) {
Jerry Yud9ca3542023-12-06 17:23:52 +08005781 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5782 }
5783
Ronald Cron164537c2024-02-01 18:05:47 +01005784 /*
5785 * The server may receive early data only while waiting for the End of
5786 * Early Data handshake message.
5787 */
Ronald Croned7d4bf2024-01-31 07:55:19 +01005788 if ((ssl->state != MBEDTLS_SSL_END_OF_EARLY_DATA) ||
5789 (ssl->in_offt == NULL)) {
Jerry Yud9ca3542023-12-06 17:23:52 +08005790 return MBEDTLS_ERR_SSL_CANNOT_READ_EARLY_DATA;
5791 }
5792
Ronald Croned7d4bf2024-01-31 07:55:19 +01005793 return ssl_read_application_data(ssl, buf, len);
Jerry Yud9ca3542023-12-06 17:23:52 +08005794}
5795#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA */
5796
Paul Bakker5121ce52009-01-03 21:22:43 +00005797/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005798 * Send application data to be encrypted by the SSL layer, taking care of max
5799 * fragment length and buffer size.
5800 *
5801 * According to RFC 5246 Section 6.2.1:
5802 *
5803 * Zero-length fragments of Application data MAY be sent as they are
5804 * potentially useful as a traffic analysis countermeasure.
5805 *
5806 * Therefore, it is possible that the input message length is 0 and the
5807 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005808 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005809MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005810static int ssl_write_real(mbedtls_ssl_context *ssl,
5811 const unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005812{
Gilles Peskine449bd832023-01-11 14:50:10 +01005813 int ret = mbedtls_ssl_get_max_out_record_payload(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005814 const size_t max_len = (size_t) ret;
5815
Gilles Peskine449bd832023-01-11 14:50:10 +01005816 if (ret < 0) {
5817 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_get_max_out_record_payload", ret);
5818 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005819 }
5820
Gilles Peskine449bd832023-01-11 14:50:10 +01005821 if (len > max_len) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005822#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005823 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5824 MBEDTLS_SSL_DEBUG_MSG(1, ("fragment larger than the (negotiated) "
5825 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5826 " > %" MBEDTLS_PRINTF_SIZET,
5827 len, max_len));
5828 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5829 } else
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005830#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005831 len = max_len;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005832 }
Paul Bakker887bd502011-06-08 13:10:54 +00005833
Gilles Peskine449bd832023-01-11 14:50:10 +01005834 if (ssl->out_left != 0) {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005835 /*
5836 * The user has previously tried to send the data and
5837 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5838 * written. In this case, we expect the high-level write function
5839 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5840 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005841 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5842 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
5843 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005844 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005845 } else {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005846 /*
5847 * The user is trying to send a message the first time, so we need to
5848 * copy the data into the internal buffers and setup the data structure
5849 * to keep track of partial writes
5850 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005851 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005852 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Dave Rodgmanf6840252023-02-24 15:41:34 +00005853 if (len > 0) {
5854 memcpy(ssl->out_msg, buf, len);
5855 }
Paul Bakker887bd502011-06-08 13:10:54 +00005856
Gilles Peskine449bd832023-01-11 14:50:10 +01005857 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5858 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5859 return ret;
Paul Bakker887bd502011-06-08 13:10:54 +00005860 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005861 }
5862
Gilles Peskine449bd832023-01-11 14:50:10 +01005863 return (int) len;
Paul Bakker5121ce52009-01-03 21:22:43 +00005864}
5865
5866/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005867 * Write application data (public-facing wrapper)
5868 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005869int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005870{
Janos Follath865b3eb2019-12-16 11:46:15 +00005871 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005872
Gilles Peskine449bd832023-01-11 14:50:10 +01005873 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005874
Gilles Peskine449bd832023-01-11 14:50:10 +01005875 if (ssl == NULL || ssl->conf == NULL) {
5876 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5877 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005878
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005879#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005880 if ((ret = ssl_check_ctr_renegotiate(ssl)) != 0) {
5881 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5882 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005883 }
5884#endif
5885
Gilles Peskine449bd832023-01-11 14:50:10 +01005886 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5887 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
5888 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5889 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005890 }
5891 }
5892
Gilles Peskine449bd832023-01-11 14:50:10 +01005893 ret = ssl_write_real(ssl, buf, len);
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005894
Gilles Peskine449bd832023-01-11 14:50:10 +01005895 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005896
Gilles Peskine449bd832023-01-11 14:50:10 +01005897 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005898}
5899
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005900#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_CLI_C)
5901int mbedtls_ssl_write_early_data(mbedtls_ssl_context *ssl,
5902 const unsigned char *buf, size_t len)
5903{
5904 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5905 const struct mbedtls_ssl_config *conf;
Ronald Cron62f971a2024-02-23 08:24:12 +01005906 uint32_t remaining;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005907
5908 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write early_data"));
5909
5910 if (ssl == NULL || (conf = ssl->conf) == NULL) {
5911 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5912 }
5913
Ronald Cron49221902024-02-21 13:39:14 +01005914 if (conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
5915 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5916 }
5917
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005918 if ((!mbedtls_ssl_conf_is_tls13_enabled(conf)) ||
5919 (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) ||
5920 (conf->early_data_enabled != MBEDTLS_SSL_EARLY_DATA_ENABLED)) {
5921 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5922 }
5923
5924 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_3) {
5925 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5926 }
5927
5928 /*
Ronald Crond2884662024-03-03 15:03:22 +01005929 * If we are at the beginning of the handshake, the early data state being
Ronald Cron05d7cfb2024-03-03 15:39:30 +01005930 * equal to MBEDTLS_SSL_EARLY_DATA_STATE_IDLE or
Ronald Cron3641df22024-03-03 16:10:58 +01005931 * MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT advance the handshake just
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005932 * enough to be able to send early data if possible. That way, we can
5933 * guarantee that when starting the handshake with this function we will
Ronald Crond2884662024-03-03 15:03:22 +01005934 * send at least one record of early data. Note that when the state is
Ronald Cron3641df22024-03-03 16:10:58 +01005935 * MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT and not yet
5936 * MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE, we cannot send early data
Ronald Crond4069242024-02-21 13:45:52 +01005937 * as the early data outbound transform has not been set as we may have to
5938 * first send a dummy CCS in clear.
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005939 */
Ronald Cron05d7cfb2024-03-03 15:39:30 +01005940 if ((ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IDLE) ||
Ronald Cron3641df22024-03-03 16:10:58 +01005941 (ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT)) {
Ronald Cron05d7cfb2024-03-03 15:39:30 +01005942 while ((ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IDLE) ||
Ronald Cron3641df22024-03-03 16:10:58 +01005943 (ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005944 ret = mbedtls_ssl_handshake_step(ssl);
5945 if (ret != 0) {
5946 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake_step", ret);
5947 return ret;
5948 }
5949
5950 ret = mbedtls_ssl_flush_output(ssl);
5951 if (ret != 0) {
5952 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
5953 return ret;
5954 }
5955 }
Ronald Cron62f971a2024-02-23 08:24:12 +01005956 remaining = ssl->session_negotiate->max_early_data_size;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005957 } else {
Ronald Crond4069242024-02-21 13:45:52 +01005958 /*
Ronald Cron62f971a2024-02-23 08:24:12 +01005959 * If we are past the point where we can send early data or we have
Ari Weiler-Ofek67aa9592025-06-10 16:59:44 +01005960 * already reached the maximum early data size, return immediately.
Ronald Cron62f971a2024-02-23 08:24:12 +01005961 * Otherwise, progress the handshake as much as possible to not delay
5962 * it too much. If we reach a point where we can still send early data,
5963 * then we will send some.
Ronald Crond4069242024-02-21 13:45:52 +01005964 */
Ronald Crond2884662024-03-03 15:03:22 +01005965 if ((ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE) &&
5966 (ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_ACCEPTED)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005967 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5968 }
5969
Ronald Cron62f971a2024-02-23 08:24:12 +01005970 remaining = ssl->session_negotiate->max_early_data_size -
Ronald Cronde9b03d2024-03-01 15:14:17 +01005971 ssl->total_early_data_size;
Ronald Cron62f971a2024-02-23 08:24:12 +01005972
5973 if (remaining == 0) {
5974 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5975 }
5976
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005977 ret = mbedtls_ssl_handshake(ssl);
5978 if ((ret != 0) && (ret != MBEDTLS_ERR_SSL_WANT_READ)) {
5979 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5980 return ret;
5981 }
5982 }
5983
Ronald Crond2884662024-03-03 15:03:22 +01005984 if (((ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE) &&
5985 (ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_ACCEPTED))
Ronald Cron62f971a2024-02-23 08:24:12 +01005986 || (remaining == 0)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005987 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5988 }
5989
Ronald Cron62f971a2024-02-23 08:24:12 +01005990 if (len > remaining) {
5991 len = remaining;
5992 }
5993
Ronald Cron5dbfcce2024-02-26 17:50:38 +01005994 ret = ssl_write_real(ssl, buf, len);
5995 if (ret >= 0) {
5996 ssl->total_early_data_size += ret;
5997 }
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005998
Ronald Cron5dbfcce2024-02-26 17:50:38 +01005999 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write early_data, ret=%d", ret));
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006000
Ronald Cron5dbfcce2024-02-26 17:50:38 +01006001 return ret;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006002}
6003#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_CLI_C */
6004
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006005/*
Paul Bakker5121ce52009-01-03 21:22:43 +00006006 * Notify the peer that the connection is being closed
6007 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006008int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00006009{
Janos Follath865b3eb2019-12-16 11:46:15 +00006010 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00006011
Gilles Peskine449bd832023-01-11 14:50:10 +01006012 if (ssl == NULL || ssl->conf == NULL) {
6013 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6014 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02006015
Gilles Peskine449bd832023-01-11 14:50:10 +01006016 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00006017
Gilles Peskine449bd832023-01-11 14:50:10 +01006018 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
6019 if ((ret = mbedtls_ssl_send_alert_message(ssl,
6020 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
6021 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY)) != 0) {
6022 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_send_alert_message", ret);
6023 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00006024 }
6025 }
6026
Gilles Peskine449bd832023-01-11 14:50:10 +01006027 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00006028
Gilles Peskine449bd832023-01-11 14:50:10 +01006029 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00006030}
6031
Gilles Peskine449bd832023-01-11 14:50:10 +01006032void mbedtls_ssl_transform_free(mbedtls_ssl_transform *transform)
Paul Bakker48916f92012-09-16 19:57:18 +00006033{
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 if (transform == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02006035 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006036 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02006037
Gilles Peskine449bd832023-01-11 14:50:10 +01006038 psa_destroy_key(transform->psa_key_enc);
6039 psa_destroy_key(transform->psa_key_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01006040
Hanno Beckerfd86ca82020-11-30 08:54:23 +00006041#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01006042 psa_destroy_key(transform->psa_mac_enc);
6043 psa_destroy_key(transform->psa_mac_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00006044#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02006045
Gilles Peskine449bd832023-01-11 14:50:10 +01006046 mbedtls_platform_zeroize(transform, sizeof(mbedtls_ssl_transform));
Paul Bakker48916f92012-09-16 19:57:18 +00006047}
6048
Gilles Peskine449bd832023-01-11 14:50:10 +01006049void mbedtls_ssl_set_inbound_transform(mbedtls_ssl_context *ssl,
6050 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006051{
Jerry Yuc7875b52021-09-05 21:05:50 +08006052 ssl->transform_in = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006053 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuc7875b52021-09-05 21:05:50 +08006054}
6055
Gilles Peskine449bd832023-01-11 14:50:10 +01006056void mbedtls_ssl_set_outbound_transform(mbedtls_ssl_context *ssl,
6057 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006058{
6059 ssl->transform_out = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006060 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yuc7875b52021-09-05 21:05:50 +08006061}
6062
Hanno Becker0271f962018-08-16 13:23:47 +01006063#if defined(MBEDTLS_SSL_PROTO_DTLS)
6064
Gilles Peskine449bd832023-01-11 14:50:10 +01006065void mbedtls_ssl_buffering_free(mbedtls_ssl_context *ssl)
Hanno Becker0271f962018-08-16 13:23:47 +01006066{
6067 unsigned offset;
6068 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6069
Gilles Peskine449bd832023-01-11 14:50:10 +01006070 if (hs == NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01006071 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 }
Hanno Becker0271f962018-08-16 13:23:47 +01006073
Gilles Peskine449bd832023-01-11 14:50:10 +01006074 ssl_free_buffered_record(ssl);
Hanno Becker283f5ef2018-08-24 09:34:47 +01006075
Gilles Peskine449bd832023-01-11 14:50:10 +01006076 for (offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
6077 ssl_buffering_free_slot(ssl, offset);
6078 }
Hanno Beckere605b192018-08-21 15:59:07 +01006079}
6080
Gilles Peskine449bd832023-01-11 14:50:10 +01006081static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
6082 uint8_t slot)
Hanno Beckere605b192018-08-21 15:59:07 +01006083{
6084 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6085 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01006086
Gilles Peskine449bd832023-01-11 14:50:10 +01006087 if (slot >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Beckerb309b922018-08-23 13:18:05 +01006088 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006089 }
Hanno Beckerb309b922018-08-23 13:18:05 +01006090
Gilles Peskine449bd832023-01-11 14:50:10 +01006091 if (hs_buf->is_valid == 1) {
Hanno Beckere605b192018-08-21 15:59:07 +01006092 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006093 mbedtls_zeroize_and_free(hs_buf->data, hs_buf->data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006094 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Hanno Becker0271f962018-08-16 13:23:47 +01006095 }
6096}
6097
6098#endif /* MBEDTLS_SSL_PROTO_DTLS */
6099
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006100/*
6101 * Convert version numbers to/from wire format
6102 * and, for DTLS, to/from TLS equivalent.
6103 *
6104 * For TLS this is the identity.
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006105 * For DTLS, map as follows, then use 1's complement (v -> ~v):
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006106 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006107 * DTLS 1.0 is stored as TLS 1.1 internally
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006108 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006109void mbedtls_ssl_write_version(unsigned char version[2], int transport,
6110 mbedtls_ssl_protocol_version tls_version)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006111{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006112 uint16_t tls_version_formatted;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006113#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006114 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006115 tls_version_formatted =
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 ~(tls_version - (tls_version == 0x0302 ? 0x0202 : 0x0201));
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006117 } else
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006118#else
6119 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006120#endif
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006121 {
6122 tls_version_formatted = (uint16_t) tls_version;
6123 }
6124 MBEDTLS_PUT_UINT16_BE(tls_version_formatted, version, 0);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006125}
6126
Gilles Peskine449bd832023-01-11 14:50:10 +01006127uint16_t mbedtls_ssl_read_version(const unsigned char version[2],
6128 int transport)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006129{
Gilles Peskine449bd832023-01-11 14:50:10 +01006130 uint16_t tls_version = MBEDTLS_GET_UINT16_BE(version, 0);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006131#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006132 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006133 tls_version =
Gilles Peskine449bd832023-01-11 14:50:10 +01006134 ~(tls_version - (tls_version == 0xfeff ? 0x0202 : 0x0201));
6135 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006136#else
6137 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006138#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006139 return tls_version;
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006140}
6141
Jerry Yue7047812021-09-13 19:26:39 +08006142/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08006143 * Send pending fatal alert.
6144 * 0, No alert message.
6145 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
6146 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08006147 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006148int mbedtls_ssl_handle_pending_alert(mbedtls_ssl_context *ssl)
Jerry Yue7047812021-09-13 19:26:39 +08006149{
6150 int ret;
6151
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006152 /* No pending alert, return success*/
Gilles Peskine449bd832023-01-11 14:50:10 +01006153 if (ssl->send_alert == 0) {
6154 return 0;
6155 }
Jerry Yu394ece62021-09-14 22:17:21 +08006156
Gilles Peskine449bd832023-01-11 14:50:10 +01006157 ret = mbedtls_ssl_send_alert_message(ssl,
6158 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6159 ssl->alert_type);
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006160
Jerry Yu3bf1f972021-09-22 21:37:18 +08006161 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
6162 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006163 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006164 if (ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006165 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08006166 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006167
Gilles Peskine449bd832023-01-11 14:50:10 +01006168 if (ret != 0) {
6169 return ret;
6170 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006171
Gilles Peskine449bd832023-01-11 14:50:10 +01006172 return ssl->alert_reason;
Jerry Yue7047812021-09-13 19:26:39 +08006173}
6174
Jerry Yu394ece62021-09-14 22:17:21 +08006175/*
6176 * Set pending fatal alert flag.
6177 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006178void mbedtls_ssl_pend_fatal_alert(mbedtls_ssl_context *ssl,
6179 unsigned char alert_type,
6180 int alert_reason)
Jerry Yu394ece62021-09-14 22:17:21 +08006181{
6182 ssl->send_alert = 1;
6183 ssl->alert_type = alert_type;
6184 ssl->alert_reason = alert_reason;
6185}
6186
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006187#endif /* MBEDTLS_SSL_TLS_C */