blob: 847b1daf2a6c15200976bf231206d098aad54c76 [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
826 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200827 * for CBC transformations in TLS 1.2. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100828#if !(defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
829 defined(MBEDTLS_SSL_PROTO_TLS1_2))
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000830#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000831
Gilles Peskine449bd832023-01-11 14:50:10 +0100832 MBEDTLS_SSL_DEBUG_MSG(2, ("=> encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +0000833
Gilles Peskine449bd832023-01-11 14:50:10 +0100834 if (transform == NULL) {
835 MBEDTLS_SSL_DEBUG_MSG(1, ("no transform provided to encrypt_buf"));
836 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000837 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100838 if (rec == NULL
Hanno Becker43c24b82019-05-01 09:45:57 +0100839 || rec->buf == NULL
840 || rec->buf_len < rec->data_offset
841 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100842#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100843 || rec->cid_len != 0
844#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100845 ) {
846 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to encrypt_buf"));
847 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100848 }
849
Gilles Peskine449bd832023-01-11 14:50:10 +0100850 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Neil Armstrong136f8402022-03-30 10:58:01 +0200851
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000852 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +0100853 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
854 MBEDTLS_SSL_DEBUG_BUF(4, "before encrypt: output payload",
855 data, rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000856
Gilles Peskine449bd832023-01-11 14:50:10 +0100857 if (rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
858 MBEDTLS_SSL_DEBUG_MSG(1, ("Record content %" MBEDTLS_PRINTF_SIZET
859 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
860 rec->data_len,
861 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
862 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000863 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100864
Hanno Becker92313402020-05-20 13:58:58 +0100865 /* The following two code paths implement the (D)TLSInnerPlaintext
866 * structure present in TLS 1.3 and DTLS 1.2 + CID.
867 *
868 * See ssl_build_inner_plaintext() for more information.
869 *
870 * Note that this changes `rec->data_len`, and hence
871 * `post_avail` needs to be recalculated afterwards.
872 *
873 * Note also that the two code paths cannot occur simultaneously
874 * since they apply to different versions of the protocol. There
875 * is hence no risk of double-addition of the inner plaintext.
876 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100877#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100878 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker13996922020-05-28 16:15:19 +0100879 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +0100880 ssl_compute_padding_length(rec->data_len,
881 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
882 if (ssl_build_inner_plaintext(data,
883 &rec->data_len,
884 post_avail,
885 rec->type,
886 padding) != 0) {
887 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerccc13d02020-05-04 12:30:04 +0100888 }
889
890 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
891 }
Ronald Cron6f135e12021-12-08 16:57:54 +0100892#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +0100893
Hanno Beckera0e20d02019-05-15 14:03:01 +0100894#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +0100895 /*
896 * Add CID information
897 */
898 rec->cid_len = transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100899 memcpy(rec->cid, transform->out_cid, transform->out_cid_len);
900 MBEDTLS_SSL_DEBUG_BUF(3, "CID", rec->cid, rec->cid_len);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100901
Gilles Peskine449bd832023-01-11 14:50:10 +0100902 if (rec->cid_len != 0) {
Hanno Becker13996922020-05-28 16:15:19 +0100903 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +0100904 ssl_compute_padding_length(rec->data_len,
905 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100906 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +0100907 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +0100908 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100909 *
Hanno Becker07dc97d2019-05-20 15:08:01 +0100910 * Note that this changes `rec->data_len`, and hence
911 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100912 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100913 if (ssl_build_inner_plaintext(data,
914 &rec->data_len,
915 post_avail,
916 rec->type,
917 padding) != 0) {
918 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100919 }
920
921 rec->type = MBEDTLS_SSL_MSG_CID;
922 }
Hanno Beckera0e20d02019-05-15 14:03:01 +0100923#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +0100924
Gilles Peskine449bd832023-01-11 14:50:10 +0100925 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100926
Paul Bakker5121ce52009-01-03 21:22:43 +0000927 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100928 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +0000929 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000930#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +0100931 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
932 ssl_mode == MBEDTLS_SSL_MODE_CBC) {
933 if (post_avail < transform->maclen) {
934 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
935 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000936 }
TRodziewicz0f82ec62021-05-12 17:49:18 +0200937#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +0200938 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100939 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstrong26e6d672022-02-23 09:30:33 +0100940 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
941 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
942 size_t sign_mac_length = 0;
Hanno Becker992b6872017-11-09 18:57:39 +0000943
Gilles Peskine449bd832023-01-11 14:50:10 +0100944 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
945 transform->tls_version,
946 transform->taglen);
Hanno Becker992b6872017-11-09 18:57:39 +0000947
Gilles Peskine449bd832023-01-11 14:50:10 +0100948 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
949 transform->psa_mac_alg);
950 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100951 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100952 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100953
Gilles Peskine449bd832023-01-11 14:50:10 +0100954 status = psa_mac_update(&operation, add_data, add_data_len);
955 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100956 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100957 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100958
Gilles Peskine449bd832023-01-11 14:50:10 +0100959 status = psa_mac_update(&operation, data, rec->data_len);
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 }
Neil Armstrong26e6d672022-02-23 09:30:33 +0100963
Gilles Peskine449bd832023-01-11 14:50:10 +0100964 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
965 &sign_mac_length);
966 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +0100967 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +0100968 }
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000969
Gilles Peskine449bd832023-01-11 14:50:10 +0100970 memcpy(data + rec->data_len, mac, transform->maclen);
Paul Bakkerd2f068e2013-08-27 21:19:20 +0200971#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200972
Gilles Peskine449bd832023-01-11 14:50:10 +0100973 MBEDTLS_SSL_DEBUG_BUF(4, "computed mac", data + rec->data_len,
974 transform->maclen);
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200975
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000976 rec->data_len += transform->maclen;
977 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100978 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100979
Gilles Peskine449bd832023-01-11 14:50:10 +0100980hmac_failed_etm_disabled:
981 mbedtls_platform_zeroize(mac, transform->maclen);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500982 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 status = psa_mac_abort(&operation);
984 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -0500985 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +0100986 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100987 if (ret != 0) {
988 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_hmac_xxx", ret);
989 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +0100990 }
Paul Bakker577e0062013-08-28 11:57:20 +0200991 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000992#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000993
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +0200994 /*
995 * Encrypt
996 */
Hanno Beckerd086bf02021-03-22 13:01:27 +0000997#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
999 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1000 "including %d bytes of padding",
1001 rec->data_len, 0));
Paul Bakker5121ce52009-01-03 21:22:43 +00001002
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001003 /* The only supported stream cipher is "NULL",
1004 * so there's nothing to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001005 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001006#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001007
Valerio Settie5707042023-10-11 11:54:42 +02001008#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01001009 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001010 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001011 unsigned char *dynamic_iv;
1012 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +01001013 int dynamic_iv_is_explicit =
Gilles Peskine449bd832023-01-11 14:50:10 +01001014 ssl_transform_aead_dynamic_iv_is_explicit(transform);
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001015 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001016 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001017
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +01001018 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001019 if (post_avail < transform->taglen) {
1020 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1021 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001022 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001023
Paul Bakker68884e32013-01-07 18:20:04 +01001024 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001025 * Build nonce for AEAD encryption.
1026 *
1027 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1028 * part of the IV is prepended to the ciphertext and
1029 * can be chosen freely - in particular, it need not
1030 * agree with the record sequence number.
1031 * However, since ChaChaPoly as well as all AEAD modes
1032 * in TLS 1.3 use the record sequence number as the
1033 * dynamic part of the nonce, we uniformly use the
1034 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +01001035 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001036 dynamic_iv = rec->ctr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 dynamic_iv_len = sizeof(rec->ctr);
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001038
Gilles Peskine449bd832023-01-11 14:50:10 +01001039 ssl_build_record_nonce(iv, sizeof(iv),
1040 transform->iv_enc,
1041 transform->fixed_ivlen,
1042 dynamic_iv,
1043 dynamic_iv_len);
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +01001044
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001045 /*
1046 * Build additional data for AEAD encryption.
1047 * This depends on the TLS version.
1048 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001049 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1050 transform->tls_version,
1051 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001052
Gilles Peskine449bd832023-01-11 14:50:10 +01001053 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (internal)",
1054 iv, transform->ivlen);
1055 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (transmitted)",
1056 dynamic_iv,
1057 dynamic_iv_is_explicit ? dynamic_iv_len : 0);
1058 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1059 add_data, add_data_len);
1060 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1061 "including 0 bytes of padding",
1062 rec->data_len));
Paul Bakkerca4ab492012-04-18 14:23:57 +00001063
Paul Bakker68884e32013-01-07 18:20:04 +01001064 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001065 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001066 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001067 status = psa_aead_encrypt(transform->psa_key_enc,
1068 transform->psa_alg,
1069 iv, transform->ivlen,
1070 add_data, add_data_len,
1071 data, rec->data_len,
1072 data, rec->buf_len - (data - rec->buf),
1073 &rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001074
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001076 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001077 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_encrypt_buf", ret);
1078 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001079 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001080
Gilles Peskine449bd832023-01-11 14:50:10 +01001081 MBEDTLS_SSL_DEBUG_BUF(4, "after encrypt: tag",
1082 data + rec->data_len - transform->taglen,
1083 transform->taglen);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001084 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001085 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001086
1087 /*
1088 * Prefix record content with dynamic IV in case it is explicit.
1089 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 if (dynamic_iv_is_explicit != 0) {
1091 if (rec->data_offset < dynamic_iv_len) {
1092 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1093 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001094 }
1095
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 memcpy(data - dynamic_iv_len, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001097 rec->data_offset -= dynamic_iv_len;
1098 rec->data_len += dynamic_iv_len;
1099 }
1100
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001101 auth_done++;
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 } else
Valerio Settie5707042023-10-11 11:54:42 +02001103#endif /* MBEDTLS_SSL_HAVE_AEAD */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001104#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1106 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00001107 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001108 size_t padlen, i;
1109 size_t olen;
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001110 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001111 size_t part_len;
1112 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001113
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001114 /* Currently we're always using minimal padding
1115 * (up to 255 bytes would be allowed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001116 padlen = transform->ivlen - (rec->data_len + 1) % transform->ivlen;
1117 if (padlen == transform->ivlen) {
Paul Bakker5121ce52009-01-03 21:22:43 +00001118 padlen = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001119 }
1120
Gilles Peskine449bd832023-01-11 14:50:10 +01001121 /* Check there's enough space in the buffer for the padding. */
1122 if (post_avail < padlen + 1) {
1123 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1124 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1125 }
1126
1127 for (i = 0; i <= padlen; i++) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001128 data[rec->data_len + i] = (unsigned char) padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001130
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001131 rec->data_len += padlen + 1;
1132 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001133
TRodziewicz0f82ec62021-05-12 17:49:18 +02001134#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001135 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +02001136 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +00001137 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001138 */
TRodziewicz345165c2021-07-06 13:42:11 +02001139
Gilles Peskine449bd832023-01-11 14:50:10 +01001140 if (rec->data_offset < transform->ivlen) {
1141 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1142 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
TRodziewicz345165c2021-07-06 13:42:11 +02001143 }
1144
1145 /*
1146 * Generate IV
1147 */
Ben Taylor602b2962025-03-07 15:52:50 +00001148 ret = psa_generate_random(transform->iv_enc, transform->ivlen);
Gilles Peskine449bd832023-01-11 14:50:10 +01001149 if (ret != 0) {
1150 return ret;
1151 }
TRodziewicz345165c2021-07-06 13:42:11 +02001152
Gilles Peskine449bd832023-01-11 14:50:10 +01001153 memcpy(data - transform->ivlen, transform->iv_enc, transform->ivlen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001154#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001155
Gilles Peskine449bd832023-01-11 14:50:10 +01001156 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1157 "including %"
1158 MBEDTLS_PRINTF_SIZET
1159 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
1160 rec->data_len, transform->ivlen,
1161 padlen + 1));
Paul Bakker5121ce52009-01-03 21:22:43 +00001162
Gilles Peskine449bd832023-01-11 14:50:10 +01001163 status = psa_cipher_encrypt_setup(&cipher_op,
1164 transform->psa_key_enc, transform->psa_alg);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001165
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001167 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001168 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_encrypt_setup", ret);
1169 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001170 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001171
Gilles Peskine449bd832023-01-11 14:50:10 +01001172 status = psa_cipher_set_iv(&cipher_op, transform->iv_enc, transform->ivlen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001173
Gilles Peskine449bd832023-01-11 14:50:10 +01001174 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001175 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001176 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1177 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001178
1179 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001180
Gilles Peskine449bd832023-01-11 14:50:10 +01001181 status = psa_cipher_update(&cipher_op,
1182 data, rec->data_len,
1183 data, rec->data_len, &olen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001184
Gilles Peskine449bd832023-01-11 14:50:10 +01001185 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001186 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001187 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1188 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001189
1190 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001191
Gilles Peskine449bd832023-01-11 14:50:10 +01001192 status = psa_cipher_finish(&cipher_op,
1193 data + olen, rec->data_len - olen,
1194 &part_len);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001195
Gilles Peskine449bd832023-01-11 14:50:10 +01001196 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001197 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001198 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1199 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001200
1201 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001202
1203 olen += part_len;
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001204
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 if (rec->data_len != olen) {
1206 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1207 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001208 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001209
TRodziewicz0f82ec62021-05-12 17:49:18 +02001210 data -= transform->ivlen;
1211 rec->data_offset -= transform->ivlen;
1212 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001213
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001214#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001215 if (auth_done == 0) {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001216 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001217 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1218 size_t sign_mac_length = 0;
Hanno Becker3d8c9072018-01-05 16:24:22 +00001219
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001220 /* MAC(MAC_write_key, add_data, IV, ENC(content + padding + padding_length))
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001221 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001222
Gilles Peskine449bd832023-01-11 14:50:10 +01001223 if (post_avail < transform->maclen) {
1224 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1225 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001226 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001227
Gilles Peskine449bd832023-01-11 14:50:10 +01001228 ssl_extract_add_data_from_record(add_data, &add_data_len,
1229 rec, transform->tls_version,
1230 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001231
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
1233 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1234 add_data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001235 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1236 transform->psa_mac_alg);
1237 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001238 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001239 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001240
Gilles Peskine449bd832023-01-11 14:50:10 +01001241 status = psa_mac_update(&operation, add_data, add_data_len);
1242 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001243 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001245
Gilles Peskine449bd832023-01-11 14:50:10 +01001246 status = psa_mac_update(&operation, data, rec->data_len);
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 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001250
Gilles Peskine449bd832023-01-11 14:50:10 +01001251 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1252 &sign_mac_length);
1253 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001254 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001255 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001256
Gilles Peskine449bd832023-01-11 14:50:10 +01001257 memcpy(data + rec->data_len, mac, transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001258
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001259 rec->data_len += transform->maclen;
1260 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001261 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001262
Gilles Peskine449bd832023-01-11 14:50:10 +01001263hmac_failed_etm_enabled:
1264 mbedtls_platform_zeroize(mac, transform->maclen);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001265 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001266 status = psa_mac_abort(&operation);
1267 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001268 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001269 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001270 if (ret != 0) {
1271 MBEDTLS_SSL_DEBUG_RET(1, "HMAC calculation failed", ret);
1272 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001273 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001274 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001275#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01001276 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001277#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001278 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001279 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1280 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001281 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001282
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001283 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01001284 if (auth_done != 1) {
1285 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1286 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001287 }
1288
Gilles Peskine449bd832023-01-11 14:50:10 +01001289 MBEDTLS_SSL_DEBUG_MSG(2, ("<= encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001290
Gilles Peskine449bd832023-01-11 14:50:10 +01001291 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001292}
1293
Gilles Peskine449bd832023-01-11 14:50:10 +01001294int mbedtls_ssl_decrypt_buf(mbedtls_ssl_context const *ssl,
1295 mbedtls_ssl_transform *transform,
1296 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00001297{
Valerio Settie5707042023-10-11 11:54:42 +02001298#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) || defined(MBEDTLS_SSL_HAVE_AEAD)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001299 size_t olen;
Valerio Settie5707042023-10-11 11:54:42 +02001300#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC || MBEDTLS_SSL_HAVE_AEAD */
Neil Armstrong136f8402022-03-30 10:58:01 +02001301 mbedtls_ssl_mode_t ssl_mode;
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001302 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001303
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001304 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001305#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001306 size_t padlen = 0;
1307 mbedtls_ct_condition_t correct = MBEDTLS_CT_TRUE;
Paul Bakker1e5369c2013-12-19 16:40:57 +01001308#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001309 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001310 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 * the description of ssl_extract_add_data_from_record().
1312 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001313#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1314 unsigned char add_data[23 + MBEDTLS_SSL_CID_IN_LEN_MAX];
1315#else
1316 unsigned char add_data[13];
1317#endif
Hanno Beckercab87e62019-04-29 13:52:53 +01001318 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001319
Hanno Beckera18d1322018-01-03 14:27:32 +00001320#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001321 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001322 ((void) ssl);
1323#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001324
Gilles Peskine449bd832023-01-11 14:50:10 +01001325 MBEDTLS_SSL_DEBUG_MSG(2, ("=> decrypt buf"));
1326 if (rec == NULL ||
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001327 rec->buf == NULL ||
1328 rec->buf_len < rec->data_offset ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001329 rec->buf_len - rec->data_offset < rec->data_len) {
1330 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to decrypt_buf"));
1331 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001332 }
1333
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001334 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Paul Bakker5121ce52009-01-03 21:22:43 +00001336
Hanno Beckera0e20d02019-05-15 14:03:01 +01001337#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001338 /*
1339 * Match record's CID with incoming CID.
1340 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001341 if (rec->cid_len != transform->in_cid_len ||
1342 memcmp(rec->cid, transform->in_cid, rec->cid_len) != 0) {
1343 return MBEDTLS_ERR_SSL_UNEXPECTED_CID;
Hanno Becker938489a2019-05-08 13:02:22 +01001344 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001345#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001346
Hanno Beckerd086bf02021-03-22 13:01:27 +00001347#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001348 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001349 if (rec->data_len < transform->maclen) {
1350 MBEDTLS_SSL_DEBUG_MSG(1,
1351 ("Record too short for MAC:"
1352 " %" MBEDTLS_PRINTF_SIZET " < %" MBEDTLS_PRINTF_SIZET,
1353 rec->data_len, transform->maclen));
1354 return MBEDTLS_ERR_SSL_INVALID_MAC;
1355 }
1356
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001357 /* The only supported stream cipher is "NULL",
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001358 * so there's no encryption to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001359 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001360#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Valerio Settie5707042023-10-11 11:54:42 +02001361#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01001362 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001363 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001364 unsigned char *dynamic_iv;
1365 size_t dynamic_iv_len;
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001366 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001367
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001368 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001369 * Extract dynamic part of nonce for AEAD decryption.
1370 *
1371 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1372 * part of the IV is prepended to the ciphertext and
1373 * can be chosen freely - in particular, it need not
1374 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001375 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001376 dynamic_iv_len = sizeof(rec->ctr);
1377 if (ssl_transform_aead_dynamic_iv_is_explicit(transform) == 1) {
1378 if (rec->data_len < dynamic_iv_len) {
1379 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1380 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
1381 rec->data_len,
1382 dynamic_iv_len));
1383 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001384 }
1385 dynamic_iv = data;
1386
1387 data += dynamic_iv_len;
1388 rec->data_offset += dynamic_iv_len;
1389 rec->data_len -= dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001390 } else {
Hanno Becker17263802020-05-28 07:05:48 +01001391 dynamic_iv = rec->ctr;
1392 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001393
1394 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001395 if (rec->data_len < transform->taglen) {
1396 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1397 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
1398 rec->data_len,
1399 transform->taglen));
1400 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001401 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001402 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001403
Hanno Beckerdf8be222020-05-21 15:30:57 +01001404 /*
1405 * Prepare nonce from dynamic and static parts.
1406 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001407 ssl_build_record_nonce(iv, sizeof(iv),
1408 transform->iv_dec,
1409 transform->fixed_ivlen,
1410 dynamic_iv,
1411 dynamic_iv_len);
Paul Bakker68884e32013-01-07 18:20:04 +01001412
Hanno Beckerdf8be222020-05-21 15:30:57 +01001413 /*
1414 * Build additional data for AEAD encryption.
1415 * This depends on the TLS version.
1416 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001417 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1418 transform->tls_version,
1419 transform->taglen);
1420 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1421 add_data, add_data_len);
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001422
Hanno Beckerd96a6522019-07-10 13:55:25 +01001423 /* Because of the check above, we know that there are
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001424 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001425 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001426 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001427 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001428
Gilles Peskine449bd832023-01-11 14:50:10 +01001429 MBEDTLS_SSL_DEBUG_BUF(4, "IV used", iv, transform->ivlen);
1430 MBEDTLS_SSL_DEBUG_BUF(4, "TAG used", data + rec->data_len,
1431 transform->taglen);
Paul Bakker68884e32013-01-07 18:20:04 +01001432
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001433 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001434 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001435 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001436 status = psa_aead_decrypt(transform->psa_key_dec,
1437 transform->psa_alg,
1438 iv, transform->ivlen,
1439 add_data, add_data_len,
1440 data, rec->data_len + transform->taglen,
1441 data, rec->buf_len - (data - rec->buf),
1442 &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001443
Gilles Peskine449bd832023-01-11 14:50:10 +01001444 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001445 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001446 MBEDTLS_SSL_DEBUG_RET(1, "psa_aead_decrypt", ret);
1447 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001448 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001449
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001450 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001451
Hanno Beckerd96a6522019-07-10 13:55:25 +01001452 /* Double-check that AEAD decryption doesn't change content length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 if (olen != rec->data_len) {
1454 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1455 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001456 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001457 } else
Valerio Settie5707042023-10-11 11:54:42 +02001458#endif /* MBEDTLS_SSL_HAVE_AEAD */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001459#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001460 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1461 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001462 size_t minlen = 0;
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001463 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001464 size_t part_len;
1465 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001466
Paul Bakker5121ce52009-01-03 21:22:43 +00001467 /*
Paul Bakker45829992013-01-03 14:52:21 +01001468 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001469 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001470#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001471 /* The ciphertext is prefixed with the CBC IV. */
1472 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001473#endif
Paul Bakker45829992013-01-03 14:52:21 +01001474
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001475 /* Size considerations:
1476 *
1477 * - The CBC cipher text must not be empty and hence
1478 * at least of size transform->ivlen.
1479 *
1480 * Together with the potential IV-prefix, this explains
1481 * the first of the two checks below.
1482 *
1483 * - The record must contain a MAC, either in plain or
1484 * encrypted, depending on whether Encrypt-then-MAC
1485 * is used or not.
1486 * - If it is, the message contains the IV-prefix,
1487 * the CBC ciphertext, and the MAC.
1488 * - If it is not, the padded plaintext, and hence
1489 * the CBC ciphertext, has at least length maclen + 1
1490 * because there is at least the padding length byte.
1491 *
1492 * As the CBC ciphertext is not empty, both cases give the
1493 * lower bound minlen + maclen + 1 on the record size, which
1494 * we test for in the second check below.
1495 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001496 if (rec->data_len < minlen + transform->ivlen ||
1497 rec->data_len < minlen + transform->maclen + 1) {
1498 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1499 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1500 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
1501 "+ 1 ) ( + expl IV )",
1502 rec->data_len,
1503 transform->ivlen,
1504 transform->maclen));
1505 return MBEDTLS_ERR_SSL_INVALID_MAC;
Paul Bakker45829992013-01-03 14:52:21 +01001506 }
1507
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001508 /*
1509 * Authenticate before decrypt if enabled
1510 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001511#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001512 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001513 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001514
Gilles Peskine449bd832023-01-11 14:50:10 +01001515 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001516
Hanno Beckerd96a6522019-07-10 13:55:25 +01001517 /* Update data_len in tandem with add_data.
1518 *
1519 * The subtraction is safe because of the previous check
1520 * data_len >= minlen + maclen + 1.
1521 *
1522 * Afterwards, we know that data + data_len is followed by at
1523 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001524 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001525 *
1526 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001527 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001528 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1529 transform->tls_version,
1530 transform->taglen);
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001531
Hanno Beckerd96a6522019-07-10 13:55:25 +01001532 /* Calculate expected MAC. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001533 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1534 add_data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001535 status = psa_mac_verify_setup(&operation, transform->psa_mac_dec,
1536 transform->psa_mac_alg);
1537 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001538 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001539 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001540
Gilles Peskine449bd832023-01-11 14:50:10 +01001541 status = psa_mac_update(&operation, add_data, add_data_len);
1542 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001543 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001544 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001545
Gilles Peskine449bd832023-01-11 14:50:10 +01001546 status = psa_mac_update(&operation, data, rec->data_len);
1547 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001548 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001549 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001550
1551 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001552 status = psa_mac_verify_finish(&operation, data + rec->data_len,
1553 transform->maclen);
1554 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001555 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001557 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001558
Gilles Peskine449bd832023-01-11 14:50:10 +01001559hmac_failed_etm_enabled:
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001560 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001561 status = psa_mac_abort(&operation);
1562 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001563 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001564 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001565 if (ret != 0) {
1566 if (ret != MBEDTLS_ERR_SSL_INVALID_MAC) {
1567 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_hmac_xxx", ret);
1568 }
1569 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001570 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001571 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001572#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001573
1574 /*
1575 * Check length sanity
1576 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001577
1578 /* We know from above that data_len > minlen >= 0,
1579 * so the following check in particular implies that
1580 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001581 if (rec->data_len % transform->ivlen != 0) {
1582 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1583 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
1584 rec->data_len, transform->ivlen));
1585 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001586 }
1587
TRodziewicz0f82ec62021-05-12 17:49:18 +02001588#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001589 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001590 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001591 */
TRodziewicz345165c2021-07-06 13:42:11 +02001592 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001593 memcpy(transform->iv_dec, data, transform->ivlen);
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001594
TRodziewicz345165c2021-07-06 13:42:11 +02001595 data += transform->ivlen;
1596 rec->data_offset += transform->ivlen;
1597 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001598#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001599
Hanno Beckerd96a6522019-07-10 13:55:25 +01001600 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1601
Gilles Peskine449bd832023-01-11 14:50:10 +01001602 status = psa_cipher_decrypt_setup(&cipher_op,
1603 transform->psa_key_dec, transform->psa_alg);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001604
Gilles Peskine449bd832023-01-11 14:50:10 +01001605 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001606 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001607 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_decrypt_setup", ret);
1608 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001609 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001610
Gilles Peskine449bd832023-01-11 14:50:10 +01001611 status = psa_cipher_set_iv(&cipher_op, transform->iv_dec, transform->ivlen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001612
Gilles Peskine449bd832023-01-11 14:50:10 +01001613 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001614 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001615 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1616 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001617 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001618
Gilles Peskine449bd832023-01-11 14:50:10 +01001619 status = psa_cipher_update(&cipher_op,
1620 data, rec->data_len,
1621 data, rec->data_len, &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001622
Gilles Peskine449bd832023-01-11 14:50:10 +01001623 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001624 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001625 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1626 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001627 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001628
Gilles Peskine449bd832023-01-11 14:50:10 +01001629 status = psa_cipher_finish(&cipher_op,
1630 data + olen, rec->data_len - olen,
1631 &part_len);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001632
Gilles Peskine449bd832023-01-11 14:50:10 +01001633 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001634 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001635 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1636 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001637 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001638
1639 olen += part_len;
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001640
Hanno Beckerd96a6522019-07-10 13:55:25 +01001641 /* Double-check that length hasn't changed during decryption. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001642 if (rec->data_len != olen) {
1643 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1644 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001645 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001646
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001647 /* Safe since data_len >= minlen + maclen + 1, so after having
1648 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001649 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1650 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001651 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001652
Gilles Peskine449bd832023-01-11 14:50:10 +01001653 if (auth_done == 1) {
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001654 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001655 rec->data_len,
1656 padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001657 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001658 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Gilles Peskine449bd832023-01-11 14:50:10 +01001659 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001660#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001661 if (rec->data_len < transform->maclen + padlen + 1) {
1662 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1663 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1664 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
1665 rec->data_len,
1666 transform->maclen,
1667 padlen + 1));
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001668 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001669#endif
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001670 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001671 rec->data_len,
1672 transform->maclen + padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001673 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001674 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Paul Bakker45829992013-01-03 14:52:21 +01001675 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001676
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001677 padlen++;
1678
1679 /* Regardless of the validity of the padding,
1680 * we have data_len >= padlen here. */
1681
TRodziewicz0f82ec62021-05-12 17:49:18 +02001682#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001683 /* The padding check involves a series of up to 256
Gilles Peskine449bd832023-01-11 14:50:10 +01001684 * consecutive memory reads at the end of the record
1685 * plaintext buffer. In order to hide the length and
1686 * validity of the padding, always perform exactly
1687 * `min(256,plaintext_len)` reads (but take into account
1688 * only the last `padlen` bytes for the padding check). */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001689 size_t pad_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001690 volatile unsigned char * const check = data;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001691
1692 /* Index of first padding byte; it has been ensured above
Gilles Peskine449bd832023-01-11 14:50:10 +01001693 * that the subtraction is safe. */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001694 size_t const padding_idx = rec->data_len - padlen;
1695 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1696 size_t const start_idx = rec->data_len - num_checks;
1697 size_t idx;
1698
Gilles Peskine449bd832023-01-11 14:50:10 +01001699 for (idx = start_idx; idx < rec->data_len; idx++) {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001700 /* pad_count += (idx >= padding_idx) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001701 * (check[idx] == padlen - 1);
1702 */
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001703 const mbedtls_ct_condition_t a = mbedtls_ct_uint_ge(idx, padding_idx);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001704 size_t increment = mbedtls_ct_size_if_else_0(a, 1);
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001705 const mbedtls_ct_condition_t b = mbedtls_ct_uint_eq(check[idx], padlen - 1);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001706 increment = mbedtls_ct_size_if_else_0(b, increment);
Dave Rodgmana81373f2023-05-17 12:36:01 +01001707 pad_count += increment;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001708 }
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001709 correct = mbedtls_ct_bool_and(mbedtls_ct_uint_eq(pad_count, padlen), correct);
Paul Bakkere47b34b2013-02-27 14:48:00 +01001710
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001711#if defined(MBEDTLS_SSL_DEBUG_ALL)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001712 if (padlen > 0 && correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001713 MBEDTLS_SSL_DEBUG_MSG(1, ("bad padding byte detected"));
1714 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001715#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001716 padlen = mbedtls_ct_size_if_else_0(correct, padlen);
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001717
TRodziewicz0f82ec62021-05-12 17:49:18 +02001718#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001719
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001720 /* If the padding was found to be invalid, padlen == 0
1721 * and the subtraction is safe. If the padding was found valid,
1722 * padlen hasn't been changed and the previous assertion
1723 * data_len >= padlen still holds. */
1724 rec->data_len -= padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001725 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001726#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001727 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001728 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1729 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001730 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001731
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001732#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001733 MBEDTLS_SSL_DEBUG_BUF(4, "raw buffer after decryption",
1734 data, rec->data_len);
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001735#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001736
1737 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001738 * Authenticate if not done yet.
1739 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00001740 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001741#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001742 if (auth_done == 0) {
Paul Elliott5260ce22022-05-09 18:15:54 +01001743 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
1744 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01001745
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001746 /* For CBC+MAC, If the initial value of padlen was such that
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001747 * data_len < maclen + padlen + 1, then padlen
1748 * got reset to 1, and the initial check
1749 * data_len >= minlen + maclen + 1
1750 * guarantees that at this point we still
1751 * have at least data_len >= maclen.
1752 *
1753 * If the initial value of padlen was such that
1754 * data_len >= maclen + padlen + 1, then we have
1755 * subtracted either padlen + 1 (if the padding was correct)
1756 * or 0 (if the padding was incorrect) since then,
1757 * hence data_len >= maclen in any case.
Gilles Peskinefaf0b862023-09-18 14:08:11 +02001758 *
1759 * For stream ciphers, we checked above that
1760 * data_len >= maclen.
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001761 */
1762 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001763 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1764 transform->tls_version,
1765 transform->taglen);
Paul Bakker5121ce52009-01-03 21:22:43 +00001766
TRodziewicz0f82ec62021-05-12 17:49:18 +02001767#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001768 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001769 * The next two sizes are the minimum and maximum values of
1770 * data_len over all padlen values.
1771 *
1772 * They're independent of padlen, since we previously did
1773 * data_len -= padlen.
1774 *
1775 * Note that max_len + maclen is never more than the buffer
1776 * length, as we previously did in_msglen -= maclen too.
1777 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001778 const size_t max_len = rec->data_len + padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001779 const size_t min_len = (max_len > 256) ? max_len - 256 : 0;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001780
Gilles Peskine449bd832023-01-11 14:50:10 +01001781 ret = mbedtls_ct_hmac(transform->psa_mac_dec,
1782 transform->psa_mac_alg,
1783 add_data, add_data_len,
1784 data, rec->data_len, min_len, max_len,
1785 mac_expect);
Gilles Peskine449bd832023-01-11 14:50:10 +01001786 if (ret != 0) {
1787 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ct_hmac", ret);
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001788 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001789 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001790
Gilles Peskine449bd832023-01-11 14:50:10 +01001791 mbedtls_ct_memcpy_offset(mac_peer, data,
1792 rec->data_len,
1793 min_len, max_len,
1794 transform->maclen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001795#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001796
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001797#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001798 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect, transform->maclen);
1799 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", mac_peer, transform->maclen);
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02001800#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001801
Gilles Peskine449bd832023-01-11 14:50:10 +01001802 if (mbedtls_ct_memcmp(mac_peer, mac_expect,
1803 transform->maclen) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001804#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001805 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Paul Bakkere47b34b2013-02-27 14:48:00 +01001806#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001807 correct = MBEDTLS_CT_FALSE;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001808 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001809 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001810
Gilles Peskine449bd832023-01-11 14:50:10 +01001811hmac_failed_etm_disabled:
1812 mbedtls_platform_zeroize(mac_peer, transform->maclen);
1813 mbedtls_platform_zeroize(mac_expect, transform->maclen);
1814 if (ret != 0) {
1815 return ret;
1816 }
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001817 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01001818
1819 /*
1820 * Finally check the correct flag
1821 */
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001822 if (correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001823 return MBEDTLS_ERR_SSL_INVALID_MAC;
1824 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001825#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001826
1827 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01001828 if (auth_done != 1) {
1829 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1830 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001831 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001832
Ronald Cron6f135e12021-12-08 16:57:54 +01001833#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001834 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Beckerccc13d02020-05-04 12:30:04 +01001835 /* Remove inner padding and infer true content type. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001836 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
1837 &rec->type);
Hanno Beckerccc13d02020-05-04 12:30:04 +01001838
Gilles Peskine449bd832023-01-11 14:50:10 +01001839 if (ret != 0) {
1840 return MBEDTLS_ERR_SSL_INVALID_RECORD;
1841 }
Hanno Beckerccc13d02020-05-04 12:30:04 +01001842 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001843#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001844
Hanno Beckera0e20d02019-05-15 14:03:01 +01001845#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01001846 if (rec->cid_len != 0) {
1847 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
1848 &rec->type);
1849 if (ret != 0) {
1850 return MBEDTLS_ERR_SSL_INVALID_RECORD;
1851 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001852 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001853#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001854
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 MBEDTLS_SSL_DEBUG_MSG(2, ("<= decrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001856
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001858}
1859
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001860#undef MAC_NONE
1861#undef MAC_PLAINTEXT
1862#undef MAC_CIPHERTEXT
1863
Paul Bakker5121ce52009-01-03 21:22:43 +00001864/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001865 * Fill the input message buffer by appending data to it.
1866 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001867 *
1868 * If we return 0, is it guaranteed that (at least) nb_want bytes are
1869 * available (from this read and/or a previous one). Otherwise, an error code
1870 * is returned (possibly EOF or WANT_READ).
1871 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001872 * With stream transport (TLS) on success ssl->in_left == nb_want, but
1873 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
1874 * since we always read a whole datagram at once.
1875 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001876 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001877 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00001878 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001879int mbedtls_ssl_fetch_input(mbedtls_ssl_context *ssl, size_t nb_want)
Paul Bakker5121ce52009-01-03 21:22:43 +00001880{
Janos Follath865b3eb2019-12-16 11:46:15 +00001881 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00001882 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00001883#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1884 size_t in_buf_len = ssl->in_buf_len;
1885#else
1886 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1887#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001888
Gilles Peskine449bd832023-01-11 14:50:10 +01001889 MBEDTLS_SSL_DEBUG_MSG(2, ("=> fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001890
Gilles Peskine449bd832023-01-11 14:50:10 +01001891 if (ssl->f_recv == NULL && ssl->f_recv_timeout == NULL) {
1892 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
1893 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001894 }
1895
Gilles Peskine449bd832023-01-11 14:50:10 +01001896 if (nb_want > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
1897 MBEDTLS_SSL_DEBUG_MSG(1, ("requesting more data than fits"));
1898 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Paul Bakker1a1fbba2014-04-30 14:38:05 +02001899 }
1900
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001901#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001902 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001903 uint32_t timeout;
1904
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001905 /*
1906 * The point is, we need to always read a full datagram at once, so we
1907 * sometimes read more then requested, and handle the additional data.
1908 * It could be the rest of the current record (while fetching the
1909 * header) and/or some other records in the same datagram.
1910 */
1911
1912 /*
1913 * Move to the next record in the already read datagram if applicable
1914 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001915 if (ssl->next_record_offset != 0) {
1916 if (ssl->in_left < ssl->next_record_offset) {
1917 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1918 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001919 }
1920
1921 ssl->in_left -= ssl->next_record_offset;
1922
Gilles Peskine449bd832023-01-11 14:50:10 +01001923 if (ssl->in_left != 0) {
1924 MBEDTLS_SSL_DEBUG_MSG(2, ("next record in same datagram, offset: %"
1925 MBEDTLS_PRINTF_SIZET,
1926 ssl->next_record_offset));
1927 memmove(ssl->in_hdr,
1928 ssl->in_hdr + ssl->next_record_offset,
1929 ssl->in_left);
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001930 }
1931
1932 ssl->next_record_offset = 0;
1933 }
1934
Gilles Peskine449bd832023-01-11 14:50:10 +01001935 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
1936 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
1937 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001938
1939 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001940 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001941 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001942 if (nb_want <= ssl->in_left) {
1943 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
1944 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02001945 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001946
1947 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01001948 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001949 * are not at the beginning of a new record, the caller did something
1950 * wrong.
1951 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 if (ssl->in_left != 0) {
1953 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1954 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01001955 }
1956
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001957 /*
1958 * Don't even try to read if time's out already.
1959 * This avoids by-passing the timer when repeatedly receiving messages
1960 * that will end up being dropped.
1961 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 if (mbedtls_ssl_check_timer(ssl) != 0) {
1963 MBEDTLS_SSL_DEBUG_MSG(2, ("timer has expired"));
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001964 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 } else {
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00001966 len = in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001967
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001969 timeout = ssl->handshake->retransmit_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 } else {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001971 timeout = ssl->conf->read_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001973
Gilles Peskine449bd832023-01-11 14:50:10 +01001974 MBEDTLS_SSL_DEBUG_MSG(3, ("f_recv_timeout: %lu ms", (unsigned long) timeout));
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001975
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 if (ssl->f_recv_timeout != NULL) {
1977 ret = ssl->f_recv_timeout(ssl->p_bio, ssl->in_hdr, len,
1978 timeout);
1979 } else {
1980 ret = ssl->f_recv(ssl->p_bio, ssl->in_hdr, len);
1981 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001982
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001984
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 if (ret == 0) {
1986 return MBEDTLS_ERR_SSL_CONN_EOF;
1987 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02001988 }
1989
Gilles Peskine449bd832023-01-11 14:50:10 +01001990 if (ret == MBEDTLS_ERR_SSL_TIMEOUT) {
1991 MBEDTLS_SSL_DEBUG_MSG(2, ("timeout"));
1992 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02001993
Gilles Peskine449bd832023-01-11 14:50:10 +01001994 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
1995 if (ssl_double_retransmit_timeout(ssl) != 0) {
1996 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake timeout"));
1997 return MBEDTLS_ERR_SSL_TIMEOUT;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02001998 }
1999
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
2001 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
2002 return ret;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002003 }
2004
Gilles Peskine449bd832023-01-11 14:50:10 +01002005 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002006 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002007#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002008 else if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
2009 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
2010 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
2011 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
2012 ret);
2013 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002014 }
2015
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002017 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002018#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002019 }
2020
Gilles Peskine449bd832023-01-11 14:50:10 +01002021 if (ret < 0) {
2022 return ret;
2023 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002024
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002025 ssl->in_left = ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002026 } else
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002027#endif
2028 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2030 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2031 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002032
Gilles Peskine449bd832023-01-11 14:50:10 +01002033 while (ssl->in_left < nb_want) {
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002034 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002035
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 if (mbedtls_ssl_check_timer(ssl) != 0) {
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002037 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 } else {
2039 if (ssl->f_recv_timeout != NULL) {
2040 ret = ssl->f_recv_timeout(ssl->p_bio,
2041 ssl->in_hdr + ssl->in_left, len,
2042 ssl->conf->read_timeout);
2043 } else {
2044 ret = ssl->f_recv(ssl->p_bio,
2045 ssl->in_hdr + ssl->in_left, len);
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002046 }
2047 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002048
Gilles Peskine449bd832023-01-11 14:50:10 +01002049 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2050 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2051 ssl->in_left, nb_want));
2052 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002053
Gilles Peskine449bd832023-01-11 14:50:10 +01002054 if (ret == 0) {
2055 return MBEDTLS_ERR_SSL_CONN_EOF;
2056 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002057
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 if (ret < 0) {
2059 return ret;
2060 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002061
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002062 if ((size_t) ret > len) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 MBEDTLS_SSL_DEBUG_MSG(1,
2064 ("f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2065 " were requested",
2066 ret, len));
2067 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16035bd15cb2018-02-28 04:30:59 -08002068 }
2069
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002070 ssl->in_left += ret;
2071 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002072 }
2073
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002075
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002077}
2078
2079/*
2080 * Flush any data not yet written
2081 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002082int mbedtls_ssl_flush_output(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002083{
Janos Follath865b3eb2019-12-16 11:46:15 +00002084 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002085 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002086
Gilles Peskine449bd832023-01-11 14:50:10 +01002087 MBEDTLS_SSL_DEBUG_MSG(2, ("=> flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002088
Gilles Peskine449bd832023-01-11 14:50:10 +01002089 if (ssl->f_send == NULL) {
2090 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2091 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002092 }
2093
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002094 /* Avoid incrementing counter if data is flushed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 if (ssl->out_left == 0) {
2096 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
2097 return 0;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002098 }
2099
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 while (ssl->out_left > 0) {
2101 MBEDTLS_SSL_DEBUG_MSG(2, ("message length: %" MBEDTLS_PRINTF_SIZET
2102 ", out_left: %" MBEDTLS_PRINTF_SIZET,
2103 mbedtls_ssl_out_hdr_len(ssl) + ssl->out_msglen, ssl->out_left));
Paul Bakker5121ce52009-01-03 21:22:43 +00002104
Hanno Becker2b1e3542018-08-06 11:19:13 +01002105 buf = ssl->out_hdr - ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 ret = ssl->f_send(ssl->p_bio, buf, ssl->out_left);
Paul Bakker186751d2012-05-08 13:16:14 +00002107
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", ret);
Paul Bakker5121ce52009-01-03 21:22:43 +00002109
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 if (ret <= 0) {
2111 return ret;
2112 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002113
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002114 if ((size_t) ret > ssl->out_left) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002115 MBEDTLS_SSL_DEBUG_MSG(1,
2116 ("f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2117 " bytes were sent",
2118 ret, ssl->out_left));
2119 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16034bbaeb42018-02-22 04:29:04 -08002120 }
2121
Paul Bakker5121ce52009-01-03 21:22:43 +00002122 ssl->out_left -= ret;
2123 }
2124
Hanno Becker2b1e3542018-08-06 11:19:13 +01002125#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002127 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 } else
Hanno Becker2b1e3542018-08-06 11:19:13 +01002129#endif
2130 {
2131 ssl->out_hdr = ssl->out_buf + 8;
2132 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002134
Gilles Peskine449bd832023-01-11 14:50:10 +01002135 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002136
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002138}
2139
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002140/*
2141 * Functions to handle the DTLS retransmission state machine
2142 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002143#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002144/*
2145 * Append current handshake message to current outgoing flight
2146 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002147MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002148static int ssl_flight_append(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002149{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002150 mbedtls_ssl_flight_item *msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_flight_append"));
2152 MBEDTLS_SSL_DEBUG_BUF(4, "message appended to flight",
2153 ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002154
2155 /* Allocate space for current message */
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 if ((msg = mbedtls_calloc(1, sizeof(mbedtls_ssl_flight_item))) == NULL) {
2157 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2158 sizeof(mbedtls_ssl_flight_item)));
2159 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002160 }
2161
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 if ((msg->p = mbedtls_calloc(1, ssl->out_msglen)) == NULL) {
2163 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2164 ssl->out_msglen));
2165 mbedtls_free(msg);
2166 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002167 }
2168
2169 /* Copy current handshake message with headers */
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 memcpy(msg->p, ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002171 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002172 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002173 msg->next = NULL;
2174
2175 /* Append to the current flight */
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 if (ssl->handshake->flight == NULL) {
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002177 ssl->handshake->flight = msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002179 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Gilles Peskine449bd832023-01-11 14:50:10 +01002180 while (cur->next != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002181 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01002182 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002183 cur->next = msg;
2184 }
2185
Gilles Peskine449bd832023-01-11 14:50:10 +01002186 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_flight_append"));
2187 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002188}
2189
2190/*
2191 * Free the current flight of handshake messages
2192 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002193void mbedtls_ssl_flight_free(mbedtls_ssl_flight_item *flight)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002194{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002195 mbedtls_ssl_flight_item *cur = flight;
2196 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002197
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 while (cur != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002199 next = cur->next;
2200
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 mbedtls_free(cur->p);
2202 mbedtls_free(cur);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002203
2204 cur = next;
2205 }
2206}
2207
2208/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002209 * Swap transform_out and out_ctr with the alternative ones
2210 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002211MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002212static int ssl_swap_epochs(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002213{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002214 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002215 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002216
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 if (ssl->transform_out == ssl->handshake->alt_transform_out) {
2218 MBEDTLS_SSL_DEBUG_MSG(3, ("skip swap epochs"));
2219 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002220 }
2221
Gilles Peskine449bd832023-01-11 14:50:10 +01002222 MBEDTLS_SSL_DEBUG_MSG(3, ("swap epochs"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002223
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002224 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002225 tmp_transform = ssl->transform_out;
2226 ssl->transform_out = ssl->handshake->alt_transform_out;
2227 ssl->handshake->alt_transform_out = tmp_transform;
2228
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002229 /* Swap epoch + sequence_number */
Gilles Peskine449bd832023-01-11 14:50:10 +01002230 memcpy(tmp_out_ctr, ssl->cur_out_ctr, sizeof(tmp_out_ctr));
2231 memcpy(ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2232 sizeof(ssl->cur_out_ctr));
2233 memcpy(ssl->handshake->alt_out_ctr, tmp_out_ctr,
2234 sizeof(ssl->handshake->alt_out_ctr));
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002235
2236 /* Adjust to the newly activated transform */
Gilles Peskine449bd832023-01-11 14:50:10 +01002237 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002238
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002240}
2241
2242/*
2243 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002244 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002245int mbedtls_ssl_resend(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002246{
2247 int ret = 0;
2248
Gilles Peskine449bd832023-01-11 14:50:10 +01002249 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002250
Gilles Peskine449bd832023-01-11 14:50:10 +01002251 ret = mbedtls_ssl_flight_transmit(ssl);
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002252
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002254
Gilles Peskine449bd832023-01-11 14:50:10 +01002255 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002256}
2257
2258/*
2259 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002260 *
2261 * Need to remember the current message in case flush_output returns
2262 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002263 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002264 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002265int mbedtls_ssl_flight_transmit(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002266{
Janos Follath865b3eb2019-12-16 11:46:15 +00002267 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002268 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_flight_transmit"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002269
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 if (ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING) {
2271 MBEDTLS_SSL_DEBUG_MSG(2, ("initialise flight transmission"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002272
2273 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002274 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002275 ret = ssl_swap_epochs(ssl);
2276 if (ret != 0) {
2277 return ret;
2278 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002279
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002280 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002281 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002282
Gilles Peskine449bd832023-01-11 14:50:10 +01002283 while (ssl->handshake->cur_msg != NULL) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002284 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002285 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002286
Hanno Beckere1dcb032018-08-17 16:47:58 +01002287 int const is_finished =
Gilles Peskine449bd832023-01-11 14:50:10 +01002288 (cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2289 cur->p[0] == MBEDTLS_SSL_HS_FINISHED);
Hanno Beckere1dcb032018-08-17 16:47:58 +01002290
Ronald Cron00d012f22022-03-08 15:57:12 +01002291 int const force_flush = ssl->disable_datagram_packing == 1 ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002292 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
Hanno Becker04da1892018-08-14 13:22:10 +01002293
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002294 /* Swap epochs before sending Finished: we can't do it after
2295 * sending ChangeCipherSpec, in case write returns WANT_READ.
2296 * Must be done before copying, may change out_msg pointer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002297 if (is_finished && ssl->handshake->cur_msg_p == (cur->p + 12)) {
2298 MBEDTLS_SSL_DEBUG_MSG(2, ("swap epochs to send finished message"));
2299 ret = ssl_swap_epochs(ssl);
2300 if (ret != 0) {
2301 return ret;
2302 }
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002303 }
2304
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 ret = ssl_get_remaining_payload_in_datagram(ssl);
2306 if (ret < 0) {
2307 return ret;
2308 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002309 max_frag_len = (size_t) ret;
2310
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002311 /* CCS is copied as is, while HS messages may need fragmentation */
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 if (cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2313 if (max_frag_len == 0) {
2314 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2315 return ret;
2316 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002317
2318 continue;
2319 }
2320
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 memcpy(ssl->out_msg, cur->p, cur->len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002322 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002323 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002324
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002325 /* Update position inside current message */
2326 ssl->handshake->cur_msg_p += cur->len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002328 const unsigned char * const p = ssl->handshake->cur_msg_p;
2329 const size_t hs_len = cur->len - 12;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002330 const size_t frag_off = (size_t) (p - (cur->p + 12));
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002331 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002332 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002333
Gilles Peskine449bd832023-01-11 14:50:10 +01002334 if ((max_frag_len < 12) || (max_frag_len == 12 && hs_len != 0)) {
2335 if (is_finished) {
2336 ret = ssl_swap_epochs(ssl);
2337 if (ret != 0) {
2338 return ret;
2339 }
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002340 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002341
Gilles Peskine449bd832023-01-11 14:50:10 +01002342 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2343 return ret;
2344 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002345
2346 continue;
2347 }
2348 max_hs_frag_len = max_frag_len - 12;
2349
2350 cur_hs_frag_len = rem_len > max_hs_frag_len ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002351 max_hs_frag_len : rem_len;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002352
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 if (frag_off == 0 && cur_hs_frag_len != hs_len) {
2354 MBEDTLS_SSL_DEBUG_MSG(2, ("fragmenting handshake message (%u > %u)",
2355 (unsigned) cur_hs_frag_len,
2356 (unsigned) max_hs_frag_len));
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002357 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002358
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002359 /* Messages are stored with handshake headers as if not fragmented,
2360 * copy beginning of headers then fill fragmentation fields.
2361 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 memcpy(ssl->out_msg, cur->p, 6);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002363
Gilles Peskine449bd832023-01-11 14:50:10 +01002364 ssl->out_msg[6] = MBEDTLS_BYTE_2(frag_off);
2365 ssl->out_msg[7] = MBEDTLS_BYTE_1(frag_off);
2366 ssl->out_msg[8] = MBEDTLS_BYTE_0(frag_off);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002367
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 ssl->out_msg[9] = MBEDTLS_BYTE_2(cur_hs_frag_len);
2369 ssl->out_msg[10] = MBEDTLS_BYTE_1(cur_hs_frag_len);
2370 ssl->out_msg[11] = MBEDTLS_BYTE_0(cur_hs_frag_len);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002371
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 MBEDTLS_SSL_DEBUG_BUF(3, "handshake header", ssl->out_msg, 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002373
Hanno Becker3f7b9732018-08-28 09:53:25 +01002374 /* Copy the handshake message content and set records fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 memcpy(ssl->out_msg + 12, p, cur_hs_frag_len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002376 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002377 ssl->out_msgtype = cur->type;
2378
2379 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002380 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002381 }
2382
2383 /* If done with the current message move to the next one if any */
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 if (ssl->handshake->cur_msg_p >= cur->p + cur->len) {
2385 if (cur->next != NULL) {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002386 ssl->handshake->cur_msg = cur->next;
2387 ssl->handshake->cur_msg_p = cur->next->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002389 ssl->handshake->cur_msg = NULL;
2390 ssl->handshake->cur_msg_p = NULL;
2391 }
2392 }
2393
2394 /* Actually send the message out */
Gilles Peskine449bd832023-01-11 14:50:10 +01002395 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2396 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
2397 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002398 }
2399 }
2400
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2402 return ret;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002403 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002404
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 /* Update state and set timer */
2406 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
2407 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
2408 } else {
2409 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
2410 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
2411 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002412
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_flight_transmit"));
2414
2415 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002416}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002417
2418/*
2419 * To be called when the last message of an incoming flight is received.
2420 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002421void mbedtls_ssl_recv_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002422{
2423 /* We won't need to resend that one any more */
Gilles Peskine449bd832023-01-11 14:50:10 +01002424 mbedtls_ssl_flight_free(ssl->handshake->flight);
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002425 ssl->handshake->flight = NULL;
2426 ssl->handshake->cur_msg = NULL;
2427
2428 /* The next incoming flight will start with this msg_seq */
2429 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2430
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002431 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002432 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002433
Hanno Becker0271f962018-08-16 13:23:47 +01002434 /* Clear future message buffering structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002435 mbedtls_ssl_buffering_free(ssl);
Hanno Becker0271f962018-08-16 13:23:47 +01002436
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002437 /* Cancel timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002438 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002439
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2441 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002442 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002444 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002445 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002446}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002447
2448/*
2449 * To be called when the last message of an outgoing flight is send.
2450 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002451void mbedtls_ssl_send_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002452{
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 ssl_reset_retransmit_timeout(ssl);
2454 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002455
Gilles Peskine449bd832023-01-11 14:50:10 +01002456 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2457 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002458 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002460 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002461 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002462}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002463#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002464
Paul Bakker5121ce52009-01-03 21:22:43 +00002465/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002466 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002467 */
Dave Rodgmanc37ad442023-11-03 23:36:06 +00002468int mbedtls_ssl_start_handshake_msg(mbedtls_ssl_context *ssl, unsigned char hs_type,
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 unsigned char **buf, size_t *buf_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002470{
2471 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002472 * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002473 * ...
2474 * HandshakeType msg_type;
2475 * uint24 length;
2476 * ...
2477 */
2478 *buf = ssl->out_msg + 4;
2479 *buf_len = MBEDTLS_SSL_OUT_CONTENT_LEN - 4;
2480
2481 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2482 ssl->out_msg[0] = hs_type;
2483
Gilles Peskine449bd832023-01-11 14:50:10 +01002484 return 0;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002485}
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002486
2487/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002488 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002489 *
2490 * - fill in handshake headers
2491 * - update handshake checksum
2492 * - DTLS: save message for resending
2493 * - then pass to the record layer
2494 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002495 * DTLS: except for HelloRequest, messages are only queued, and will only be
2496 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002497 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002498 * Inputs:
2499 * - ssl->out_msglen: 4 + actual handshake message len
2500 * (4 is the size of handshake headers for TLS)
2501 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2502 * - ssl->out_msg + 4: the handshake message body
2503 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002504 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002505 * - ssl->out_msglen: the length of the record contents
2506 * (including handshake headers but excluding record headers)
2507 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002508 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002509int mbedtls_ssl_write_handshake_msg_ext(mbedtls_ssl_context *ssl,
2510 int update_checksum,
2511 int force_flush)
Paul Bakker5121ce52009-01-03 21:22:43 +00002512{
Janos Follath865b3eb2019-12-16 11:46:15 +00002513 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002514 const size_t hs_len = ssl->out_msglen - 4;
2515 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002516
Gilles Peskine449bd832023-01-11 14:50:10 +01002517 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002518
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002519 /*
2520 * Sanity checks
2521 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 if (ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
2523 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2524 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2525 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002526 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002527
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002528 /* Whenever we send anything different from a
2529 * HelloRequest we should be in a handshake - double check. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002530 if (!(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2531 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST) &&
2532 ssl->handshake == NULL) {
2533 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2534 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002535 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002536
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002537#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002538 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002539 ssl->handshake != NULL &&
Gilles Peskine449bd832023-01-11 14:50:10 +01002540 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
2541 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2542 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002543 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002544#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002545
Hanno Beckerb50a2532018-08-06 11:52:54 +01002546 /* Double-check that we did not exceed the bounds
2547 * of the outgoing record buffer.
2548 * This should never fail as the various message
2549 * writing functions must obey the bounds of the
2550 * outgoing record buffer, but better be safe.
2551 *
2552 * Note: We deliberately do not check for the MTU or MFL here.
2553 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 if (ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2555 MBEDTLS_SSL_DEBUG_MSG(1, ("Record too large: "
2556 "size %" MBEDTLS_PRINTF_SIZET
2557 ", maximum %" MBEDTLS_PRINTF_SIZET,
2558 ssl->out_msglen,
2559 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
2560 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerb50a2532018-08-06 11:52:54 +01002561 }
2562
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002563 /*
2564 * Fill handshake headers
2565 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 if (ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
2567 ssl->out_msg[1] = MBEDTLS_BYTE_2(hs_len);
2568 ssl->out_msg[2] = MBEDTLS_BYTE_1(hs_len);
2569 ssl->out_msg[3] = MBEDTLS_BYTE_0(hs_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00002570
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002571 /*
2572 * DTLS has additional fields in the Handshake layer,
2573 * between the length field and the actual payload:
2574 * uint16 message_seq;
2575 * uint24 fragment_offset;
2576 * uint24 fragment_length;
2577 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002578#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002579 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002580 /* Make room for the additional DTLS fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 if (MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8) {
2582 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS handshake message too large: "
2583 "size %" MBEDTLS_PRINTF_SIZET ", maximum %"
2584 MBEDTLS_PRINTF_SIZET,
2585 hs_len,
2586 (size_t) (MBEDTLS_SSL_OUT_CONTENT_LEN - 12)));
2587 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9648f8b2017-09-18 10:55:54 +01002588 }
2589
Gilles Peskine449bd832023-01-11 14:50:10 +01002590 memmove(ssl->out_msg + 12, ssl->out_msg + 4, hs_len);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002591 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002592
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002593 /* Write message_seq and update it, except for HelloRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01002594 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST) {
2595 MBEDTLS_PUT_UINT16_BE(ssl->handshake->out_msg_seq, ssl->out_msg, 4);
2596 ++(ssl->handshake->out_msg_seq);
2597 } else {
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002598 ssl->out_msg[4] = 0;
2599 ssl->out_msg[5] = 0;
2600 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002601
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002602 /* Handshake hashes are computed without fragmentation,
2603 * so set frag_offset = 0 and frag_len = hs_len for now */
Gilles Peskine449bd832023-01-11 14:50:10 +01002604 memset(ssl->out_msg + 6, 0x00, 3);
2605 memcpy(ssl->out_msg + 9, ssl->out_msg + 1, 3);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002606 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002607#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002608
Hanno Becker0207e532018-08-28 10:28:28 +01002609 /* Update running hashes of handshake messages seen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002611 ret = ssl->handshake->update_checksum(ssl, ssl->out_msg,
2612 ssl->out_msglen);
2613 if (ret != 0) {
2614 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
2615 return ret;
2616 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002617 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002618 }
2619
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002620 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002621#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2623 !(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2624 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST)) {
2625 if ((ret = ssl_flight_append(ssl)) != 0) {
2626 MBEDTLS_SSL_DEBUG_RET(1, "ssl_flight_append", ret);
2627 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002628 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002629 } else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002630#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002631 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002632 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2633 MBEDTLS_SSL_DEBUG_RET(1, "ssl_write_record", ret);
2634 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002635 }
2636 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002637
Gilles Peskine449bd832023-01-11 14:50:10 +01002638 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002639
Gilles Peskine449bd832023-01-11 14:50:10 +01002640 return 0;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002641}
2642
Gilles Peskine449bd832023-01-11 14:50:10 +01002643int mbedtls_ssl_finish_handshake_msg(mbedtls_ssl_context *ssl,
2644 size_t buf_len, size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002645{
2646 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2647 size_t msg_with_header_len;
2648 ((void) buf_len);
2649
2650 /* Add reserved 4 bytes for handshake header */
2651 msg_with_header_len = msg_len + 4;
2652 ssl->out_msglen = msg_with_header_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002653 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_write_handshake_msg_ext(ssl, 0, 0));
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002654
2655cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002656 return ret;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002657}
2658
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002659/*
2660 * Record layer functions
2661 */
2662
2663/*
2664 * Write current record.
2665 *
2666 * Uses:
2667 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2668 * - ssl->out_msglen: length of the record content (excl headers)
2669 * - ssl->out_msg: record content
2670 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002671int mbedtls_ssl_write_record(mbedtls_ssl_context *ssl, int force_flush)
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002672{
2673 int ret, done = 0;
2674 size_t len = ssl->out_msglen;
Ronald Cron00d012f22022-03-08 15:57:12 +01002675 int flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002676
Gilles Peskine449bd832023-01-11 14:50:10 +01002677 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write record"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002678
Gilles Peskine449bd832023-01-11 14:50:10 +01002679 if (!done) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002680 unsigned i;
2681 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002682#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2683 size_t out_buf_len = ssl->out_buf_len;
2684#else
2685 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2686#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002687 /* Skip writing the record content type to after the encryption,
2688 * as it may change when using the CID extension. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002689 mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
Ronald Cron6f135e12021-12-08 16:57:54 +01002690#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002691 /* TLS 1.3 still uses the TLS 1.2 version identifier
2692 * for backwards compatibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002693 if (tls_ver == MBEDTLS_SSL_VERSION_TLS1_3) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002694 tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002695 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002696#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002697 mbedtls_ssl_write_version(ssl->out_hdr + 1, ssl->conf->transport,
2698 tls_ver);
Hanno Becker6430faf2019-05-08 11:57:13 +01002699
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 memcpy(ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
2701 MBEDTLS_PUT_UINT16_BE(len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002702
Gilles Peskine449bd832023-01-11 14:50:10 +01002703 if (ssl->transform_out != NULL) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002704 mbedtls_record rec;
2705
2706 rec.buf = ssl->out_iv;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002707 rec.buf_len = out_buf_len - (size_t) (ssl->out_iv - ssl->out_buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002708 rec.data_len = ssl->out_msglen;
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00002709 rec.data_offset = (size_t) (ssl->out_msg - rec.buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002710
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 memcpy(&rec.ctr[0], ssl->out_ctr, sizeof(rec.ctr));
2712 mbedtls_ssl_write_version(rec.ver, ssl->conf->transport, tls_ver);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002713 rec.type = ssl->out_msgtype;
2714
Hanno Beckera0e20d02019-05-15 14:03:01 +01002715#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002716 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002717 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002718#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002719
Ben Taylor602b2962025-03-07 15:52:50 +00002720 if ((ret = mbedtls_ssl_encrypt_buf(ssl, ssl->transform_out, &rec)) != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002721 MBEDTLS_SSL_DEBUG_RET(1, "ssl_encrypt_buf", ret);
2722 return ret;
Paul Bakker05ef8352012-05-08 09:17:57 +00002723 }
2724
Gilles Peskine449bd832023-01-11 14:50:10 +01002725 if (rec.data_offset != 0) {
2726 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2727 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002728 }
2729
Hanno Becker6430faf2019-05-08 11:57:13 +01002730 /* Update the record content type and CID. */
2731 ssl->out_msgtype = rec.type;
Gilles Peskine449bd832023-01-11 14:50:10 +01002732#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
2733 memcpy(ssl->out_cid, rec.cid, rec.cid_len);
Hanno Beckera0e20d02019-05-15 14:03:01 +01002734#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00002735 ssl->out_msglen = len = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002736 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002737 }
2738
Gilles Peskine449bd832023-01-11 14:50:10 +01002739 protected_record_size = len + mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker2b1e3542018-08-06 11:19:13 +01002740
2741#if defined(MBEDTLS_SSL_PROTO_DTLS)
2742 /* In case of DTLS, double-check that we don't exceed
2743 * the remaining space in the datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002744 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2745 ret = ssl_get_remaining_space_in_datagram(ssl);
2746 if (ret < 0) {
2747 return ret;
2748 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01002749
Gilles Peskine449bd832023-01-11 14:50:10 +01002750 if (protected_record_size > (size_t) ret) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002751 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002752 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker2b1e3542018-08-06 11:19:13 +01002753 }
2754 }
2755#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00002756
Hanno Becker6430faf2019-05-08 11:57:13 +01002757 /* Now write the potentially updated record content type. */
2758 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
2759
Gilles Peskine449bd832023-01-11 14:50:10 +01002760 MBEDTLS_SSL_DEBUG_MSG(3, ("output record: msgtype = %u, "
2761 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
2762 ssl->out_hdr[0], ssl->out_hdr[1],
2763 ssl->out_hdr[2], len));
Paul Bakker05ef8352012-05-08 09:17:57 +00002764
Gilles Peskine449bd832023-01-11 14:50:10 +01002765 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
2766 ssl->out_hdr, protected_record_size);
Hanno Becker2b1e3542018-08-06 11:19:13 +01002767
2768 ssl->out_left += protected_record_size;
2769 ssl->out_hdr += protected_record_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Hanno Becker2b1e3542018-08-06 11:19:13 +01002771
Gilles Peskine449bd832023-01-11 14:50:10 +01002772 for (i = 8; i > mbedtls_ssl_ep_len(ssl); i--) {
2773 if (++ssl->cur_out_ctr[i - 1] != 0) {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002774 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01002775 }
2776 }
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02002777
Gabor Mezei96ae9262022-06-28 11:45:18 +02002778 /* The loop goes to its end if the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 if (i == mbedtls_ssl_ep_len(ssl)) {
2780 MBEDTLS_SSL_DEBUG_MSG(1, ("outgoing message counter would wrap"));
2781 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker04484622018-08-06 09:49:38 +01002782 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002783 }
2784
Hanno Becker67bc7c32018-08-06 11:33:50 +01002785#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002786 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2787 flush == SSL_DONT_FORCE_FLUSH) {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002788 size_t remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +01002789 ret = ssl_get_remaining_payload_in_datagram(ssl);
2790 if (ret < 0) {
2791 MBEDTLS_SSL_DEBUG_RET(1, "ssl_get_remaining_payload_in_datagram",
2792 ret);
2793 return ret;
Hanno Becker1f5a15d2018-08-21 13:31:31 +01002794 }
2795
2796 remaining = (size_t) ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002797 if (remaining == 0) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002798 flush = SSL_FORCE_FLUSH;
Gilles Peskine449bd832023-01-11 14:50:10 +01002799 } else {
2800 MBEDTLS_SSL_DEBUG_MSG(2,
2801 ("Still %u bytes available in current datagram",
2802 (unsigned) remaining));
Hanno Becker67bc7c32018-08-06 11:33:50 +01002803 }
2804 }
2805#endif /* MBEDTLS_SSL_PROTO_DTLS */
2806
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 if ((flush == SSL_FORCE_FLUSH) &&
2808 (ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2809 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
2810 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00002811 }
2812
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write record"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002814
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002816}
2817
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002818#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002819
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002820MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002821static int ssl_hs_is_proper_fragment(mbedtls_ssl_context *ssl)
Hanno Beckere25e3b72018-08-16 09:30:53 +01002822{
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 if (ssl->in_msglen < ssl->in_hslen ||
2824 memcmp(ssl->in_msg + 6, "\0\0\0", 3) != 0 ||
2825 memcmp(ssl->in_msg + 9, ssl->in_msg + 1, 3) != 0) {
2826 return 1;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002827 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002828 return 0;
Hanno Beckere25e3b72018-08-16 09:30:53 +01002829}
Hanno Becker44650b72018-08-16 12:51:11 +01002830
Gilles Peskine449bd832023-01-11 14:50:10 +01002831static uint32_t ssl_get_hs_frag_len(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01002832{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002833 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 9);
Hanno Becker44650b72018-08-16 12:51:11 +01002834}
2835
Gilles Peskine449bd832023-01-11 14:50:10 +01002836static uint32_t ssl_get_hs_frag_off(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01002837{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002838 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 6);
Hanno Becker44650b72018-08-16 12:51:11 +01002839}
2840
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002841MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002842static int ssl_check_hs_header(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01002843{
2844 uint32_t msg_len, frag_off, frag_len;
2845
Gilles Peskine449bd832023-01-11 14:50:10 +01002846 msg_len = ssl_get_hs_total_len(ssl);
2847 frag_off = ssl_get_hs_frag_off(ssl);
2848 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker44650b72018-08-16 12:51:11 +01002849
Gilles Peskine449bd832023-01-11 14:50:10 +01002850 if (frag_off > msg_len) {
2851 return -1;
2852 }
Hanno Becker44650b72018-08-16 12:51:11 +01002853
Gilles Peskine449bd832023-01-11 14:50:10 +01002854 if (frag_len > msg_len - frag_off) {
2855 return -1;
2856 }
Hanno Becker44650b72018-08-16 12:51:11 +01002857
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 if (frag_len + 12 > ssl->in_msglen) {
2859 return -1;
2860 }
Hanno Becker44650b72018-08-16 12:51:11 +01002861
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 return 0;
Hanno Becker44650b72018-08-16 12:51:11 +01002863}
2864
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002865/*
2866 * Mark bits in bitmask (used for DTLS HS reassembly)
2867 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002868static void ssl_bitmask_set(unsigned char *mask, size_t offset, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002869{
2870 unsigned int start_bits, end_bits;
2871
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 start_bits = 8 - (offset % 8);
2873 if (start_bits != 8) {
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002874 size_t first_byte_idx = offset / 8;
2875
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002876 /* Special case */
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 if (len <= start_bits) {
2878 for (; len != 0; len--) {
2879 mask[first_byte_idx] |= 1 << (start_bits - len);
2880 }
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02002881
2882 /* Avoid potential issues with offset or len becoming invalid */
2883 return;
2884 }
2885
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002886 offset += start_bits; /* Now offset % 8 == 0 */
2887 len -= start_bits;
2888
Gilles Peskine449bd832023-01-11 14:50:10 +01002889 for (; start_bits != 0; start_bits--) {
2890 mask[first_byte_idx] |= 1 << (start_bits - 1);
2891 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002892 }
2893
2894 end_bits = len % 8;
Gilles Peskine449bd832023-01-11 14:50:10 +01002895 if (end_bits != 0) {
2896 size_t last_byte_idx = (offset + len) / 8;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002897
2898 len -= end_bits; /* Now len % 8 == 0 */
2899
Gilles Peskine449bd832023-01-11 14:50:10 +01002900 for (; end_bits != 0; end_bits--) {
2901 mask[last_byte_idx] |= 1 << (8 - end_bits);
2902 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002903 }
2904
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 memset(mask + offset / 8, 0xFF, len / 8);
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002906}
2907
2908/*
2909 * Check that bitmask is full
2910 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002911MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002912static int ssl_bitmask_check(unsigned char *mask, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002913{
2914 size_t i;
2915
Gilles Peskine449bd832023-01-11 14:50:10 +01002916 for (i = 0; i < len / 8; i++) {
2917 if (mask[i] != 0xFF) {
2918 return -1;
2919 }
2920 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002921
Gilles Peskine449bd832023-01-11 14:50:10 +01002922 for (i = 0; i < len % 8; i++) {
2923 if ((mask[len / 8] & (1 << (7 - i))) == 0) {
2924 return -1;
2925 }
2926 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002927
Gilles Peskine449bd832023-01-11 14:50:10 +01002928 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002929}
2930
Hanno Becker56e205e2018-08-16 09:06:12 +01002931/* msg_len does not include the handshake header */
Gilles Peskine449bd832023-01-11 14:50:10 +01002932static size_t ssl_get_reassembly_buffer_size(size_t msg_len,
2933 unsigned add_bitmap)
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002934{
Hanno Becker56e205e2018-08-16 09:06:12 +01002935 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002936
Hanno Becker56e205e2018-08-16 09:06:12 +01002937 alloc_len = 12; /* Handshake header */
2938 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002939
Gilles Peskine449bd832023-01-11 14:50:10 +01002940 if (add_bitmap) {
2941 alloc_len += msg_len / 8 + (msg_len % 8 != 0); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002942
Gilles Peskine449bd832023-01-11 14:50:10 +01002943 }
2944 return alloc_len;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002945}
Hanno Becker56e205e2018-08-16 09:06:12 +01002946
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002947#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002948
Gilles Peskine449bd832023-01-11 14:50:10 +01002949static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl)
Hanno Becker12555c62018-08-16 12:47:53 +01002950{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002951 return MBEDTLS_GET_UINT24_BE(ssl->in_msg, 1);
Hanno Becker12555c62018-08-16 12:47:53 +01002952}
Hanno Beckere25e3b72018-08-16 09:30:53 +01002953
Gilles Peskine449bd832023-01-11 14:50:10 +01002954int mbedtls_ssl_prepare_handshake_record(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002955{
Gilles Peskine7a176962025-02-28 21:59:12 +01002956 if (ssl->in_hsfraglen == 0) {
2957 /* The handshake message must at least include the header.
2958 * We may not have the full message yet in case of fragmentation.
2959 * To simplify the code, we insist on having the header (and in
2960 * particular the handshake message length) in the first
2961 * fragment. */
2962 if (ssl->in_msglen < mbedtls_ssl_hs_hdr_len(ssl)) {
2963 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake message too short: %" MBEDTLS_PRINTF_SIZET,
2964 ssl->in_msglen));
2965 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2966 }
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02002967
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00002968 ssl->in_hslen = mbedtls_ssl_hs_hdr_len(ssl) + ssl_get_hs_total_len(ssl);
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00002969 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002970
Gilles Peskine449bd832023-01-11 14:50:10 +01002971 MBEDTLS_SSL_DEBUG_MSG(3, ("handshake message: msglen ="
2972 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %"
2973 MBEDTLS_PRINTF_SIZET,
2974 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen));
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01002975
Gilles Peskine235eae92025-02-28 22:02:52 +01002976 if (ssl->transform_in != NULL) {
2977 MBEDTLS_SSL_DEBUG_MSG(4, ("decrypted handshake message:"
2978 " iv-buf=%d hdr-buf=%d hdr-buf=%d",
2979 (int) (ssl->in_iv - ssl->in_buf),
2980 (int) (ssl->in_hdr - ssl->in_buf),
2981 (int) (ssl->in_msg - ssl->in_buf)));
2982 }
2983
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002984#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002985 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00002986 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00002987 unsigned int recv_msg_seq = MBEDTLS_GET_UINT16_BE(ssl->in_msg, 4);
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02002988
Gilles Peskine449bd832023-01-11 14:50:10 +01002989 if (ssl_check_hs_header(ssl) != 0) {
2990 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid handshake header"));
2991 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker44650b72018-08-16 12:51:11 +01002992 }
2993
Gilles Peskine449bd832023-01-11 14:50:10 +01002994 if (ssl->handshake != NULL &&
2995 ((mbedtls_ssl_is_handshake_over(ssl) == 0 &&
2996 recv_msg_seq != ssl->handshake->in_msg_seq) ||
2997 (mbedtls_ssl_is_handshake_over(ssl) == 1 &&
2998 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO))) {
2999 if (recv_msg_seq > ssl->handshake->in_msg_seq) {
3000 MBEDTLS_SSL_DEBUG_MSG(2,
3001 (
3002 "received future handshake message of sequence number %u (next %u)",
3003 recv_msg_seq,
3004 ssl->handshake->in_msg_seq));
3005 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Becker9e1ec222018-08-15 15:54:43 +01003006 }
3007
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003008 /* Retransmit only on last message from previous flight, to avoid
3009 * too many retransmissions.
3010 * Besides, No sane server ever retransmits HelloVerifyRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01003011 if (recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
3012 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST) {
3013 MBEDTLS_SSL_DEBUG_MSG(2, ("received message from last flight, "
3014 "message_seq = %u, start_of_flight = %u",
3015 recv_msg_seq,
3016 ssl->handshake->in_flight_start_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003017
Gilles Peskine449bd832023-01-11 14:50:10 +01003018 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
3019 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
3020 return ret;
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003021 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003022 } else {
3023 MBEDTLS_SSL_DEBUG_MSG(2, ("dropping out-of-sequence message: "
3024 "message_seq = %u, expected = %u",
3025 recv_msg_seq,
3026 ssl->handshake->in_msg_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003027 }
3028
Gilles Peskine449bd832023-01-11 14:50:10 +01003029 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003030 }
3031 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003032
Hanno Becker6d97ef52018-08-16 13:09:04 +01003033 /* Message reassembly is handled alongside buffering of future
3034 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003035 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003036 * handshake logic layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003037 if (ssl_hs_is_proper_fragment(ssl) == 1) {
3038 MBEDTLS_SSL_DEBUG_MSG(2, ("found fragmented DTLS handshake message"));
3039 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003040 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003042#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskinee85ece62025-02-28 22:24:56 +01003043 {
3044 unsigned char *const reassembled_record_start =
3045 ssl->in_buf + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3046 unsigned char *const payload_start =
3047 reassembled_record_start + mbedtls_ssl_in_hdr_len(ssl);
3048 unsigned char *payload_end = payload_start + ssl->in_hsfraglen;
Gilles Peskine15c072f2025-03-06 19:03:00 +01003049 /* How many more bytes we want to have a complete handshake message. */
3050 const size_t hs_remain = ssl->in_hslen - ssl->in_hsfraglen;
3051 /* How many bytes of the current record are part of the first
3052 * handshake message. There may be more handshake messages (possibly
3053 * incomplete) in the same record; if so, we leave them after the
3054 * current record, and ssl_consume_current_message() will take
3055 * care of consuming the next handshake message. */
3056 const size_t hs_this_fragment_len =
3057 ssl->in_msglen > hs_remain ? hs_remain : ssl->in_msglen;
Gilles Peskinedab1cb52025-03-06 21:30:23 +01003058 (void) hs_this_fragment_len;
Gilles Peskinee85ece62025-02-28 22:24:56 +01003059
Gilles Peskineafb254c2025-03-06 19:23:22 +01003060 MBEDTLS_SSL_DEBUG_MSG(3,
3061 ("%s handshake fragment: %" MBEDTLS_PRINTF_SIZET
3062 ", %" MBEDTLS_PRINTF_SIZET
3063 "..%" MBEDTLS_PRINTF_SIZET
3064 " of %" MBEDTLS_PRINTF_SIZET,
3065 (ssl->in_hsfraglen != 0 ?
3066 "subsequent" :
3067 hs_this_fragment_len == ssl->in_hslen ?
3068 "sole" :
3069 "initial"),
3070 ssl->in_msglen,
3071 ssl->in_hsfraglen,
3072 ssl->in_hsfraglen + hs_this_fragment_len,
3073 ssl->in_hslen));
Gilles Peskinee85ece62025-02-28 22:24:56 +01003074
3075 /* Move the received handshake fragment to have the whole message
3076 * (at least the part received so far) in a single segment at a
3077 * known offset in the input buffer.
3078 * - When receiving a non-initial handshake fragment, append it to
3079 * the initial segment.
3080 * - Even the initial handshake fragment is moved, if it was
3081 * encrypted with an explicit IV: decryption leaves the payload
3082 * after the explicit IV, but here we move it to start where the
3083 * IV was.
3084 */
3085#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
3086 size_t const in_buf_len = ssl->in_buf_len;
3087#else
3088 size_t const in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
3089#endif
Gilles Peskine0851ec92025-03-06 15:15:20 +01003090 if (payload_end + ssl->in_msglen > ssl->in_buf + in_buf_len) {
Gilles Peskinee85ece62025-02-28 22:24:56 +01003091 MBEDTLS_SSL_DEBUG_MSG(1,
3092 ("Shouldn't happen: no room to move handshake fragment %"
3093 MBEDTLS_PRINTF_SIZET " from %p to %p (buf=%p len=%"
3094 MBEDTLS_PRINTF_SIZET ")",
3095 ssl->in_msglen,
Gilles Peskine90a95932025-02-25 23:57:20 +01003096 (void *) ssl->in_msg, (void *) payload_end,
3097 (void *) ssl->in_buf, in_buf_len));
Gilles Peskinee85ece62025-02-28 22:24:56 +01003098 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3099 }
3100 memmove(payload_end, ssl->in_msg, ssl->in_msglen);
3101
3102 ssl->in_hsfraglen += ssl->in_msglen;
3103 payload_end += ssl->in_msglen;
3104
3105 if (ssl->in_hsfraglen < ssl->in_hslen) {
3106 MBEDTLS_SSL_DEBUG_MSG(3, ("Prepare: waiting for more handshake fragments %"
3107 MBEDTLS_PRINTF_SIZET "/%"
3108 MBEDTLS_PRINTF_SIZET,
3109 ssl->in_hsfraglen, ssl->in_hslen));
3110 ssl->in_hdr = payload_end;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003111 ssl->in_msglen = 0;
3112 mbedtls_ssl_update_in_pointers(ssl);
3113 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Gilles Peskinee85ece62025-02-28 22:24:56 +01003114 } else {
3115 ssl->in_msglen = ssl->in_hsfraglen;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003116 ssl->in_hsfraglen = 0;
Gilles Peskinee85ece62025-02-28 22:24:56 +01003117 ssl->in_hdr = reassembled_record_start;
3118 mbedtls_ssl_update_in_pointers(ssl);
3119
3120 /* Update the record length in the fully reassembled record */
3121 if (ssl->in_msglen > 0xffff) {
3122 MBEDTLS_SSL_DEBUG_MSG(1,
Gilles Peskinee34ec862025-03-07 10:43:39 +01003123 ("Shouldn't happen: in_msglen=%"
Gilles Peskinee85ece62025-02-28 22:24:56 +01003124 MBEDTLS_PRINTF_SIZET " > 0xffff",
3125 ssl->in_msglen));
3126 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3127 }
3128 MBEDTLS_PUT_UINT16_BE(ssl->in_msglen, ssl->in_len, 0);
3129
Gilles Peskine15c072f2025-03-06 19:03:00 +01003130 size_t record_len = mbedtls_ssl_in_hdr_len(ssl) + ssl->in_msglen;
Gilles Peskinedab1cb52025-03-06 21:30:23 +01003131 (void) record_len;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003132 MBEDTLS_SSL_DEBUG_BUF(4, "reassembled record",
Gilles Peskine15c072f2025-03-06 19:03:00 +01003133 ssl->in_hdr, record_len);
3134 if (ssl->in_hslen < ssl->in_msglen) {
3135 MBEDTLS_SSL_DEBUG_MSG(3,
3136 ("More handshake messages in the record: "
Gilles Peskineb8f1e4b2025-03-06 21:32:08 +01003137 "%" MBEDTLS_PRINTF_SIZET " + %" MBEDTLS_PRINTF_SIZET,
Gilles Peskine15c072f2025-03-06 19:03:00 +01003138 ssl->in_hslen,
3139 ssl->in_msglen - ssl->in_hslen));
3140 }
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00003141 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003142 }
3143
Gilles Peskine449bd832023-01-11 14:50:10 +01003144 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01003145}
3146
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003147int mbedtls_ssl_update_handshake_status(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01003148{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003149 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker0271f962018-08-16 13:23:47 +01003150 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003151
Gilles Peskine449bd832023-01-11 14:50:10 +01003152 if (mbedtls_ssl_is_handshake_over(ssl) == 0 && hs != NULL) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003153 ret = ssl->handshake->update_checksum(ssl, ssl->in_msg, ssl->in_hslen);
3154 if (ret != 0) {
3155 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
3156 return ret;
3157 }
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003158 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003159
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003160 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003161#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003162 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3163 ssl->handshake != NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01003164 unsigned offset;
3165 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003166
Hanno Becker0271f962018-08-16 13:23:47 +01003167 /* Increment handshake sequence number */
3168 hs->in_msg_seq++;
3169
3170 /*
3171 * Clear up handshake buffering and reassembly structure.
3172 */
3173
3174 /* Free first entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003175 ssl_buffering_free_slot(ssl, 0);
Hanno Becker0271f962018-08-16 13:23:47 +01003176
3177 /* Shift all other entries */
Gilles Peskine449bd832023-01-11 14:50:10 +01003178 for (offset = 0, hs_buf = &hs->buffering.hs[0];
Hanno Beckere605b192018-08-21 15:59:07 +01003179 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Gilles Peskine449bd832023-01-11 14:50:10 +01003180 offset++, hs_buf++) {
Hanno Becker0271f962018-08-16 13:23:47 +01003181 *hs_buf = *(hs_buf + 1);
3182 }
3183
3184 /* Create a fresh last entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003185 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003186 }
3187#endif
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003188 return 0;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003189}
3190
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003191/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003192 * DTLS anti-replay: RFC 6347 4.1.2.6
3193 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003194 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3195 * Bit n is set iff record number in_window_top - n has been seen.
3196 *
3197 * Usually, in_window_top is the last record number seen and the lsb of
3198 * in_window is set. The only exception is the initial state (record number 0
3199 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003200 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003201#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003202void mbedtls_ssl_dtls_replay_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003203{
3204 ssl->in_window_top = 0;
3205 ssl->in_window = 0;
3206}
3207
Gilles Peskine449bd832023-01-11 14:50:10 +01003208static inline uint64_t ssl_load_six_bytes(unsigned char *buf)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003209{
Gilles Peskine449bd832023-01-11 14:50:10 +01003210 return ((uint64_t) buf[0] << 40) |
3211 ((uint64_t) buf[1] << 32) |
3212 ((uint64_t) buf[2] << 24) |
3213 ((uint64_t) buf[3] << 16) |
3214 ((uint64_t) buf[4] << 8) |
3215 ((uint64_t) buf[5]);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003216}
3217
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003218MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003219static int mbedtls_ssl_dtls_record_replay_check(mbedtls_ssl_context *ssl, uint8_t *record_in_ctr)
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003220{
Janos Follath865b3eb2019-12-16 11:46:15 +00003221 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003222 unsigned char *original_in_ctr;
3223
3224 // save original in_ctr
3225 original_in_ctr = ssl->in_ctr;
3226
3227 // use counter from record
3228 ssl->in_ctr = record_in_ctr;
3229
Gilles Peskine449bd832023-01-11 14:50:10 +01003230 ret = mbedtls_ssl_dtls_replay_check((mbedtls_ssl_context const *) ssl);
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003231
3232 // restore the counter
3233 ssl->in_ctr = original_in_ctr;
3234
3235 return ret;
3236}
3237
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003238/*
3239 * Return 0 if sequence number is acceptable, -1 otherwise
3240 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003241int mbedtls_ssl_dtls_replay_check(mbedtls_ssl_context const *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003242{
Gilles Peskine449bd832023-01-11 14:50:10 +01003243 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003244 uint64_t bit;
3245
Gilles Peskine449bd832023-01-11 14:50:10 +01003246 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
3247 return 0;
3248 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003249
Gilles Peskine449bd832023-01-11 14:50:10 +01003250 if (rec_seqnum > ssl->in_window_top) {
3251 return 0;
3252 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003253
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003254 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003255
Gilles Peskine449bd832023-01-11 14:50:10 +01003256 if (bit >= 64) {
3257 return -1;
3258 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003259
Gilles Peskine449bd832023-01-11 14:50:10 +01003260 if ((ssl->in_window & ((uint64_t) 1 << bit)) != 0) {
3261 return -1;
3262 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003263
Gilles Peskine449bd832023-01-11 14:50:10 +01003264 return 0;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003265}
3266
3267/*
3268 * Update replay window on new validated record
3269 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003270void mbedtls_ssl_dtls_replay_update(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003271{
Gilles Peskine449bd832023-01-11 14:50:10 +01003272 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003273
Gilles Peskine449bd832023-01-11 14:50:10 +01003274 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003275 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01003276 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003277
Gilles Peskine449bd832023-01-11 14:50:10 +01003278 if (rec_seqnum > ssl->in_window_top) {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003279 /* Update window_top and the contents of the window */
3280 uint64_t shift = rec_seqnum - ssl->in_window_top;
3281
Gilles Peskine449bd832023-01-11 14:50:10 +01003282 if (shift >= 64) {
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003283 ssl->in_window = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003284 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003285 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003286 ssl->in_window |= 1;
3287 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003288
3289 ssl->in_window_top = rec_seqnum;
Gilles Peskine449bd832023-01-11 14:50:10 +01003290 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003291 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003292 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003293
Gilles Peskine449bd832023-01-11 14:50:10 +01003294 if (bit < 64) { /* Always true, but be extra sure */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003295 ssl->in_window |= (uint64_t) 1 << bit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003296 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003297 }
3298}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003299#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003300
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003301#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003302/*
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003303 * Check if a datagram looks like a ClientHello with a valid cookie,
3304 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003305 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003306 *
3307 * - if cookie is valid, return 0
3308 * - if ClientHello looks superficially valid but cookie is not,
3309 * fill obuf and set olen, then
3310 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3311 * - otherwise return a specific error code
3312 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003313MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003314MBEDTLS_STATIC_TESTABLE
3315int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003316 mbedtls_ssl_context *ssl,
3317 const unsigned char *cli_id, size_t cli_id_len,
3318 const unsigned char *in, size_t in_len,
3319 unsigned char *obuf, size_t buf_len, size_t *olen)
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003320{
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003321 size_t sid_len, cookie_len, epoch, fragment_offset;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003322 unsigned char *p;
3323
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003324 /*
3325 * Structure of ClientHello with record and handshake headers,
3326 * and expected values. We don't need to check a lot, more checks will be
3327 * done when actually parsing the ClientHello - skipping those checks
3328 * avoids code duplication and does not make cookie forging any easier.
3329 *
3330 * 0-0 ContentType type; copied, must be handshake
3331 * 1-2 ProtocolVersion version; copied
3332 * 3-4 uint16 epoch; copied, must be 0
3333 * 5-10 uint48 sequence_number; copied
3334 * 11-12 uint16 length; (ignored)
3335 *
3336 * 13-13 HandshakeType msg_type; (ignored)
3337 * 14-16 uint24 length; (ignored)
3338 * 17-18 uint16 message_seq; copied
3339 * 19-21 uint24 fragment_offset; copied, must be 0
3340 * 22-24 uint24 fragment_length; (ignored)
3341 *
3342 * 25-26 ProtocolVersion client_version; (ignored)
3343 * 27-58 Random random; (ignored)
3344 * 59-xx SessionID session_id; 1 byte len + sid_len content
3345 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3346 * ...
3347 *
3348 * Minimum length is 61 bytes.
3349 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003350 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: in_len=%u",
3351 (unsigned) in_len));
3352 MBEDTLS_SSL_DEBUG_BUF(4, "cli_id", cli_id, cli_id_len);
3353 if (in_len < 61) {
3354 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: record too short"));
3355 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003356 }
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003357
Gilles Peskine449bd832023-01-11 14:50:10 +01003358 epoch = MBEDTLS_GET_UINT16_BE(in, 3);
3359 fragment_offset = MBEDTLS_GET_UINT24_BE(in, 19);
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003360
Gilles Peskine449bd832023-01-11 14:50:10 +01003361 if (in[0] != MBEDTLS_SSL_MSG_HANDSHAKE || epoch != 0 ||
3362 fragment_offset != 0) {
3363 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: not a good ClientHello"));
3364 MBEDTLS_SSL_DEBUG_MSG(4, (" type=%u epoch=%u fragment_offset=%u",
3365 in[0], (unsigned) epoch,
3366 (unsigned) fragment_offset));
3367 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003368 }
3369
3370 sid_len = in[59];
Gilles Peskine449bd832023-01-11 14:50:10 +01003371 if (59 + 1 + sid_len + 1 > in_len) {
3372 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: sid_len=%u > %u",
3373 (unsigned) sid_len,
3374 (unsigned) in_len - 61));
3375 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003376 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003377 MBEDTLS_SSL_DEBUG_BUF(4, "sid received from network",
3378 in + 60, sid_len);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003379
3380 cookie_len = in[60 + sid_len];
Gilles Peskine449bd832023-01-11 14:50:10 +01003381 if (59 + 1 + sid_len + 1 + cookie_len > in_len) {
3382 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: cookie_len=%u > %u",
3383 (unsigned) cookie_len,
3384 (unsigned) (in_len - sid_len - 61)));
3385 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003386 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003387
Gilles Peskine449bd832023-01-11 14:50:10 +01003388 MBEDTLS_SSL_DEBUG_BUF(4, "cookie received from network",
3389 in + sid_len + 61, cookie_len);
3390 if (ssl->conf->f_cookie_check(ssl->conf->p_cookie,
3391 in + sid_len + 61, cookie_len,
3392 cli_id, cli_id_len) == 0) {
3393 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: valid"));
3394 return 0;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003395 }
3396
3397 /*
3398 * If we get here, we've got an invalid cookie, let's prepare HVR.
3399 *
3400 * 0-0 ContentType type; copied
3401 * 1-2 ProtocolVersion version; copied
3402 * 3-4 uint16 epoch; copied
3403 * 5-10 uint48 sequence_number; copied
3404 * 11-12 uint16 length; olen - 13
3405 *
3406 * 13-13 HandshakeType msg_type; hello_verify_request
3407 * 14-16 uint24 length; olen - 25
3408 * 17-18 uint16 message_seq; copied
3409 * 19-21 uint24 fragment_offset; copied
3410 * 22-24 uint24 fragment_length; olen - 25
3411 *
3412 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3413 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3414 *
3415 * Minimum length is 28.
3416 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003417 if (buf_len < 28) {
3418 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3419 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003420
3421 /* Copy most fields and adapt others */
Gilles Peskine449bd832023-01-11 14:50:10 +01003422 memcpy(obuf, in, 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003423 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3424 obuf[25] = 0xfe;
3425 obuf[26] = 0xff;
3426
3427 /* Generate and write actual cookie */
3428 p = obuf + 28;
Gilles Peskine449bd832023-01-11 14:50:10 +01003429 if (ssl->conf->f_cookie_write(ssl->conf->p_cookie,
3430 &p, obuf + buf_len,
3431 cli_id, cli_id_len) != 0) {
3432 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003433 }
3434
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00003435 *olen = (size_t) (p - obuf);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003436
3437 /* Go back and fill length fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01003438 obuf[27] = (unsigned char) (*olen - 28);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003439
Gilles Peskine449bd832023-01-11 14:50:10 +01003440 obuf[14] = obuf[22] = MBEDTLS_BYTE_2(*olen - 25);
3441 obuf[15] = obuf[23] = MBEDTLS_BYTE_1(*olen - 25);
3442 obuf[16] = obuf[24] = MBEDTLS_BYTE_0(*olen - 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003443
Gilles Peskine449bd832023-01-11 14:50:10 +01003444 MBEDTLS_PUT_UINT16_BE(*olen - 13, obuf, 11);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003445
Gilles Peskine449bd832023-01-11 14:50:10 +01003446 return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003447}
3448
3449/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003450 * Handle possible client reconnect with the same UDP quadruplet
3451 * (RFC 6347 Section 4.2.8).
3452 *
3453 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3454 * that looks like a ClientHello.
3455 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003456 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003457 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003458 * - if the input looks like a ClientHello with a valid cookie,
3459 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003460 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003461 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003462 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003463 * This function is called (through ssl_check_client_reconnect()) when an
3464 * unexpected record is found in ssl_get_next_record(), which will discard the
3465 * record if we return 0, and bubble up the return value otherwise (this
3466 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3467 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003468 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003469MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003470static int ssl_handle_possible_reconnect(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003471{
Janos Follath865b3eb2019-12-16 11:46:15 +00003472 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Matthias Schulz9916b062023-11-09 14:25:01 +01003473 size_t len = 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003474
Gilles Peskine449bd832023-01-11 14:50:10 +01003475 if (ssl->conf->f_cookie_write == NULL ||
3476 ssl->conf->f_cookie_check == NULL) {
Hanno Becker2fddd372019-07-10 14:37:41 +01003477 /* If we can't use cookies to verify reachability of the peer,
3478 * drop the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003479 MBEDTLS_SSL_DEBUG_MSG(1, ("no cookie callbacks, "
3480 "can't check reconnect validity"));
3481 return 0;
Hanno Becker2fddd372019-07-10 14:37:41 +01003482 }
3483
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003484 ret = mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003485 ssl,
3486 ssl->cli_id, ssl->cli_id_len,
3487 ssl->in_buf, ssl->in_left,
3488 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len);
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003489
Gilles Peskine449bd832023-01-11 14:50:10 +01003490 MBEDTLS_SSL_DEBUG_RET(2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003491
Gilles Peskine449bd832023-01-11 14:50:10 +01003492 if (ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED) {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003493 int send_ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003494 MBEDTLS_SSL_DEBUG_MSG(1, ("sending HelloVerifyRequest"));
3495 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3496 ssl->out_buf, len);
Brian J Murray1903fb32016-11-06 04:45:15 -08003497 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003498 * If the error is permanent we'll catch it later,
3499 * if it's not, then hopefully it'll work next time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003500 send_ret = ssl->f_send(ssl->p_bio, ssl->out_buf, len);
3501 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", send_ret);
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003502 (void) send_ret;
3503
Gilles Peskine449bd832023-01-11 14:50:10 +01003504 return 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003505 }
3506
Gilles Peskine449bd832023-01-11 14:50:10 +01003507 if (ret == 0) {
3508 MBEDTLS_SSL_DEBUG_MSG(1, ("cookie is valid, resetting context"));
3509 if ((ret = mbedtls_ssl_session_reset_int(ssl, 1)) != 0) {
3510 MBEDTLS_SSL_DEBUG_RET(1, "reset", ret);
3511 return ret;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003512 }
3513
Gilles Peskine449bd832023-01-11 14:50:10 +01003514 return MBEDTLS_ERR_SSL_CLIENT_RECONNECT;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003515 }
3516
Gilles Peskine449bd832023-01-11 14:50:10 +01003517 return ret;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003518}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003519#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003520
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003521MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003522static int ssl_check_record_type(uint8_t record_type)
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003523{
Gilles Peskine449bd832023-01-11 14:50:10 +01003524 if (record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003525 record_type != MBEDTLS_SSL_MSG_ALERT &&
3526 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003527 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
3528 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003529 }
3530
Gilles Peskine449bd832023-01-11 14:50:10 +01003531 return 0;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003532}
3533
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003534/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003535 * ContentType type;
3536 * ProtocolVersion version;
3537 * uint16 epoch; // DTLS only
3538 * uint48 sequence_number; // DTLS only
3539 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003540 *
3541 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003542 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003543 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3544 *
3545 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003546 * 1. proceed with the record if this function returns 0
3547 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3548 * 3. return CLIENT_RECONNECT if this function return that value
3549 * 4. drop the whole datagram if this function returns anything else.
3550 * Point 2 is needed when the peer is resending, and we have already received
3551 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003552 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003553MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003554static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
3555 unsigned char *buf,
3556 size_t len,
3557 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00003558{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003559 mbedtls_ssl_protocol_version tls_version;
Paul Bakker5121ce52009-01-03 21:22:43 +00003560
Hanno Beckere5e7e782019-07-11 12:29:35 +01003561 size_t const rec_hdr_type_offset = 0;
3562 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003563
Hanno Beckere5e7e782019-07-11 12:29:35 +01003564 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3565 rec_hdr_type_len;
3566 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003567
Hanno Beckere5e7e782019-07-11 12:29:35 +01003568 size_t const rec_hdr_ctr_len = 8;
3569#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003570 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003571 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3572 rec_hdr_version_len;
3573
Hanno Beckera0e20d02019-05-15 14:03:01 +01003574#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003575 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3576 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003577 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003578#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3579#endif /* MBEDTLS_SSL_PROTO_DTLS */
3580
3581 size_t rec_hdr_len_offset; /* To be determined */
3582 size_t const rec_hdr_len_len = 2;
3583
3584 /*
3585 * Check minimum lengths for record header.
3586 */
3587
3588#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003589 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003590 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003591 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003592#endif /* MBEDTLS_SSL_PROTO_DTLS */
3593 {
3594 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3595 }
3596
Gilles Peskine449bd832023-01-11 14:50:10 +01003597 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3598 MBEDTLS_SSL_DEBUG_MSG(1,
3599 (
3600 "datagram of length %u too small to hold DTLS record header of length %u",
3601 (unsigned) len,
3602 (unsigned) (rec_hdr_len_len + rec_hdr_len_len)));
3603 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003604 }
3605
3606 /*
3607 * Parse and validate record content type
3608 */
3609
Gilles Peskine449bd832023-01-11 14:50:10 +01003610 rec->type = buf[rec_hdr_type_offset];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003611
3612 /* Check record content type */
3613#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3614 rec->cid_len = 0;
3615
Gilles Peskine449bd832023-01-11 14:50:10 +01003616 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003617 ssl->conf->cid_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003618 rec->type == MBEDTLS_SSL_MSG_CID) {
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003619 /* Shift pointers to account for record header including CID
3620 * struct {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02003621 * ContentType outer_type = tls12_cid;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003622 * ProtocolVersion version;
3623 * uint16 epoch;
3624 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003625 * opaque cid[cid_length]; // Additional field compared to
3626 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003627 * uint16 length;
3628 * opaque enc_content[DTLSCiphertext.length];
3629 * } DTLSCiphertext;
3630 */
3631
3632 /* So far, we only support static CID lengths
3633 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003634 rec_hdr_cid_len = ssl->conf->cid_len;
3635 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003636
Gilles Peskine449bd832023-01-11 14:50:10 +01003637 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3638 MBEDTLS_SSL_DEBUG_MSG(1,
3639 (
3640 "datagram of length %u too small to hold DTLS record header including CID, length %u",
3641 (unsigned) len,
3642 (unsigned) (rec_hdr_len_offset + rec_hdr_len_len)));
3643 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere538d822019-07-10 14:50:10 +01003644 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003645
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003646 /* configured CID len is guaranteed at most 255, see
3647 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3648 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003649 memcpy(rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len);
3650 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003651#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003652 {
Gilles Peskine449bd832023-01-11 14:50:10 +01003653 if (ssl_check_record_type(rec->type)) {
3654 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type %u",
3655 (unsigned) rec->type));
3656 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003657 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003658 }
3659
Hanno Beckere5e7e782019-07-11 12:29:35 +01003660 /*
3661 * Parse and validate record version
3662 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003663 rec->ver[0] = buf[rec_hdr_version_offset + 0];
3664 rec->ver[1] = buf[rec_hdr_version_offset + 1];
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003665 tls_version = (mbedtls_ssl_protocol_version) mbedtls_ssl_read_version(
3666 buf + rec_hdr_version_offset,
3667 ssl->conf->transport);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003668
Gilles Peskine449bd832023-01-11 14:50:10 +01003669 if (tls_version > ssl->conf->max_tls_version) {
3670 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS version mismatch: got %u, expected max %u",
3671 (unsigned) tls_version,
3672 (unsigned) ssl->conf->max_tls_version));
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003673
Gilles Peskine449bd832023-01-11 14:50:10 +01003674 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Paul Bakker5121ce52009-01-03 21:22:43 +00003675 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003676 /*
3677 * Parse/Copy record sequence number.
3678 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003679
Hanno Beckere5e7e782019-07-11 12:29:35 +01003680#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003681 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003682 /* Copy explicit record sequence number from input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003683 memcpy(&rec->ctr[0], buf + rec_hdr_ctr_offset,
3684 rec_hdr_ctr_len);
3685 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003686#endif /* MBEDTLS_SSL_PROTO_DTLS */
3687 {
3688 /* Copy implicit record sequence number from SSL context structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003689 memcpy(&rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003690 }
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003691
Hanno Beckere5e7e782019-07-11 12:29:35 +01003692 /*
3693 * Parse record length.
3694 */
3695
Hanno Beckere5e7e782019-07-11 12:29:35 +01003696 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003697 rec->data_len = MBEDTLS_GET_UINT16_BE(buf, rec_hdr_len_offset);
Gilles Peskine449bd832023-01-11 14:50:10 +01003698 MBEDTLS_SSL_DEBUG_BUF(4, "input record header", buf, rec->data_offset);
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003699
Gilles Peskine449bd832023-01-11 14:50:10 +01003700 MBEDTLS_SSL_DEBUG_MSG(3, ("input record: msgtype = %u, "
3701 "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3702 rec->type, (unsigned) tls_version, rec->data_len));
Hanno Beckere5e7e782019-07-11 12:29:35 +01003703
3704 rec->buf = buf;
3705 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003706
Gilles Peskine449bd832023-01-11 14:50:10 +01003707 if (rec->data_len == 0) {
3708 return MBEDTLS_ERR_SSL_INVALID_RECORD;
3709 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003710
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003711 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003712 * DTLS-related tests.
3713 * Check epoch before checking length constraint because
3714 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3715 * message gets duplicated before the corresponding Finished message,
3716 * the second ChangeCipherSpec should be discarded because it belongs
3717 * to an old epoch, but not because its length is shorter than
3718 * the minimum record length for packets using the new record transform.
3719 * Note that these two kinds of failures are handled differently,
3720 * as an unexpected record is silently skipped but an invalid
3721 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003722 */
3723#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003724 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003725 rec_epoch = MBEDTLS_GET_UINT16_BE(rec->ctr, 0);
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003726
Hanno Becker955a5c92019-07-10 17:12:07 +01003727 /* Check that the datagram is large enough to contain a record
3728 * of the advertised length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003729 if (len < rec->data_offset + rec->data_len) {
3730 MBEDTLS_SSL_DEBUG_MSG(1,
3731 (
3732 "Datagram of length %u too small to contain record of advertised length %u.",
3733 (unsigned) len,
3734 (unsigned) (rec->data_offset + rec->data_len)));
3735 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker955a5c92019-07-10 17:12:07 +01003736 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003737
Hanno Becker37cfe732019-07-10 17:20:01 +01003738 /* Records from other, non-matching epochs are silently discarded.
3739 * (The case of same-port Client reconnects must be considered in
3740 * the caller). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003741 if (rec_epoch != ssl->in_epoch) {
3742 MBEDTLS_SSL_DEBUG_MSG(1, ("record from another epoch: "
3743 "expected %u, received %lu",
3744 ssl->in_epoch, (unsigned long) rec_epoch));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003745
Hanno Becker552f7472019-07-19 10:59:12 +01003746 /* Records from the next epoch are considered for buffering
3747 * (concretely: early Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003748 if (rec_epoch == (unsigned) ssl->in_epoch + 1) {
3749 MBEDTLS_SSL_DEBUG_MSG(2, ("Consider record for buffering"));
3750 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003751 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003752
Gilles Peskine449bd832023-01-11 14:50:10 +01003753 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003754 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003755#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003756 /* For records from the correct epoch, check whether their
3757 * sequence number has been seen before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003758 else if (mbedtls_ssl_dtls_record_replay_check((mbedtls_ssl_context *) ssl,
3759 &rec->ctr[0]) != 0) {
3760 MBEDTLS_SSL_DEBUG_MSG(1, ("replayed record"));
3761 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003762 }
3763#endif
3764 }
3765#endif /* MBEDTLS_SSL_PROTO_DTLS */
3766
Gilles Peskine449bd832023-01-11 14:50:10 +01003767 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003768}
Paul Bakker5121ce52009-01-03 21:22:43 +00003769
Paul Bakker5121ce52009-01-03 21:22:43 +00003770
Hanno Becker2fddd372019-07-10 14:37:41 +01003771#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003772MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003773static int ssl_check_client_reconnect(mbedtls_ssl_context *ssl)
Hanno Becker2fddd372019-07-10 14:37:41 +01003774{
Dave Rodgmana3d0f612023-11-03 23:34:02 +00003775 unsigned int rec_epoch = MBEDTLS_GET_UINT16_BE(ssl->in_ctr, 0);
Hanno Becker2fddd372019-07-10 14:37:41 +01003776
3777 /*
3778 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3779 * access the first byte of record content (handshake type), as we
3780 * have an active transform (possibly iv_len != 0), so use the
3781 * fact that the record header len is 13 instead.
3782 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003783 if (rec_epoch == 0 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003784 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003785 mbedtls_ssl_is_handshake_over(ssl) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003786 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3787 ssl->in_left > 13 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003788 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO) {
3789 MBEDTLS_SSL_DEBUG_MSG(1, ("possible client reconnect "
3790 "from the same port"));
3791 return ssl_handle_possible_reconnect(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003792 }
3793
Gilles Peskine449bd832023-01-11 14:50:10 +01003794 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003795}
Hanno Becker2fddd372019-07-10 14:37:41 +01003796#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003797
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003798/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003799 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003800 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003801MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003802static int ssl_prepare_record_content(mbedtls_ssl_context *ssl,
3803 mbedtls_record *rec)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003804{
3805 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003806
Gilles Peskine449bd832023-01-11 14:50:10 +01003807 MBEDTLS_SSL_DEBUG_BUF(4, "input record from network",
3808 rec->buf, rec->buf_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00003809
Ronald Cron7e38cba2021-11-24 12:43:39 +01003810 /*
3811 * In TLS 1.3, always treat ChangeCipherSpec records
3812 * as unencrypted. The only thing we do with them is
3813 * check the length and content and ignore them.
3814 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003815#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003816 if (ssl->transform_in != NULL &&
3817 ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3818 if (rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01003819 done = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003820 }
Ronald Cron7e38cba2021-11-24 12:43:39 +01003821 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003822#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003823
Gilles Peskine449bd832023-01-11 14:50:10 +01003824 if (!done && ssl->transform_in != NULL) {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003825 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003826
Gilles Peskine449bd832023-01-11 14:50:10 +01003827 if ((ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in,
3828 rec)) != 0) {
3829 MBEDTLS_SSL_DEBUG_RET(1, "ssl_decrypt_buf", ret);
Hanno Becker8367ccc2019-05-14 11:30:10 +01003830
Ronald Cron2995d352024-01-18 16:59:39 +01003831#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
3832 /*
3833 * Although the server rejected early data, it might receive early
3834 * data as long as it has not received the client Finished message.
3835 * It is encrypted with early keys and should be ignored as stated
3836 * in section 4.2.10 of RFC 8446:
3837 *
3838 * "Ignore the extension and return a regular 1-RTT response. The
3839 * server then skips past early data by attempting to deprotect
3840 * received records using the handshake traffic key, discarding
3841 * records which fail deprotection (up to the configured
3842 * max_early_data_size). Once a record is deprotected successfully,
3843 * it is treated as the start of the client's second flight and the
3844 * server proceeds as with an ordinary 1-RTT handshake."
3845 */
3846 if ((old_msg_type == MBEDTLS_SSL_MSG_APPLICATION_DATA) &&
3847 (ssl->discard_early_data_record ==
3848 MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD)) {
3849 MBEDTLS_SSL_DEBUG_MSG(
3850 3, ("EarlyData: deprotect and discard app data records."));
Ronald Cron919e5962024-02-08 15:48:29 +01003851
3852 ret = mbedtls_ssl_tls13_check_early_data_len(ssl, rec->data_len);
3853 if (ret != 0) {
3854 return ret;
3855 }
Ronald Cron2995d352024-01-18 16:59:39 +01003856 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3857 }
3858#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
3859
Hanno Beckera0e20d02019-05-15 14:03:01 +01003860#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01003861 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
Hanno Becker8367ccc2019-05-14 11:30:10 +01003862 ssl->conf->ignore_unexpected_cid
Gilles Peskine449bd832023-01-11 14:50:10 +01003863 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
3864 MBEDTLS_SSL_DEBUG_MSG(3, ("ignoring unexpected CID"));
Hanno Becker16ded982019-05-08 13:02:55 +01003865 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003866 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003867#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01003868
Ronald Cron71c6e652024-02-05 16:48:10 +01003869 /*
3870 * The decryption of the record failed, no reason to ignore it,
3871 * return in error with the decryption error code.
3872 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003873 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003874 }
3875
Ronald Cron2995d352024-01-18 16:59:39 +01003876#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
3877 /*
3878 * If the server were discarding protected records that it fails to
3879 * deprotect because it has rejected early data, as we have just
3880 * deprotected successfully a record, the server has to resume normal
3881 * operation and fail the connection if the deprotection of a record
3882 * fails.
3883 */
3884 if (ssl->discard_early_data_record ==
3885 MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD) {
3886 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
3887 }
3888#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
3889
Gilles Peskine449bd832023-01-11 14:50:10 +01003890 if (old_msg_type != rec->type) {
3891 MBEDTLS_SSL_DEBUG_MSG(4, ("record type after decrypt (before %d): %d",
3892 old_msg_type, rec->type));
Hanno Becker6430faf2019-05-08 11:57:13 +01003893 }
3894
Gilles Peskine449bd832023-01-11 14:50:10 +01003895 MBEDTLS_SSL_DEBUG_BUF(4, "input payload after decrypt",
3896 rec->buf + rec->data_offset, rec->data_len);
Hanno Becker1c0c37f2018-08-07 14:29:29 +01003897
Hanno Beckera0e20d02019-05-15 14:03:01 +01003898#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01003899 /* We have already checked the record content type
3900 * in ssl_parse_record_header(), failing or silently
3901 * dropping the record in the case of an unknown type.
3902 *
3903 * Since with the use of CIDs, the record content type
3904 * might change during decryption, re-check the record
3905 * content type, but treat a failure as fatal this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003906 if (ssl_check_record_type(rec->type)) {
3907 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type"));
3908 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker6430faf2019-05-08 11:57:13 +01003909 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01003910#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01003911
Gilles Peskine449bd832023-01-11 14:50:10 +01003912 if (rec->data_len == 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003913#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003914 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
3915 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003916 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01003917 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid zero-length message type: %d", ssl->in_msgtype));
3918 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003919 }
3920#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3921
3922 ssl->nb_zero++;
3923
3924 /*
3925 * Three or more empty messages may be a DoS attack
3926 * (excessive CPU consumption).
3927 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003928 if (ssl->nb_zero > 3) {
3929 MBEDTLS_SSL_DEBUG_MSG(1, ("received four consecutive empty "
3930 "messages, possible DoS attack"));
Hanno Becker6e7700d2019-05-08 10:38:32 +01003931 /* Treat the records as if they were not properly authenticated,
3932 * thereby failing the connection if we see more than allowed
3933 * by the configured bad MAC threshold. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003934 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003935 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003936 } else {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003937 ssl->nb_zero = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003938 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003939
3940#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003941 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003942 ; /* in_ctr read from peer, not maintained internally */
Gilles Peskine449bd832023-01-11 14:50:10 +01003943 } else
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003944#endif
3945 {
3946 unsigned i;
Gilles Peskine449bd832023-01-11 14:50:10 +01003947 for (i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
3948 i > mbedtls_ssl_ep_len(ssl); i--) {
3949 if (++ssl->in_ctr[i - 1] != 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003950 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003951 }
Jerry Yuae0b2e22021-10-08 15:21:19 +08003952 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003953
3954 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01003955 if (i == mbedtls_ssl_ep_len(ssl)) {
3956 MBEDTLS_SSL_DEBUG_MSG(1, ("incoming message counter would wrap"));
3957 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003958 }
3959 }
3960
Paul Bakker5121ce52009-01-03 21:22:43 +00003961 }
3962
Jerry Yuf57d14b2023-11-15 16:40:09 +08003963#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_SRV_C)
3964 /*
3965 * Although the server rejected early data because it needed to send an
3966 * HelloRetryRequest message, it might receive early data as long as it has
3967 * not received the client Finished message.
3968 * The early data is encrypted with early keys and should be ignored as
3969 * stated in section 4.2.10 of RFC 8446 (second case):
3970 *
3971 * "The server then ignores early data by skipping all records with an
3972 * external content type of "application_data" (indicating that they are
3973 * encrypted), up to the configured max_early_data_size. Ignore application
3974 * data message before 2nd ClientHello when early_data was received in 1st
3975 * ClientHello."
3976 */
3977 if (ssl->discard_early_data_record == MBEDTLS_SSL_EARLY_DATA_DISCARD) {
3978 if (rec->type == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Ronald Cron01d273d2024-02-09 16:17:10 +01003979
3980 ret = mbedtls_ssl_tls13_check_early_data_len(ssl, rec->data_len);
3981 if (ret != 0) {
3982 return ret;
3983 }
3984
Jerry Yuf57d14b2023-11-15 16:40:09 +08003985 MBEDTLS_SSL_DEBUG_MSG(
3986 3, ("EarlyData: Ignore application message before 2nd ClientHello"));
Ronald Crondb944a72024-03-08 11:32:53 +01003987
Jerry Yuf57d14b2023-11-15 16:40:09 +08003988 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
3989 } else if (rec->type == MBEDTLS_SSL_MSG_HANDSHAKE) {
3990 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
3991 }
3992 }
3993#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_SRV_C */
3994
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003995#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003996 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3997 mbedtls_ssl_dtls_replay_update(ssl);
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02003998 }
3999#endif
4000
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004001 /* Check actual (decrypted) record content length against
4002 * configured maximum. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004003 if (rec->data_len > MBEDTLS_SSL_IN_CONTENT_LEN) {
4004 MBEDTLS_SSL_DEBUG_MSG(1, ("bad message length"));
4005 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004006 }
4007
Gilles Peskine449bd832023-01-11 14:50:10 +01004008 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004009}
4010
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004011/*
4012 * Read a record.
4013 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004014 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
4015 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
4016 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004017 */
Hanno Becker1097b342018-08-15 14:09:41 +01004018
4019/* Helper functions for mbedtls_ssl_read_record(). */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004020MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004021static int ssl_consume_current_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004022MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004023static int ssl_get_next_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004024MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004025static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl);
Hanno Becker4162b112018-08-15 14:05:04 +01004026
Gilles Peskine449bd832023-01-11 14:50:10 +01004027int mbedtls_ssl_read_record(mbedtls_ssl_context *ssl,
4028 unsigned update_hs_digest)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004029{
Janos Follath865b3eb2019-12-16 11:46:15 +00004030 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004031
Gilles Peskine449bd832023-01-11 14:50:10 +01004032 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read record"));
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004033
Gilles Peskine449bd832023-01-11 14:50:10 +01004034 if (ssl->keep_current_message == 0) {
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004035 do {
Simon Butcher99000142016-10-13 17:21:01 +01004036
Gilles Peskine449bd832023-01-11 14:50:10 +01004037 ret = ssl_consume_current_message(ssl);
4038 if (ret != 0) {
4039 return ret;
4040 }
Hanno Becker26994592018-08-15 14:14:59 +01004041
Gilles Peskine449bd832023-01-11 14:50:10 +01004042 if (ssl_record_is_in_progress(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004043 int dtls_have_buffered = 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004044#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere74d5562018-08-15 14:26:08 +01004045
Hanno Becker40f50842018-08-15 14:48:01 +01004046 /* We only check for buffered messages if the
4047 * current datagram is fully consumed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004048 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4049 ssl_next_record_is_in_datagram(ssl) == 0) {
4050 if (ssl_load_buffered_message(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004051 dtls_have_buffered = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004052 }
Hanno Becker40f50842018-08-15 14:48:01 +01004053 }
4054
Hanno Becker40f50842018-08-15 14:48:01 +01004055#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004056 if (dtls_have_buffered == 0) {
4057 ret = ssl_get_next_record(ssl);
4058 if (ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING) {
Hanno Becker40f50842018-08-15 14:48:01 +01004059 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01004060 }
Hanno Becker40f50842018-08-15 14:48:01 +01004061
Gilles Peskine449bd832023-01-11 14:50:10 +01004062 if (ret != 0) {
4063 MBEDTLS_SSL_DEBUG_RET(1, ("ssl_get_next_record"), ret);
4064 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004065 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004066 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004067 }
4068
Gilles Peskine449bd832023-01-11 14:50:10 +01004069 ret = mbedtls_ssl_handle_message_type(ssl);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004070
Hanno Becker40f50842018-08-15 14:48:01 +01004071#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004072 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
Hanno Becker40f50842018-08-15 14:48:01 +01004073 /* Buffer future message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004074 ret = ssl_buffer_message(ssl);
4075 if (ret != 0) {
4076 return ret;
4077 }
Hanno Becker40f50842018-08-15 14:48:01 +01004078
4079 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4080 }
4081#endif /* MBEDTLS_SSL_PROTO_DTLS */
4082
Gilles Peskine449bd832023-01-11 14:50:10 +01004083 } while (MBEDTLS_ERR_SSL_NON_FATAL == ret ||
4084 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004085
Gilles Peskine449bd832023-01-11 14:50:10 +01004086 if (0 != ret) {
4087 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_handle_message_type"), ret);
4088 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004089 }
4090
Gilles Peskine449bd832023-01-11 14:50:10 +01004091 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
4092 update_hs_digest == 1) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01004093 ret = mbedtls_ssl_update_handshake_status(ssl);
4094 if (0 != ret) {
4095 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_update_handshake_status"), ret);
4096 return ret;
4097 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004098 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004099 } else {
4100 MBEDTLS_SSL_DEBUG_MSG(2, ("reuse previously read message"));
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004101 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004102 }
4103
Gilles Peskine449bd832023-01-11 14:50:10 +01004104 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read record"));
Simon Butcher99000142016-10-13 17:21:01 +01004105
Gilles Peskine449bd832023-01-11 14:50:10 +01004106 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004107}
4108
Hanno Becker40f50842018-08-15 14:48:01 +01004109#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004110MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004111static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004112{
Gilles Peskine449bd832023-01-11 14:50:10 +01004113 if (ssl->in_left > ssl->next_record_offset) {
4114 return 1;
4115 }
Simon Butcher99000142016-10-13 17:21:01 +01004116
Gilles Peskine449bd832023-01-11 14:50:10 +01004117 return 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004118}
4119
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004120MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004121static int ssl_load_buffered_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004122{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004123 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004124 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004125 int ret = 0;
4126
Gilles Peskine449bd832023-01-11 14:50:10 +01004127 if (hs == NULL) {
4128 return -1;
4129 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004130
Gilles Peskine449bd832023-01-11 14:50:10 +01004131 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_message"));
Hanno Beckere00ae372018-08-20 09:39:42 +01004132
Gilles Peskine449bd832023-01-11 14:50:10 +01004133 if (ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4134 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004135 /* Check if we have seen a ChangeCipherSpec before.
4136 * If yes, synthesize a CCS record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004137 if (!hs->buffering.seen_ccs) {
4138 MBEDTLS_SSL_DEBUG_MSG(2, ("CCS not seen in the current flight"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004139 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004140 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004141 }
4142
Gilles Peskine449bd832023-01-11 14:50:10 +01004143 MBEDTLS_SSL_DEBUG_MSG(2, ("Injecting buffered CCS message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004144 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4145 ssl->in_msglen = 1;
4146 ssl->in_msg[0] = 1;
4147
4148 /* As long as they are equal, the exact value doesn't matter. */
4149 ssl->in_left = 0;
4150 ssl->next_record_offset = 0;
4151
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004152 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004153 goto exit;
4154 }
Hanno Becker37f95322018-08-16 13:55:32 +01004155
Hanno Beckerb8f50142018-08-28 10:01:34 +01004156#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004157 /* Debug only */
4158 {
4159 unsigned offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004160 for (offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
Hanno Becker37f95322018-08-16 13:55:32 +01004161 hs_buf = &hs->buffering.hs[offset];
Gilles Peskine449bd832023-01-11 14:50:10 +01004162 if (hs_buf->is_valid == 1) {
4163 MBEDTLS_SSL_DEBUG_MSG(2, ("Future message with sequence number %u %s buffered.",
4164 hs->in_msg_seq + offset,
4165 hs_buf->is_complete ? "fully" : "partially"));
Hanno Becker37f95322018-08-16 13:55:32 +01004166 }
4167 }
4168 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004169#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004170
4171 /* Check if we have buffered and/or fully reassembled the
4172 * next handshake message. */
4173 hs_buf = &hs->buffering.hs[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01004174 if ((hs_buf->is_valid == 1) && (hs_buf->is_complete == 1)) {
Hanno Becker37f95322018-08-16 13:55:32 +01004175 /* Synthesize a record containing the buffered HS message. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004176 size_t msg_len = MBEDTLS_GET_UINT24_BE(hs_buf->data, 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004177
4178 /* Double-check that we haven't accidentally buffered
4179 * a message that doesn't fit into the input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004180 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
4181 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4182 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004183 }
4184
Gilles Peskine449bd832023-01-11 14:50:10 +01004185 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message has been buffered - load"));
4186 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered handshake message (incl. header)",
4187 hs_buf->data, msg_len + 12);
Hanno Becker37f95322018-08-16 13:55:32 +01004188
4189 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4190 ssl->in_hslen = msg_len + 12;
4191 ssl->in_msglen = msg_len + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01004192 memcpy(ssl->in_msg, hs_buf->data, ssl->in_hslen);
Hanno Becker37f95322018-08-16 13:55:32 +01004193
4194 ret = 0;
4195 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004196 } else {
4197 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message %u not or only partially bufffered",
4198 hs->in_msg_seq));
Hanno Becker37f95322018-08-16 13:55:32 +01004199 }
4200
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004201 ret = -1;
4202
4203exit:
4204
Gilles Peskine449bd832023-01-11 14:50:10 +01004205 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_message"));
4206 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004207}
4208
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004209MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004210static int ssl_buffer_make_space(mbedtls_ssl_context *ssl,
4211 size_t desired)
Hanno Beckera02b0b42018-08-21 17:20:27 +01004212{
4213 int offset;
4214 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004215 MBEDTLS_SSL_DEBUG_MSG(2, ("Attempt to free buffered messages to have %u bytes available",
4216 (unsigned) desired));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004217
Hanno Becker01315ea2018-08-21 17:22:17 +01004218 /* Get rid of future records epoch first, if such exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 ssl_free_buffered_record(ssl);
Hanno Becker01315ea2018-08-21 17:22:17 +01004220
4221 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004222 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4223 hs->buffering.total_bytes_buffered)) {
4224 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing future epoch record"));
4225 return 0;
Hanno Becker01315ea2018-08-21 17:22:17 +01004226 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004227
Hanno Becker4f432ad2018-08-28 10:02:32 +01004228 /* We don't have enough space to buffer the next expected handshake
4229 * message. Remove buffers used for future messages to gain space,
4230 * starting with the most distant one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 for (offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4232 offset >= 0; offset--) {
4233 MBEDTLS_SSL_DEBUG_MSG(2,
4234 (
4235 "Free buffering slot %d to make space for reassembly of next handshake message",
4236 offset));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004237
Gilles Peskine449bd832023-01-11 14:50:10 +01004238 ssl_buffering_free_slot(ssl, (uint8_t) offset);
Hanno Beckera02b0b42018-08-21 17:20:27 +01004239
4240 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004241 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4242 hs->buffering.total_bytes_buffered)) {
4243 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing buffered HS messages"));
4244 return 0;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004245 }
4246 }
4247
Gilles Peskine449bd832023-01-11 14:50:10 +01004248 return -1;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004249}
4250
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004251MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004252static int ssl_buffer_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004253{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004254 int ret = 0;
4255 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4256
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 if (hs == NULL) {
4258 return 0;
4259 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004260
Gilles Peskine449bd832023-01-11 14:50:10 +01004261 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_buffer_message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004262
Gilles Peskine449bd832023-01-11 14:50:10 +01004263 switch (ssl->in_msgtype) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004264 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
Gilles Peskine449bd832023-01-11 14:50:10 +01004265 MBEDTLS_SSL_DEBUG_MSG(2, ("Remember CCS message"));
Hanno Beckere678eaa2018-08-21 14:57:46 +01004266
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004267 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004268 break;
4269
4270 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004271 {
4272 unsigned recv_msg_seq_offset;
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004273 unsigned recv_msg_seq = MBEDTLS_GET_UINT16_BE(ssl->in_msg, 4);
Hanno Becker37f95322018-08-16 13:55:32 +01004274 mbedtls_ssl_hs_buffer *hs_buf;
4275 size_t msg_len = ssl->in_hslen - 12;
4276
4277 /* We should never receive an old handshake
4278 * message - double-check nonetheless. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004279 if (recv_msg_seq < ssl->handshake->in_msg_seq) {
4280 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4281 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004282 }
4283
4284 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
Gilles Peskine449bd832023-01-11 14:50:10 +01004285 if (recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Becker37f95322018-08-16 13:55:32 +01004286 /* Silently ignore -- message too far in the future */
Gilles Peskine449bd832023-01-11 14:50:10 +01004287 MBEDTLS_SSL_DEBUG_MSG(2,
4288 ("Ignore future HS message with sequence number %u, "
4289 "buffering window %u - %u",
4290 recv_msg_seq, ssl->handshake->in_msg_seq,
4291 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS -
4292 1));
Hanno Becker37f95322018-08-16 13:55:32 +01004293
4294 goto exit;
4295 }
4296
Gilles Peskine449bd832023-01-11 14:50:10 +01004297 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering HS message with sequence number %u, offset %u ",
4298 recv_msg_seq, recv_msg_seq_offset));
Hanno Becker37f95322018-08-16 13:55:32 +01004299
Gilles Peskine449bd832023-01-11 14:50:10 +01004300 hs_buf = &hs->buffering.hs[recv_msg_seq_offset];
Hanno Becker37f95322018-08-16 13:55:32 +01004301
4302 /* Check if the buffering for this seq nr has already commenced. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004303 if (!hs_buf->is_valid) {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004304 size_t reassembly_buf_sz;
4305
Hanno Becker37f95322018-08-16 13:55:32 +01004306 hs_buf->is_fragmented =
Gilles Peskine449bd832023-01-11 14:50:10 +01004307 (ssl_hs_is_proper_fragment(ssl) == 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004308
4309 /* We copy the message back into the input buffer
4310 * after reassembly, so check that it's not too large.
4311 * This is an implementation-specific limitation
4312 * and not one from the standard, hence it is not
4313 * checked in ssl_check_hs_header(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004314 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
Hanno Becker37f95322018-08-16 13:55:32 +01004315 /* Ignore message */
4316 goto exit;
4317 }
4318
Hanno Beckere0b150f2018-08-21 15:51:03 +01004319 /* Check if we have enough space to buffer the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004320 if (hs->buffering.total_bytes_buffered >
4321 MBEDTLS_SSL_DTLS_MAX_BUFFERING) {
4322 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4323 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004324 }
4325
Gilles Peskine449bd832023-01-11 14:50:10 +01004326 reassembly_buf_sz = ssl_get_reassembly_buffer_size(msg_len,
4327 hs_buf->is_fragmented);
Hanno Beckere0b150f2018-08-21 15:51:03 +01004328
Gilles Peskine449bd832023-01-11 14:50:10 +01004329 if (reassembly_buf_sz > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4330 hs->buffering.total_bytes_buffered)) {
4331 if (recv_msg_seq_offset > 0) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004332 /* If we can't buffer a future message because
4333 * of space limitations -- ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004334 MBEDTLS_SSL_DEBUG_MSG(2,
4335 ("Buffering of future message of size %"
4336 MBEDTLS_PRINTF_SIZET
4337 " would exceed the compile-time limit %"
4338 MBEDTLS_PRINTF_SIZET
4339 " (already %" MBEDTLS_PRINTF_SIZET
4340 " bytes buffered) -- ignore\n",
4341 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4342 hs->buffering.total_bytes_buffered));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004343 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004344 } else {
4345 MBEDTLS_SSL_DEBUG_MSG(2,
4346 ("Buffering of future message of size %"
4347 MBEDTLS_PRINTF_SIZET
4348 " would exceed the compile-time limit %"
4349 MBEDTLS_PRINTF_SIZET
4350 " (already %" MBEDTLS_PRINTF_SIZET
4351 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
4352 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4353 hs->buffering.total_bytes_buffered));
Hanno Beckere1801392018-08-21 16:51:05 +01004354 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004355
Gilles Peskine449bd832023-01-11 14:50:10 +01004356 if (ssl_buffer_make_space(ssl, reassembly_buf_sz) != 0) {
4357 MBEDTLS_SSL_DEBUG_MSG(2,
4358 ("Reassembly of next message of size %"
4359 MBEDTLS_PRINTF_SIZET
4360 " (%" MBEDTLS_PRINTF_SIZET
4361 " with bitmap) would exceed"
4362 " the compile-time limit %"
4363 MBEDTLS_PRINTF_SIZET
4364 " (already %" MBEDTLS_PRINTF_SIZET
4365 " bytes buffered) -- fail\n",
4366 msg_len,
4367 reassembly_buf_sz,
4368 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4369 hs->buffering.total_bytes_buffered));
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004370 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4371 goto exit;
4372 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004373 }
4374
Gilles Peskine449bd832023-01-11 14:50:10 +01004375 MBEDTLS_SSL_DEBUG_MSG(2,
4376 ("initialize reassembly, total length = %"
4377 MBEDTLS_PRINTF_SIZET,
4378 msg_len));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004379
Gilles Peskine449bd832023-01-11 14:50:10 +01004380 hs_buf->data = mbedtls_calloc(1, reassembly_buf_sz);
4381 if (hs_buf->data == NULL) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004382 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004383 goto exit;
4384 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004385 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004386
4387 /* Prepare final header: copy msg_type, length and message_seq,
4388 * then add standardised fragment_offset and fragment_length */
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 memcpy(hs_buf->data, ssl->in_msg, 6);
4390 memset(hs_buf->data + 6, 0, 3);
4391 memcpy(hs_buf->data + 9, hs_buf->data + 1, 3);
Hanno Becker37f95322018-08-16 13:55:32 +01004392
4393 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004394
4395 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Gilles Peskine449bd832023-01-11 14:50:10 +01004396 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004397 /* Make sure msg_type and length are consistent */
Gilles Peskine449bd832023-01-11 14:50:10 +01004398 if (memcmp(hs_buf->data, ssl->in_msg, 4) != 0) {
4399 MBEDTLS_SSL_DEBUG_MSG(1, ("Fragment header mismatch - ignore"));
Hanno Becker37f95322018-08-16 13:55:32 +01004400 /* Ignore */
4401 goto exit;
4402 }
4403 }
4404
Gilles Peskine449bd832023-01-11 14:50:10 +01004405 if (!hs_buf->is_complete) {
Hanno Becker37f95322018-08-16 13:55:32 +01004406 size_t frag_len, frag_off;
4407 unsigned char * const msg = hs_buf->data + 12;
4408
4409 /*
4410 * Check and copy current fragment
4411 */
4412
4413 /* Validation of header fields already done in
4414 * mbedtls_ssl_prepare_handshake_record(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004415 frag_off = ssl_get_hs_frag_off(ssl);
4416 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker37f95322018-08-16 13:55:32 +01004417
Gilles Peskine449bd832023-01-11 14:50:10 +01004418 MBEDTLS_SSL_DEBUG_MSG(2, ("adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4419 ", length = %" MBEDTLS_PRINTF_SIZET,
4420 frag_off, frag_len));
4421 memcpy(msg + frag_off, ssl->in_msg + 12, frag_len);
Hanno Becker37f95322018-08-16 13:55:32 +01004422
Gilles Peskine449bd832023-01-11 14:50:10 +01004423 if (hs_buf->is_fragmented) {
Hanno Becker37f95322018-08-16 13:55:32 +01004424 unsigned char * const bitmask = msg + msg_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004425 ssl_bitmask_set(bitmask, frag_off, frag_len);
4426 hs_buf->is_complete = (ssl_bitmask_check(bitmask,
4427 msg_len) == 0);
4428 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004429 hs_buf->is_complete = 1;
4430 }
4431
Gilles Peskine449bd832023-01-11 14:50:10 +01004432 MBEDTLS_SSL_DEBUG_MSG(2, ("message %scomplete",
4433 hs_buf->is_complete ? "" : "not yet "));
Hanno Becker37f95322018-08-16 13:55:32 +01004434 }
4435
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004436 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004437 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004438
4439 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004440 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004441 break;
4442 }
4443
4444exit:
4445
Gilles Peskine449bd832023-01-11 14:50:10 +01004446 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_buffer_message"));
4447 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004448}
4449#endif /* MBEDTLS_SSL_PROTO_DTLS */
4450
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004451MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004452static int ssl_consume_current_message(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004453{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004454 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004455 * Consume last content-layer message and potentially
4456 * update in_msglen which keeps track of the contents'
4457 * consumption state.
4458 *
4459 * (1) Handshake messages:
4460 * Remove last handshake message, move content
4461 * and adapt in_msglen.
4462 *
4463 * (2) Alert messages:
4464 * Consume whole record content, in_msglen = 0.
4465 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004466 * (3) Change cipher spec:
4467 * Consume whole record content, in_msglen = 0.
4468 *
4469 * (4) Application data:
4470 * Don't do anything - the record layer provides
4471 * the application data as a stream transport
4472 * and consumes through mbedtls_ssl_read only.
4473 *
4474 */
4475
4476 /* Case (1): Handshake messages */
Gilles Peskine449bd832023-01-11 14:50:10 +01004477 if (ssl->in_hslen != 0) {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004478 /* Hard assertion to be sure that no application data
4479 * is in flight, as corrupting ssl->in_msglen during
4480 * ssl->in_offt != NULL is fatal. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004481 if (ssl->in_offt != NULL) {
4482 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4483 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004484 }
4485
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00004486 if (ssl->in_hsfraglen != 0) {
4487 /* Not all handshake fragments have arrived, do not consume. */
Gilles Peskine9bdc8aa2025-02-28 21:29:59 +01004488 MBEDTLS_SSL_DEBUG_MSG(3, ("Consume: waiting for more handshake fragments %"
4489 MBEDTLS_PRINTF_SIZET "/%" MBEDTLS_PRINTF_SIZET,
4490 ssl->in_hsfraglen, ssl->in_hslen));
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00004491 return 0;
4492 }
4493
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004494 /*
4495 * Get next Handshake message in the current record
4496 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004497
Hanno Becker4a810fb2017-05-24 16:27:30 +01004498 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004499 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004500 * current handshake content: If DTLS handshake
4501 * fragmentation is used, that's the fragment
4502 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004503 * size here is faulty and should be changed at
4504 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004505 * (2) While it doesn't seem to cause problems, one
4506 * has to be very careful not to assume that in_hslen
4507 * is always <= in_msglen in a sensible communication.
4508 * Again, it's wrong for DTLS handshake fragmentation.
4509 * The following check is therefore mandatory, and
4510 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004511 * Additionally, ssl->in_hslen might be arbitrarily out of
4512 * bounds after handling a DTLS message with an unexpected
4513 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004514 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 if (ssl->in_hslen < ssl->in_msglen) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004516 ssl->in_msglen -= ssl->in_hslen;
Gilles Peskine449bd832023-01-11 14:50:10 +01004517 memmove(ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4518 ssl->in_msglen);
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00004519 MBEDTLS_PUT_UINT16_BE(ssl->in_msglen, ssl->in_len, 0);
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004520
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 MBEDTLS_SSL_DEBUG_BUF(4, "remaining content in record",
4522 ssl->in_msg, ssl->in_msglen);
4523 } else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004524 ssl->in_msglen = 0;
4525 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004526
Hanno Becker4a810fb2017-05-24 16:27:30 +01004527 ssl->in_hslen = 0;
4528 }
4529 /* Case (4): Application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004530 else if (ssl->in_offt != NULL) {
4531 return 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01004532 }
4533 /* Everything else (CCS & Alerts) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004535 ssl->in_msglen = 0;
4536 }
4537
Gilles Peskine449bd832023-01-11 14:50:10 +01004538 return 0;
Hanno Becker1097b342018-08-15 14:09:41 +01004539}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004540
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004541MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004542static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl)
Hanno Beckere74d5562018-08-15 14:26:08 +01004543{
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 if (ssl->in_msglen > 0) {
4545 return 1;
4546 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004547
Gilles Peskine449bd832023-01-11 14:50:10 +01004548 return 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01004549}
4550
Hanno Becker5f066e72018-08-16 14:56:31 +01004551#if defined(MBEDTLS_SSL_PROTO_DTLS)
4552
Gilles Peskine449bd832023-01-11 14:50:10 +01004553static void ssl_free_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004554{
4555 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004556 if (hs == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004557 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004559
Gilles Peskine449bd832023-01-11 14:50:10 +01004560 if (hs->buffering.future_record.data != NULL) {
Hanno Becker01315ea2018-08-21 17:22:17 +01004561 hs->buffering.total_bytes_buffered -=
4562 hs->buffering.future_record.len;
4563
Gilles Peskine449bd832023-01-11 14:50:10 +01004564 mbedtls_free(hs->buffering.future_record.data);
Hanno Becker01315ea2018-08-21 17:22:17 +01004565 hs->buffering.future_record.data = NULL;
4566 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004567}
4568
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004569MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004570static int ssl_load_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004571{
4572 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004573 unsigned char *rec;
Hanno Becker5f066e72018-08-16 14:56:31 +01004574 size_t rec_len;
4575 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004576#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4577 size_t in_buf_len = ssl->in_buf_len;
4578#else
4579 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4580#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4582 return 0;
4583 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004584
Gilles Peskine449bd832023-01-11 14:50:10 +01004585 if (hs == NULL) {
4586 return 0;
4587 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004588
Hanno Becker5f066e72018-08-16 14:56:31 +01004589 rec = hs->buffering.future_record.data;
4590 rec_len = hs->buffering.future_record.len;
4591 rec_epoch = hs->buffering.future_record.epoch;
4592
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 if (rec == NULL) {
4594 return 0;
4595 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004596
Hanno Becker4cb782d2018-08-20 11:19:05 +01004597 /* Only consider loading future records if the
4598 * input buffer is empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004599 if (ssl_next_record_is_in_datagram(ssl) == 1) {
4600 return 0;
4601 }
Hanno Becker4cb782d2018-08-20 11:19:05 +01004602
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_record"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004604
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 if (rec_epoch != ssl->in_epoch) {
4606 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffered record not from current epoch."));
Hanno Becker5f066e72018-08-16 14:56:31 +01004607 goto exit;
4608 }
4609
Gilles Peskine449bd832023-01-11 14:50:10 +01004610 MBEDTLS_SSL_DEBUG_MSG(2, ("Found buffered record from current epoch - load"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004611
4612 /* Double-check that the record is not too large */
Gilles Peskine449bd832023-01-11 14:50:10 +01004613 if (rec_len > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
4614 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4615 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker5f066e72018-08-16 14:56:31 +01004616 }
4617
Gilles Peskine449bd832023-01-11 14:50:10 +01004618 memcpy(ssl->in_hdr, rec, rec_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004619 ssl->in_left = rec_len;
4620 ssl->next_record_offset = 0;
4621
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 ssl_free_buffered_record(ssl);
Hanno Becker5f066e72018-08-16 14:56:31 +01004623
4624exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004625 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_record"));
4626 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004627}
4628
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004629MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004630static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
4631 mbedtls_record const *rec)
Hanno Becker5f066e72018-08-16 14:56:31 +01004632{
4633 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004634
4635 /* Don't buffer future records outside handshakes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004636 if (hs == NULL) {
4637 return 0;
4638 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004639
4640 /* Only buffer handshake records (we are only interested
4641 * in Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004642 if (rec->type != MBEDTLS_SSL_MSG_HANDSHAKE) {
4643 return 0;
4644 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004645
4646 /* Don't buffer more than one future epoch record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 if (hs->buffering.future_record.data != NULL) {
4648 return 0;
4649 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004650
Hanno Becker01315ea2018-08-21 17:22:17 +01004651 /* Don't buffer record if there's not enough buffering space remaining. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004652 if (rec->buf_len > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4653 hs->buffering.total_bytes_buffered)) {
4654 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4655 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4656 " (already %" MBEDTLS_PRINTF_SIZET
4657 " bytes buffered) -- ignore\n",
4658 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4659 hs->buffering.total_bytes_buffered));
4660 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004661 }
4662
Hanno Becker5f066e72018-08-16 14:56:31 +01004663 /* Buffer record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004664 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffer record from epoch %u",
4665 ssl->in_epoch + 1U));
4666 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered record", rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004667
4668 /* ssl_parse_record_header() only considers records
4669 * of the next epoch as candidates for buffering. */
4670 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004671 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004672
4673 hs->buffering.future_record.data =
Gilles Peskine449bd832023-01-11 14:50:10 +01004674 mbedtls_calloc(1, hs->buffering.future_record.len);
4675 if (hs->buffering.future_record.data == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004676 /* If we run out of RAM trying to buffer a
4677 * record from the next epoch, just ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004678 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004679 }
4680
Gilles Peskine449bd832023-01-11 14:50:10 +01004681 memcpy(hs->buffering.future_record.data, rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004682
Hanno Becker519f15d2019-07-11 12:43:20 +01004683 hs->buffering.total_bytes_buffered += rec->buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004684 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004685}
4686
4687#endif /* MBEDTLS_SSL_PROTO_DTLS */
4688
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004689MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004690static int ssl_get_next_record(mbedtls_ssl_context *ssl)
Hanno Becker1097b342018-08-15 14:09:41 +01004691{
Janos Follath865b3eb2019-12-16 11:46:15 +00004692 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004693 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004694
Hanno Becker5f066e72018-08-16 14:56:31 +01004695#if defined(MBEDTLS_SSL_PROTO_DTLS)
4696 /* We might have buffered a future record; if so,
4697 * and if the epoch matches now, load it.
4698 * On success, this call will set ssl->in_left to
4699 * the length of the buffered record, so that
4700 * the calls to ssl_fetch_input() below will
4701 * essentially be no-ops. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004702 ret = ssl_load_buffered_record(ssl);
4703 if (ret != 0) {
4704 return ret;
4705 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004706#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004707
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004708 /* Ensure that we have enough space available for the default form
4709 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4710 * with no space for CIDs counted in). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004711 ret = mbedtls_ssl_fetch_input(ssl, mbedtls_ssl_in_hdr_len(ssl));
4712 if (ret != 0) {
4713 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4714 return ret;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004715 }
4716
Gilles Peskine449bd832023-01-11 14:50:10 +01004717 ret = ssl_parse_record_header(ssl, ssl->in_hdr, ssl->in_left, &rec);
4718 if (ret != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004719#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004720 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4721 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
4722 ret = ssl_buffer_future_record(ssl, &rec);
4723 if (ret != 0) {
4724 return ret;
4725 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004726
4727 /* Fall through to handling of unexpected records */
4728 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4729 }
4730
Gilles Peskine449bd832023-01-11 14:50:10 +01004731 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD) {
Hanno Becker2fddd372019-07-10 14:37:41 +01004732#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004733 /* Reset in pointers to default state for TLS/DTLS records,
4734 * assuming no CID and no offset between record content and
4735 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 mbedtls_ssl_update_in_pointers(ssl);
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004737
Hanno Becker7ae20e02019-07-12 08:33:49 +01004738 /* Setup internal message pointers from record structure. */
4739 ssl->in_msgtype = rec.type;
4740#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4741 ssl->in_len = ssl->in_cid + rec.cid_len;
4742#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4743 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4744 ssl->in_msglen = rec.data_len;
4745
Gilles Peskine449bd832023-01-11 14:50:10 +01004746 ret = ssl_check_client_reconnect(ssl);
4747 MBEDTLS_SSL_DEBUG_RET(2, "ssl_check_client_reconnect", ret);
4748 if (ret != 0) {
4749 return ret;
4750 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004751#endif
4752
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004753 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004754 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004755
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding unexpected record "
4757 "(header)"));
4758 } else {
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004759 /* Skip invalid record and the rest of the datagram */
4760 ssl->next_record_offset = 0;
4761 ssl->in_left = 0;
4762
Gilles Peskine449bd832023-01-11 14:50:10 +01004763 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record "
4764 "(header)"));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004765 }
4766
4767 /* Get next record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004768 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4769 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004770#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004771 {
Gilles Peskine449bd832023-01-11 14:50:10 +01004772 return ret;
Hanno Becker2fddd372019-07-10 14:37:41 +01004773 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004774 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004775
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004776#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckera8814792019-07-10 15:01:45 +01004778 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004779 ssl->next_record_offset = rec.buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004780 if (ssl->next_record_offset < ssl->in_left) {
4781 MBEDTLS_SSL_DEBUG_MSG(3, ("more than one record within datagram"));
Hanno Beckere65ce782017-05-22 14:47:48 +01004782 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004783 } else
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004784#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004785 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004786 /*
4787 * Fetch record contents from underlying transport.
4788 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004789 ret = mbedtls_ssl_fetch_input(ssl, rec.buf_len);
4790 if (ret != 0) {
4791 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4792 return ret;
Hanno Beckera8814792019-07-10 15:01:45 +01004793 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004794
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004795 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004796 }
4797
4798 /*
4799 * Decrypt record contents.
4800 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004801
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 if ((ret = ssl_prepare_record_content(ssl, &rec)) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004803#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004805 /* Silently discard invalid records */
Gilles Peskine449bd832023-01-11 14:50:10 +01004806 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004807 /* Except when waiting for Finished as a bad mac here
4808 * probably means something went wrong in the handshake
4809 * (eg wrong psk used, mitm downgrade attempt, etc.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 if (ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4811 ssl->state == MBEDTLS_SSL_SERVER_FINISHED) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004812#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4814 mbedtls_ssl_send_alert_message(ssl,
4815 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4816 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004817 }
4818#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004819 return ret;
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004820 }
4821
Gilles Peskine449bd832023-01-11 14:50:10 +01004822 if (ssl->conf->badmac_limit != 0 &&
4823 ++ssl->badmac_seen >= ssl->conf->badmac_limit) {
4824 MBEDTLS_SSL_DEBUG_MSG(1, ("too many records with bad MAC"));
4825 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004826 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004827
Hanno Becker4a810fb2017-05-24 16:27:30 +01004828 /* As above, invalid records cause
4829 * dismissal of the whole datagram. */
4830
4831 ssl->next_record_offset = 0;
4832 ssl->in_left = 0;
4833
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record (mac)"));
4835 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004836 }
4837
Gilles Peskine449bd832023-01-11 14:50:10 +01004838 return ret;
4839 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004840#endif
4841 {
4842 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004843#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004844 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4845 mbedtls_ssl_send_alert_message(ssl,
4846 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4847 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004848 }
4849#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 return ret;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004851 }
4852 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004853
Hanno Becker44d89b22019-07-12 09:40:44 +01004854
4855 /* Reset in pointers to default state for TLS/DTLS records,
4856 * assuming no CID and no offset between record content and
4857 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004858 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker44d89b22019-07-12 09:40:44 +01004859#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4860 ssl->in_len = ssl->in_cid + rec.cid_len;
4861#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004862 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004863
Hanno Becker8685c822019-07-12 09:37:30 +01004864 /* The record content type may change during decryption,
4865 * so re-read it. */
4866 ssl->in_msgtype = rec.type;
4867 /* Also update the input buffer, because unfortunately
4868 * the server-side ssl_parse_client_hello() reparses the
4869 * record header when receiving a ClientHello initiating
4870 * a renegotiation. */
4871 ssl->in_hdr[0] = rec.type;
4872 ssl->in_msg = rec.buf + rec.data_offset;
4873 ssl->in_msglen = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->in_len, 0);
Hanno Becker8685c822019-07-12 09:37:30 +01004875
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004877}
4878
Gilles Peskine449bd832023-01-11 14:50:10 +01004879int mbedtls_ssl_handle_message_type(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004880{
Janos Follath865b3eb2019-12-16 11:46:15 +00004881 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004882
Manuel Pégourié-Gonnarde26a0602025-03-05 12:52:18 +01004883 /* If we're in the middle of a fragmented TLS handshake message,
4884 * we don't accept any other message type. For TLS 1.3, the spec forbids
4885 * interleaving other message types between handshake fragments. For TLS
4886 * 1.2, the spec does not forbid it but we do. */
4887 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM &&
4888 ssl->in_hsfraglen != 0 &&
4889 ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
4890 MBEDTLS_SSL_DEBUG_MSG(1, ("non-handshake message in the middle"
4891 " of a fragmented handshake message"));
4892 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
4893 }
4894
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004895 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004896 * Handle particular types of records
4897 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004898 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
4899 if ((ret = mbedtls_ssl_prepare_handshake_record(ssl)) != 0) {
4900 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004901 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004902 }
4903
Gilles Peskine449bd832023-01-11 14:50:10 +01004904 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
4905 if (ssl->in_msglen != 1) {
4906 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
4907 ssl->in_msglen));
4908 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004909 }
4910
Gilles Peskine449bd832023-01-11 14:50:10 +01004911 if (ssl->in_msg[0] != 1) {
4912 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, content: %02x",
4913 ssl->in_msg[0]));
4914 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004915 }
4916
4917#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004918 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere678eaa2018-08-21 14:57:46 +01004919 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01004920 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
4921 if (ssl->handshake == NULL) {
4922 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping ChangeCipherSpec outside handshake"));
4923 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004924 }
4925
Gilles Peskine449bd832023-01-11 14:50:10 +01004926 MBEDTLS_SSL_DEBUG_MSG(1, ("received out-of-order ChangeCipherSpec - remember"));
4927 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004928 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004929#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004930
Ronald Cron6f135e12021-12-08 16:57:54 +01004931#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine9ca9b922024-09-13 16:03:41 +02004933 MBEDTLS_SSL_DEBUG_MSG(2,
Gilles Peskine449bd832023-01-11 14:50:10 +01004934 ("Ignore ChangeCipherSpec in TLS 1.3 compatibility mode"));
4935 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Ronald Cron7e38cba2021-11-24 12:43:39 +01004936 }
Ronald Cron6f135e12021-12-08 16:57:54 +01004937#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01004938 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004939
Gilles Peskine449bd832023-01-11 14:50:10 +01004940 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
4941 if (ssl->in_msglen != 2) {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004942 /* Note: Standard allows for more than one 2 byte alert
4943 to be packed in a single message, but Mbed TLS doesn't
4944 currently support this. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004945 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
4946 ssl->in_msglen));
4947 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Angus Gratton1a7a17e2018-06-20 15:43:50 +10004948 }
4949
Gilles Peskine449bd832023-01-11 14:50:10 +01004950 MBEDTLS_SSL_DEBUG_MSG(2, ("got an alert message, type: [%u:%u]",
4951 ssl->in_msg[0], ssl->in_msg[1]));
Paul Bakker5121ce52009-01-03 21:22:43 +00004952
4953 /*
Simon Butcher459a9502015-10-27 16:09:03 +00004954 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00004955 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004956 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL) {
4957 MBEDTLS_SSL_DEBUG_MSG(1, ("is a fatal alert message (msg %d)",
4958 ssl->in_msg[1]));
4959 return MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00004960 }
4961
Gilles Peskine449bd832023-01-11 14:50:10 +01004962 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4963 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY) {
4964 MBEDTLS_SSL_DEBUG_MSG(2, ("is a close notify message"));
4965 return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY;
Paul Bakker5121ce52009-01-03 21:22:43 +00004966 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004967
4968#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004969 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
4970 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION) {
4971 MBEDTLS_SSL_DEBUG_MSG(2, ("is a no renegotiation alert"));
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004972 /* Will be handled when trying to parse ServerHello */
Gilles Peskine449bd832023-01-11 14:50:10 +01004973 return 0;
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004974 }
4975#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004976 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01004977 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00004978 }
4979
Hanno Beckerc76c6192017-06-06 10:03:17 +01004980#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004981 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker37ae9522019-05-03 16:54:26 +01004982 /* Drop unexpected ApplicationData records,
4983 * except at the beginning of renegotiations */
Gilles Peskine449bd832023-01-11 14:50:10 +01004984 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
4985 mbedtls_ssl_is_handshake_over(ssl) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01004986#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004987 && !(ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
4988 ssl->state == MBEDTLS_SSL_SERVER_HELLO)
Hanno Beckerc76c6192017-06-06 10:03:17 +01004989#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004990 ) {
4991 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping unexpected ApplicationData"));
4992 return MBEDTLS_ERR_SSL_NON_FATAL;
Hanno Becker37ae9522019-05-03 16:54:26 +01004993 }
4994
Gilles Peskine449bd832023-01-11 14:50:10 +01004995 if (ssl->handshake != NULL &&
4996 mbedtls_ssl_is_handshake_over(ssl) == 1) {
4997 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Hanno Becker37ae9522019-05-03 16:54:26 +01004998 }
4999 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01005000#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01005001
Gilles Peskine449bd832023-01-11 14:50:10 +01005002 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005003}
5004
Gilles Peskine449bd832023-01-11 14:50:10 +01005005int mbedtls_ssl_send_fatal_handshake_failure(mbedtls_ssl_context *ssl)
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005006{
Gilles Peskine449bd832023-01-11 14:50:10 +01005007 return mbedtls_ssl_send_alert_message(ssl,
5008 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5009 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE);
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005010}
5011
Gilles Peskine449bd832023-01-11 14:50:10 +01005012int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
5013 unsigned char level,
5014 unsigned char message)
Paul Bakker0a925182012-04-16 06:46:41 +00005015{
Janos Follath865b3eb2019-12-16 11:46:15 +00005016 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00005017
Gilles Peskine449bd832023-01-11 14:50:10 +01005018 if (ssl == NULL || ssl->conf == NULL) {
5019 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5020 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005021
Gilles Peskine449bd832023-01-11 14:50:10 +01005022 if (ssl->out_left != 0) {
5023 return mbedtls_ssl_flush_output(ssl);
5024 }
Hanno Becker5e18f742018-08-06 11:35:16 +01005025
Gilles Peskine449bd832023-01-11 14:50:10 +01005026 MBEDTLS_SSL_DEBUG_MSG(2, ("=> send alert message"));
5027 MBEDTLS_SSL_DEBUG_MSG(3, ("send alert level=%u message=%u", level, message));
Paul Bakker0a925182012-04-16 06:46:41 +00005028
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005029 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00005030 ssl->out_msglen = 2;
5031 ssl->out_msg[0] = level;
5032 ssl->out_msg[1] = message;
5033
Gilles Peskine449bd832023-01-11 14:50:10 +01005034 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5035 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5036 return ret;
Paul Bakker0a925182012-04-16 06:46:41 +00005037 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 MBEDTLS_SSL_DEBUG_MSG(2, ("<= send alert message"));
Paul Bakker0a925182012-04-16 06:46:41 +00005039
Gilles Peskine449bd832023-01-11 14:50:10 +01005040 return 0;
Paul Bakker0a925182012-04-16 06:46:41 +00005041}
5042
Gilles Peskine449bd832023-01-11 14:50:10 +01005043int mbedtls_ssl_write_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005044{
Janos Follath865b3eb2019-12-16 11:46:15 +00005045 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005046
Gilles Peskine449bd832023-01-11 14:50:10 +01005047 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005048
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005049 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00005050 ssl->out_msglen = 1;
5051 ssl->out_msg[0] = 1;
5052
Paul Bakker5121ce52009-01-03 21:22:43 +00005053 ssl->state++;
5054
Gilles Peskine449bd832023-01-11 14:50:10 +01005055 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
5056 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
5057 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005058 }
5059
Gilles Peskine449bd832023-01-11 14:50:10 +01005060 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005061
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005063}
5064
Gilles Peskine449bd832023-01-11 14:50:10 +01005065int mbedtls_ssl_parse_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005066{
Janos Follath865b3eb2019-12-16 11:46:15 +00005067 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005068
Gilles Peskine449bd832023-01-11 14:50:10 +01005069 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005070
Gilles Peskine449bd832023-01-11 14:50:10 +01005071 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5072 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5073 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005074 }
5075
Gilles Peskine449bd832023-01-11 14:50:10 +01005076 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
5077 MBEDTLS_SSL_DEBUG_MSG(1, ("bad change cipher spec message"));
5078 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5079 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
5080 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005081 }
5082
Hanno Beckere678eaa2018-08-21 14:57:46 +01005083 /* CCS records are only accepted if they have length 1 and content '1',
5084 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005085
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005086 /*
5087 * Switch to our negotiated transform and session parameters for inbound
5088 * data.
5089 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005090 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for inbound data"));
Jerry Yu2e199812022-12-01 18:57:19 +08005091#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005092 ssl->transform_in = ssl->transform_negotiate;
Jerry Yu2e199812022-12-01 18:57:19 +08005093#endif
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005094 ssl->session_in = ssl->session_negotiate;
5095
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005096#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005097 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005098#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005099 mbedtls_ssl_dtls_replay_reset(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005100#endif
5101
5102 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005103 if (++ssl->in_epoch == 0) {
5104 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005105 /* This is highly unlikely to happen for legitimate reasons, so
5106 treat it as an attack and don't send an alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005107 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005108 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005110#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005111 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005112
Gilles Peskine449bd832023-01-11 14:50:10 +01005113 mbedtls_ssl_update_in_pointers(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005114
Paul Bakker5121ce52009-01-03 21:22:43 +00005115 ssl->state++;
5116
Gilles Peskine449bd832023-01-11 14:50:10 +01005117 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005118
Gilles Peskine449bd832023-01-11 14:50:10 +01005119 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005120}
5121
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005122/* Once ssl->out_hdr as the address of the beginning of the
5123 * next outgoing record is set, deduce the other pointers.
5124 *
5125 * Note: For TLS, we save the implicit record sequence number
5126 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5127 * and the caller has to make sure there's space for this.
5128 */
5129
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005130static size_t ssl_transform_get_explicit_iv_len(
Gilles Peskine449bd832023-01-11 14:50:10 +01005131 mbedtls_ssl_transform const *transform)
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005132{
Gilles Peskine449bd832023-01-11 14:50:10 +01005133 return transform->ivlen - transform->fixed_ivlen;
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005134}
5135
Gilles Peskine449bd832023-01-11 14:50:10 +01005136void mbedtls_ssl_update_out_pointers(mbedtls_ssl_context *ssl,
5137 mbedtls_ssl_transform *transform)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005138{
5139#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005140 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005141 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005142#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005143 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005144 ssl->out_len = ssl->out_cid;
Gilles Peskine449bd832023-01-11 14:50:10 +01005145 if (transform != NULL) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005146 ssl->out_len += transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005147 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005148#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005149 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005150#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005151 ssl->out_iv = ssl->out_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005152 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005153#endif
5154 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005155 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005156#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005157 ssl->out_cid = ssl->out_len;
5158#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005159 ssl->out_iv = ssl->out_hdr + 5;
5160 }
5161
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005162 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005163 /* Adjust out_msg to make space for explicit IV, if used. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005164 if (transform != NULL) {
5165 ssl->out_msg += ssl_transform_get_explicit_iv_len(transform);
5166 }
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005167}
5168
5169/* Once ssl->in_hdr as the address of the beginning of the
5170 * next incoming record is set, deduce the other pointers.
5171 *
5172 * Note: For TLS, we save the implicit record sequence number
5173 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5174 * and the caller has to make sure there's space for this.
5175 */
5176
Gilles Peskine449bd832023-01-11 14:50:10 +01005177void mbedtls_ssl_update_in_pointers(mbedtls_ssl_context *ssl)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005178{
Hanno Becker79594fd2019-05-08 09:38:41 +01005179 /* This function sets the pointers to match the case
5180 * of unprotected TLS/DTLS records, with both ssl->in_iv
5181 * and ssl->in_msg pointing to the beginning of the record
5182 * content.
5183 *
5184 * When decrypting a protected record, ssl->in_msg
5185 * will be shifted to point to the beginning of the
5186 * record plaintext.
5187 */
5188
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005189#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005190 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005191 /* This sets the header pointers to match records
5192 * without CID. When we receive a record containing
5193 * a CID, the fields are shifted accordingly in
5194 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005195 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005196#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005197 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005198 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005199#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005200 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005201#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005202 ssl->in_iv = ssl->in_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005203 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005204#endif
5205 {
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005206 ssl->in_ctr = ssl->in_buf;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005207 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005208#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005209 ssl->in_cid = ssl->in_len;
5210#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005211 ssl->in_iv = ssl->in_hdr + 5;
5212 }
5213
Hanno Becker79594fd2019-05-08 09:38:41 +01005214 /* This will be adjusted at record decryption time. */
5215 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005216}
5217
Paul Bakker5121ce52009-01-03 21:22:43 +00005218/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005219 * Setup an SSL context
5220 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005221
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005222void mbedtls_ssl_reset_in_pointers(mbedtls_ssl_context *ssl)
5223{
5224#if defined(MBEDTLS_SSL_PROTO_DTLS)
5225 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5226 ssl->in_hdr = ssl->in_buf;
5227 } else
Deomid rojer Ryabkovcad11ad2025-01-18 15:58:57 +02005228#endif /* MBEDTLS_SSL_PROTO_DTLS */
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005229 {
5230 ssl->in_hdr = ssl->in_buf + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
5231 }
5232
5233 /* Derive other internal pointers. */
5234 mbedtls_ssl_update_in_pointers(ssl);
5235}
5236
5237void mbedtls_ssl_reset_out_pointers(mbedtls_ssl_context *ssl)
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005238{
5239 /* Set the incoming and outgoing record pointers. */
5240#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005241 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005242 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01005243 } else
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005244#endif /* MBEDTLS_SSL_PROTO_DTLS */
5245 {
Hanno Becker12078f42021-03-02 15:28:41 +00005246 ssl->out_ctr = ssl->out_buf;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00005247 ssl->out_hdr = ssl->out_buf + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005248 }
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005249 /* Derive other internal pointers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005250 mbedtls_ssl_update_out_pointers(ssl, NULL /* no transform enabled */);
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005251}
5252
Paul Bakker5121ce52009-01-03 21:22:43 +00005253/*
5254 * SSL get accessors
5255 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005256size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005257{
Gilles Peskine449bd832023-01-11 14:50:10 +01005258 return ssl->in_offt == NULL ? 0 : ssl->in_msglen;
Paul Bakker5121ce52009-01-03 21:22:43 +00005259}
5260
Gilles Peskine449bd832023-01-11 14:50:10 +01005261int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl)
Hanno Becker8b170a02017-10-10 11:51:19 +01005262{
5263 /*
5264 * Case A: We're currently holding back
5265 * a message for further processing.
5266 */
5267
Gilles Peskine449bd832023-01-11 14:50:10 +01005268 if (ssl->keep_current_message == 1) {
5269 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: record held back for processing"));
5270 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005271 }
5272
5273 /*
5274 * Case B: Further records are pending in the current datagram.
5275 */
5276
5277#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005278 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5279 ssl->in_left > ssl->next_record_offset) {
5280 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: more records within current datagram"));
5281 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005282 }
5283#endif /* MBEDTLS_SSL_PROTO_DTLS */
5284
5285 /*
5286 * Case C: A handshake message is being processed.
5287 */
5288
Gilles Peskine449bd832023-01-11 14:50:10 +01005289 if (ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen) {
5290 MBEDTLS_SSL_DEBUG_MSG(3,
5291 ("ssl_check_pending: more handshake messages within current record"));
5292 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005293 }
5294
5295 /*
5296 * Case D: An application data message is being processed
5297 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005298 if (ssl->in_offt != NULL) {
5299 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: application data record is being processed"));
5300 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005301 }
5302
5303 /*
5304 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005305 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005306 * we implement support for multiple alerts in single records.
5307 */
5308
Gilles Peskine449bd832023-01-11 14:50:10 +01005309 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: nothing pending"));
5310 return 0;
Hanno Becker8b170a02017-10-10 11:51:19 +01005311}
5312
Paul Bakker43ca69c2011-01-15 17:35:19 +00005313
Gilles Peskine449bd832023-01-11 14:50:10 +01005314int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005315{
Hanno Becker3136ede2018-08-17 15:28:19 +01005316 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005317 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005318 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005319 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5320 psa_key_type_t key_type;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005321
Gilles Peskine449bd832023-01-11 14:50:10 +01005322 size_t out_hdr_len = mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker5903de42019-05-03 14:46:38 +01005323
Gilles Peskine449bd832023-01-11 14:50:10 +01005324 if (transform == NULL) {
5325 return (int) out_hdr_len;
5326 }
Hanno Becker78640902018-08-13 16:35:15 +01005327
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005328
Gilles Peskine449bd832023-01-11 14:50:10 +01005329 if (transform->psa_alg == PSA_ALG_GCM ||
5330 transform->psa_alg == PSA_ALG_CCM ||
5331 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 8) ||
5332 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
5333 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005334 transform_expansion = transform->minlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01005335 } else if (transform->psa_alg == PSA_ALG_CBC_NO_PADDING) {
5336 (void) psa_get_key_attributes(transform->psa_key_enc, &attr);
5337 key_type = psa_get_key_type(&attr);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005338
Gilles Peskine449bd832023-01-11 14:50:10 +01005339 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005340
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005341 /* Expansion due to the addition of the MAC. */
5342 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005343
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005344 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005345 * Theoretically up to 256 bytes, but we never use
5346 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005347 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005348
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005349 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005350 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005351#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005352 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005353#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005354 } else {
5355 MBEDTLS_SSL_DEBUG_MSG(1,
5356 ("Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()"));
5357 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005358 }
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005359
Hanno Beckera0e20d02019-05-15 14:03:01 +01005360#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01005361 if (transform->out_cid_len != 0) {
Hanno Becker6cbad552019-05-08 15:40:11 +01005362 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01005363 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005364#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005365
Gilles Peskine449bd832023-01-11 14:50:10 +01005366 return (int) (out_hdr_len + transform_expansion);
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005367}
5368
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005369#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005370/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005371 * Check record counters and renegotiate if they're above the limit.
5372 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005373MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005374static int ssl_check_ctr_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005375{
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 size_t ep_len = mbedtls_ssl_ep_len(ssl);
Andres AG2196c7f2016-12-15 17:01:16 +00005377 int in_ctr_cmp;
5378 int out_ctr_cmp;
5379
Gilles Peskine449bd832023-01-11 14:50:10 +01005380 if (mbedtls_ssl_is_handshake_over(ssl) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005381 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5383 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005384 }
5385
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 in_ctr_cmp = memcmp(ssl->in_ctr + ep_len,
5387 &ssl->conf->renego_period[ep_len],
5388 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len);
5389 out_ctr_cmp = memcmp(&ssl->cur_out_ctr[ep_len],
Jerry Yud9a94fe2021-09-28 18:58:59 +08005390 &ssl->conf->renego_period[ep_len],
Gilles Peskine449bd832023-01-11 14:50:10 +01005391 sizeof(ssl->cur_out_ctr) - ep_len);
Andres AG2196c7f2016-12-15 17:01:16 +00005392
Gilles Peskine449bd832023-01-11 14:50:10 +01005393 if (in_ctr_cmp <= 0 && out_ctr_cmp <= 0) {
5394 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005395 }
5396
Gilles Peskine449bd832023-01-11 14:50:10 +01005397 MBEDTLS_SSL_DEBUG_MSG(1, ("record counter limit reached: renegotiate"));
5398 return mbedtls_ssl_renegotiate(ssl);
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005399}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005400#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005401
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005402#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5403
Ronald Cron7df18bc2024-03-25 13:42:07 +01005404#if defined(MBEDTLS_SSL_CLI_C)
Jerry Yua0446a02022-07-13 11:22:55 +08005405MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Croncf47a152024-04-02 13:19:57 +02005406static int ssl_tls13_is_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005407{
5408
Gilles Peskine449bd832023-01-11 14:50:10 +01005409 if ((ssl->in_hslen == mbedtls_ssl_hs_hdr_len(ssl)) ||
5410 (ssl->in_msg[0] != MBEDTLS_SSL_HS_NEW_SESSION_TICKET)) {
Ronald Croncf47a152024-04-02 13:19:57 +02005411 return 0;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005412 }
5413
Ronald Croncf47a152024-04-02 13:19:57 +02005414 return 1;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005415}
Ronald Cron7df18bc2024-03-25 13:42:07 +01005416#endif /* MBEDTLS_SSL_CLI_C */
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005417
Jerry Yua0446a02022-07-13 11:22:55 +08005418MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005419static int ssl_tls13_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005420{
5421
Gilles Peskine449bd832023-01-11 14:50:10 +01005422 MBEDTLS_SSL_DEBUG_MSG(3, ("received post-handshake message"));
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005423
Ronald Cron7df18bc2024-03-25 13:42:07 +01005424#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005425 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Ronald Croncf47a152024-04-02 13:19:57 +02005426 if (ssl_tls13_is_new_session_ticket(ssl)) {
Ronald Cron7df18bc2024-03-25 13:42:07 +01005427#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5428 MBEDTLS_SSL_DEBUG_MSG(3, ("NewSessionTicket received"));
5429 ssl->keep_current_message = 1;
5430
5431 mbedtls_ssl_handshake_set_state(ssl,
5432 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
5433 return MBEDTLS_ERR_SSL_WANT_READ;
5434#else
5435 MBEDTLS_SSL_DEBUG_MSG(3, ("Ignore NewSessionTicket, not supported."));
5436 return 0;
5437#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005438 }
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005439 }
Ronald Cron7df18bc2024-03-25 13:42:07 +01005440#endif /* MBEDTLS_SSL_CLI_C */
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005441
5442 /* Fail in all other cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005443 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005444}
5445#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5446
5447#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005448/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005449 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005450 * may only be sent for the purpose of initiating renegotiations.
5451 *
5452 * This function is introduced as a separate helper since the handling
5453 * of post-handshake handshake messages changes significantly in TLS 1.3,
5454 * and having a helper function allows to distinguish between TLS <= 1.2 and
5455 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5456 */
Jerry Yua0446a02022-07-13 11:22:55 +08005457MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005458static int ssl_tls12_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005459{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005460 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005461
5462 /*
5463 * - For client-side, expect SERVER_HELLO_REQUEST.
5464 * - For server-side, expect CLIENT_HELLO.
5465 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5466 */
5467
5468#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005469 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5470 (ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5471 ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl))) {
5472 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not HelloRequest)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005473
5474 /* With DTLS, drop the packet (probably from last handshake) */
5475#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005476 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5477 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005478 }
5479#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005481 }
5482#endif /* MBEDTLS_SSL_CLI_C */
5483
5484#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005485 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5486 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO) {
5487 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not ClientHello)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005488
5489 /* With DTLS, drop the packet (probably from last handshake) */
5490#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005491 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5492 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005493 }
5494#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005495 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005496 }
5497#endif /* MBEDTLS_SSL_SRV_C */
5498
5499#if defined(MBEDTLS_SSL_RENEGOTIATION)
5500 /* Determine whether renegotiation attempt should be accepted */
Gilles Peskine449bd832023-01-11 14:50:10 +01005501 if (!(ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5502 (ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5503 ssl->conf->allow_legacy_renegotiation ==
5504 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION))) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005505 /*
5506 * Accept renegotiation request
5507 */
5508
5509 /* DTLS clients need to know renego is server-initiated */
5510#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005511 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5512 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005513 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5514 }
5515#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 ret = mbedtls_ssl_start_renegotiation(ssl);
5517 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5518 ret != 0) {
5519 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation",
5520 ret);
5521 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005522 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 } else
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005524#endif /* MBEDTLS_SSL_RENEGOTIATION */
5525 {
5526 /*
5527 * Refuse renegotiation
5528 */
5529
Gilles Peskine449bd832023-01-11 14:50:10 +01005530 MBEDTLS_SSL_DEBUG_MSG(3, ("refusing renegotiation, sending alert"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005531
Gilles Peskine449bd832023-01-11 14:50:10 +01005532 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5533 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5534 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION)) != 0) {
5535 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005536 }
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005537 }
5538
Gilles Peskine449bd832023-01-11 14:50:10 +01005539 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005540}
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005541#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5542
5543MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005544static int ssl_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005545{
5546 /* Check protocol version and dispatch accordingly. */
5547#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005548 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
5549 return ssl_tls13_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005550 }
5551#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5552
5553#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005554 if (ssl->tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
5555 return ssl_tls12_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005556 }
5557#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5558
5559 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01005560 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005561}
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005562
Paul Bakker48916f92012-09-16 19:57:18 +00005563/*
Jerry Yu739a1d42022-12-08 21:10:25 +08005564 * brief Read at most 'len' application data bytes from the input
5565 * buffer.
5566 *
5567 * param ssl SSL context:
5568 * - First byte of application data not read yet in the input
5569 * buffer located at address `in_offt`.
5570 * - The number of bytes of data not read yet is `in_msglen`.
5571 * param buf buffer that will hold the data
5572 * param len maximum number of bytes to read
5573 *
5574 * note The function updates the fields `in_offt` and `in_msglen`
5575 * according to the number of bytes read.
5576 *
5577 * return The number of bytes read.
5578 */
5579static int ssl_read_application_data(
5580 mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
5581{
5582 size_t n = (len < ssl->in_msglen) ? len : ssl->in_msglen;
5583
5584 if (len != 0) {
5585 memcpy(buf, ssl->in_offt, n);
5586 ssl->in_msglen -= n;
5587 }
5588
5589 /* Zeroising the plaintext buffer to erase unused application data
5590 from the memory. */
5591 mbedtls_platform_zeroize(ssl->in_offt, n);
5592
5593 if (ssl->in_msglen == 0) {
5594 /* all bytes consumed */
5595 ssl->in_offt = NULL;
5596 ssl->keep_current_message = 0;
5597 } else {
5598 /* more data available */
5599 ssl->in_offt += n;
5600 }
5601
5602 return (int) n;
5603}
5604
5605/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005606 * Receive application data decrypted from the SSL layer
5607 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005608int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005609{
Janos Follath865b3eb2019-12-16 11:46:15 +00005610 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005611
Gilles Peskine449bd832023-01-11 14:50:10 +01005612 if (ssl == NULL || ssl->conf == NULL) {
5613 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5614 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005615
Gilles Peskine449bd832023-01-11 14:50:10 +01005616 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005617
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005618#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005619 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5620 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5621 return ret;
5622 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005623
Gilles Peskine449bd832023-01-11 14:50:10 +01005624 if (ssl->handshake != NULL &&
5625 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
5626 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
5627 return ret;
5628 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005629 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005630 }
5631#endif
5632
Hanno Becker4a810fb2017-05-24 16:27:30 +01005633 /*
5634 * Check if renegotiation is necessary and/or handshake is
5635 * in process. If yes, perform/continue, and fall through
5636 * if an unexpected packet is received while the client
5637 * is waiting for the ServerHello.
5638 *
5639 * (There is no equivalent to the last condition on
5640 * the server-side as it is not treated as within
5641 * a handshake while waiting for the ClientHello
5642 * after a renegotiation request.)
5643 */
5644
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005645#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005646 ret = ssl_check_ctr_renegotiate(ssl);
5647 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5648 ret != 0) {
5649 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5650 return ret;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005651 }
5652#endif
5653
Gilles Peskine449bd832023-01-11 14:50:10 +01005654 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5655 ret = mbedtls_ssl_handshake(ssl);
5656 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5657 ret != 0) {
5658 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5659 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005660 }
5661 }
5662
Hanno Beckere41158b2017-10-23 13:30:32 +01005663 /* Loop as long as no application data record is available */
Gilles Peskine449bd832023-01-11 14:50:10 +01005664 while (ssl->in_offt == NULL) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005665 /* Start timer if not already running */
Gilles Peskine449bd832023-01-11 14:50:10 +01005666 if (ssl->f_get_timer != NULL &&
5667 ssl->f_get_timer(ssl->p_timer) == -1) {
5668 mbedtls_ssl_set_timer(ssl, ssl->conf->read_timeout);
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005669 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005670
Gilles Peskine449bd832023-01-11 14:50:10 +01005671 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5672 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5673 return 0;
5674 }
Paul Bakker831a7552011-05-18 13:32:51 +00005675
Gilles Peskine449bd832023-01-11 14:50:10 +01005676 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5677 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005678 }
5679
Gilles Peskine449bd832023-01-11 14:50:10 +01005680 if (ssl->in_msglen == 0 &&
5681 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Paul Bakker5121ce52009-01-03 21:22:43 +00005682 /*
5683 * OpenSSL sends empty messages to randomize the IV
5684 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005685 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5686 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5687 return 0;
5688 }
Paul Bakker831a7552011-05-18 13:32:51 +00005689
Gilles Peskine449bd832023-01-11 14:50:10 +01005690 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5691 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005692 }
5693 }
5694
Gilles Peskine449bd832023-01-11 14:50:10 +01005695 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
5696 ret = ssl_handle_hs_message_post_handshake(ssl);
5697 if (ret != 0) {
5698 MBEDTLS_SSL_DEBUG_RET(1, "ssl_handle_hs_message_post_handshake",
5699 ret);
5700 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00005701 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005702
Hanno Beckerf26cc722021-04-21 07:30:13 +01005703 /* At this point, we don't know whether the renegotiation triggered
5704 * by the post-handshake message has been completed or not. The cases
5705 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005706 * 1) The renegotiation is complete. In this case, no new record
5707 * has been read yet.
5708 * 2) The renegotiation is incomplete because the client received
5709 * an application data record while awaiting the ServerHello.
5710 * 3) The renegotiation is incomplete because the client received
5711 * a non-handshake, non-application data message while awaiting
5712 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005713 *
5714 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005715 * - For 1), the next iteration will read a new record and check
5716 * if it's application data.
5717 * - For 2), the loop condition isn't satisfied as application data
5718 * is present, hence continue is the same as break
5719 * - For 3), the loop condition is satisfied and read_record
5720 * will re-deliver the message that was held back by the client
5721 * when expecting the ServerHello.
5722 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005723
Hanno Becker90333da2017-10-10 11:27:13 +01005724 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005725 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005726#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 else if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5728 if (ssl->conf->renego_max_records >= 0) {
5729 if (++ssl->renego_records_seen > ssl->conf->renego_max_records) {
5730 MBEDTLS_SSL_DEBUG_MSG(1, ("renegotiation requested, "
5731 "but not honored by client"));
5732 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005733 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005734 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005735 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005736#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005737
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005738 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
Gilles Peskine449bd832023-01-11 14:50:10 +01005739 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5740 MBEDTLS_SSL_DEBUG_MSG(2, ("ignoring non-fatal non-closure alert"));
5741 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005742 }
5743
Gilles Peskine449bd832023-01-11 14:50:10 +01005744 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
5745 MBEDTLS_SSL_DEBUG_MSG(1, ("bad application data message"));
5746 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005747 }
5748
5749 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005750
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005751 /* We're going to return something now, cancel timer,
5752 * except if handshake (renegotiation) is in progress */
Gilles Peskine449bd832023-01-11 14:50:10 +01005753 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5754 mbedtls_ssl_set_timer(ssl, 0);
5755 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005756
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005757#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005758 /* If we requested renego but received AppData, resend HelloRequest.
5759 * Do it now, after setting in_offt, to avoid taking this branch
5760 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005761#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005762 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5763 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5764 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
5765 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
5766 ret);
5767 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005768 }
5769 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005770#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005771#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005772 }
5773
Jerry Yu739a1d42022-12-08 21:10:25 +08005774 ret = ssl_read_application_data(ssl, buf, len);
Paul Bakker5121ce52009-01-03 21:22:43 +00005775
Gilles Peskine449bd832023-01-11 14:50:10 +01005776 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005777
Jerry Yu739a1d42022-12-08 21:10:25 +08005778 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005779}
5780
Jerry Yud9ca3542023-12-06 17:23:52 +08005781#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA)
5782int mbedtls_ssl_read_early_data(mbedtls_ssl_context *ssl,
5783 unsigned char *buf, size_t len)
5784{
Ronald Croned7d4bf2024-01-31 07:55:19 +01005785 if (ssl == NULL || (ssl->conf == NULL)) {
Jerry Yud9ca3542023-12-06 17:23:52 +08005786 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5787 }
5788
Ronald Cron164537c2024-02-01 18:05:47 +01005789 /*
5790 * The server may receive early data only while waiting for the End of
5791 * Early Data handshake message.
5792 */
Ronald Croned7d4bf2024-01-31 07:55:19 +01005793 if ((ssl->state != MBEDTLS_SSL_END_OF_EARLY_DATA) ||
5794 (ssl->in_offt == NULL)) {
Jerry Yud9ca3542023-12-06 17:23:52 +08005795 return MBEDTLS_ERR_SSL_CANNOT_READ_EARLY_DATA;
5796 }
5797
Ronald Croned7d4bf2024-01-31 07:55:19 +01005798 return ssl_read_application_data(ssl, buf, len);
Jerry Yud9ca3542023-12-06 17:23:52 +08005799}
5800#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA */
5801
Paul Bakker5121ce52009-01-03 21:22:43 +00005802/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005803 * Send application data to be encrypted by the SSL layer, taking care of max
5804 * fragment length and buffer size.
5805 *
5806 * According to RFC 5246 Section 6.2.1:
5807 *
5808 * Zero-length fragments of Application data MAY be sent as they are
5809 * potentially useful as a traffic analysis countermeasure.
5810 *
5811 * Therefore, it is possible that the input message length is 0 and the
5812 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005813 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005814MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005815static int ssl_write_real(mbedtls_ssl_context *ssl,
5816 const unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005817{
Gilles Peskine449bd832023-01-11 14:50:10 +01005818 int ret = mbedtls_ssl_get_max_out_record_payload(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005819 const size_t max_len = (size_t) ret;
5820
Gilles Peskine449bd832023-01-11 14:50:10 +01005821 if (ret < 0) {
5822 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_get_max_out_record_payload", ret);
5823 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005824 }
5825
Gilles Peskine449bd832023-01-11 14:50:10 +01005826 if (len > max_len) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005827#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005828 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5829 MBEDTLS_SSL_DEBUG_MSG(1, ("fragment larger than the (negotiated) "
5830 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5831 " > %" MBEDTLS_PRINTF_SIZET,
5832 len, max_len));
5833 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5834 } else
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005835#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005836 len = max_len;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005837 }
Paul Bakker887bd502011-06-08 13:10:54 +00005838
Gilles Peskine449bd832023-01-11 14:50:10 +01005839 if (ssl->out_left != 0) {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005840 /*
5841 * The user has previously tried to send the data and
5842 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5843 * written. In this case, we expect the high-level write function
5844 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5845 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5847 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
5848 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005849 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005850 } else {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005851 /*
5852 * The user is trying to send a message the first time, so we need to
5853 * copy the data into the internal buffers and setup the data structure
5854 * to keep track of partial writes
5855 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005856 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005857 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Dave Rodgmanf6840252023-02-24 15:41:34 +00005858 if (len > 0) {
5859 memcpy(ssl->out_msg, buf, len);
5860 }
Paul Bakker887bd502011-06-08 13:10:54 +00005861
Gilles Peskine449bd832023-01-11 14:50:10 +01005862 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5863 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5864 return ret;
Paul Bakker887bd502011-06-08 13:10:54 +00005865 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005866 }
5867
Gilles Peskine449bd832023-01-11 14:50:10 +01005868 return (int) len;
Paul Bakker5121ce52009-01-03 21:22:43 +00005869}
5870
5871/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005872 * Write application data (public-facing wrapper)
5873 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005874int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005875{
Janos Follath865b3eb2019-12-16 11:46:15 +00005876 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005877
Gilles Peskine449bd832023-01-11 14:50:10 +01005878 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005879
Gilles Peskine449bd832023-01-11 14:50:10 +01005880 if (ssl == NULL || ssl->conf == NULL) {
5881 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5882 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005883
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005884#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005885 if ((ret = ssl_check_ctr_renegotiate(ssl)) != 0) {
5886 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5887 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005888 }
5889#endif
5890
Gilles Peskine449bd832023-01-11 14:50:10 +01005891 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5892 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
5893 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5894 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005895 }
5896 }
5897
Gilles Peskine449bd832023-01-11 14:50:10 +01005898 ret = ssl_write_real(ssl, buf, len);
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005899
Gilles Peskine449bd832023-01-11 14:50:10 +01005900 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005901
Gilles Peskine449bd832023-01-11 14:50:10 +01005902 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005903}
5904
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005905#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_CLI_C)
5906int mbedtls_ssl_write_early_data(mbedtls_ssl_context *ssl,
5907 const unsigned char *buf, size_t len)
5908{
5909 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
5910 const struct mbedtls_ssl_config *conf;
Ronald Cron62f971a2024-02-23 08:24:12 +01005911 uint32_t remaining;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005912
5913 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write early_data"));
5914
5915 if (ssl == NULL || (conf = ssl->conf) == NULL) {
5916 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5917 }
5918
Ronald Cron49221902024-02-21 13:39:14 +01005919 if (conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
5920 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5921 }
5922
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005923 if ((!mbedtls_ssl_conf_is_tls13_enabled(conf)) ||
5924 (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) ||
5925 (conf->early_data_enabled != MBEDTLS_SSL_EARLY_DATA_ENABLED)) {
5926 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5927 }
5928
5929 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_3) {
5930 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5931 }
5932
5933 /*
Ronald Crond2884662024-03-03 15:03:22 +01005934 * If we are at the beginning of the handshake, the early data state being
Ronald Cron05d7cfb2024-03-03 15:39:30 +01005935 * equal to MBEDTLS_SSL_EARLY_DATA_STATE_IDLE or
Ronald Cron3641df22024-03-03 16:10:58 +01005936 * MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT advance the handshake just
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005937 * enough to be able to send early data if possible. That way, we can
5938 * guarantee that when starting the handshake with this function we will
Ronald Crond2884662024-03-03 15:03:22 +01005939 * send at least one record of early data. Note that when the state is
Ronald Cron3641df22024-03-03 16:10:58 +01005940 * MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT and not yet
5941 * MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE, we cannot send early data
Ronald Crond4069242024-02-21 13:45:52 +01005942 * as the early data outbound transform has not been set as we may have to
5943 * first send a dummy CCS in clear.
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005944 */
Ronald Cron05d7cfb2024-03-03 15:39:30 +01005945 if ((ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IDLE) ||
Ronald Cron3641df22024-03-03 16:10:58 +01005946 (ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT)) {
Ronald Cron05d7cfb2024-03-03 15:39:30 +01005947 while ((ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IDLE) ||
Ronald Cron3641df22024-03-03 16:10:58 +01005948 (ssl->early_data_state == MBEDTLS_SSL_EARLY_DATA_STATE_IND_SENT)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005949 ret = mbedtls_ssl_handshake_step(ssl);
5950 if (ret != 0) {
5951 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake_step", ret);
5952 return ret;
5953 }
5954
5955 ret = mbedtls_ssl_flush_output(ssl);
5956 if (ret != 0) {
5957 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
5958 return ret;
5959 }
5960 }
Ronald Cron62f971a2024-02-23 08:24:12 +01005961 remaining = ssl->session_negotiate->max_early_data_size;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005962 } else {
Ronald Crond4069242024-02-21 13:45:52 +01005963 /*
Ronald Cron62f971a2024-02-23 08:24:12 +01005964 * If we are past the point where we can send early data or we have
5965 * already reached the maximum early data size, return immediatly.
5966 * Otherwise, progress the handshake as much as possible to not delay
5967 * it too much. If we reach a point where we can still send early data,
5968 * then we will send some.
Ronald Crond4069242024-02-21 13:45:52 +01005969 */
Ronald Crond2884662024-03-03 15:03:22 +01005970 if ((ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE) &&
5971 (ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_ACCEPTED)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005972 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5973 }
5974
Ronald Cron62f971a2024-02-23 08:24:12 +01005975 remaining = ssl->session_negotiate->max_early_data_size -
Ronald Cronde9b03d2024-03-01 15:14:17 +01005976 ssl->total_early_data_size;
Ronald Cron62f971a2024-02-23 08:24:12 +01005977
5978 if (remaining == 0) {
5979 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5980 }
5981
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005982 ret = mbedtls_ssl_handshake(ssl);
5983 if ((ret != 0) && (ret != MBEDTLS_ERR_SSL_WANT_READ)) {
5984 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5985 return ret;
5986 }
5987 }
5988
Ronald Crond2884662024-03-03 15:03:22 +01005989 if (((ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_CAN_WRITE) &&
5990 (ssl->early_data_state != MBEDTLS_SSL_EARLY_DATA_STATE_ACCEPTED))
Ronald Cron62f971a2024-02-23 08:24:12 +01005991 || (remaining == 0)) {
Xiaokang Qianb62732e2023-11-30 09:58:08 +00005992 return MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA;
5993 }
5994
Ronald Cron62f971a2024-02-23 08:24:12 +01005995 if (len > remaining) {
5996 len = remaining;
5997 }
5998
Ronald Cron5dbfcce2024-02-26 17:50:38 +01005999 ret = ssl_write_real(ssl, buf, len);
6000 if (ret >= 0) {
6001 ssl->total_early_data_size += ret;
6002 }
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006003
Ronald Cron5dbfcce2024-02-26 17:50:38 +01006004 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write early_data, ret=%d", ret));
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006005
Ronald Cron5dbfcce2024-02-26 17:50:38 +01006006 return ret;
Xiaokang Qianb62732e2023-11-30 09:58:08 +00006007}
6008#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_CLI_C */
6009
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02006010/*
Paul Bakker5121ce52009-01-03 21:22:43 +00006011 * Notify the peer that the connection is being closed
6012 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006013int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00006014{
Janos Follath865b3eb2019-12-16 11:46:15 +00006015 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00006016
Gilles Peskine449bd832023-01-11 14:50:10 +01006017 if (ssl == NULL || ssl->conf == NULL) {
6018 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
6019 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02006020
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00006022
Gilles Peskine449bd832023-01-11 14:50:10 +01006023 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
6024 if ((ret = mbedtls_ssl_send_alert_message(ssl,
6025 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
6026 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY)) != 0) {
6027 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_send_alert_message", ret);
6028 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00006029 }
6030 }
6031
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00006033
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00006035}
6036
Gilles Peskine449bd832023-01-11 14:50:10 +01006037void mbedtls_ssl_transform_free(mbedtls_ssl_transform *transform)
Paul Bakker48916f92012-09-16 19:57:18 +00006038{
Gilles Peskine449bd832023-01-11 14:50:10 +01006039 if (transform == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02006040 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006041 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02006042
Gilles Peskine449bd832023-01-11 14:50:10 +01006043 psa_destroy_key(transform->psa_key_enc);
6044 psa_destroy_key(transform->psa_key_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01006045
Hanno Beckerfd86ca82020-11-30 08:54:23 +00006046#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01006047 psa_destroy_key(transform->psa_mac_enc);
6048 psa_destroy_key(transform->psa_mac_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00006049#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02006050
Gilles Peskine449bd832023-01-11 14:50:10 +01006051 mbedtls_platform_zeroize(transform, sizeof(mbedtls_ssl_transform));
Paul Bakker48916f92012-09-16 19:57:18 +00006052}
6053
Gilles Peskine449bd832023-01-11 14:50:10 +01006054void mbedtls_ssl_set_inbound_transform(mbedtls_ssl_context *ssl,
6055 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006056{
Jerry Yuc7875b52021-09-05 21:05:50 +08006057 ssl->transform_in = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuc7875b52021-09-05 21:05:50 +08006059}
6060
Gilles Peskine449bd832023-01-11 14:50:10 +01006061void mbedtls_ssl_set_outbound_transform(mbedtls_ssl_context *ssl,
6062 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006063{
6064 ssl->transform_out = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006065 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yuc7875b52021-09-05 21:05:50 +08006066}
6067
Hanno Becker0271f962018-08-16 13:23:47 +01006068#if defined(MBEDTLS_SSL_PROTO_DTLS)
6069
Gilles Peskine449bd832023-01-11 14:50:10 +01006070void mbedtls_ssl_buffering_free(mbedtls_ssl_context *ssl)
Hanno Becker0271f962018-08-16 13:23:47 +01006071{
6072 unsigned offset;
6073 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6074
Gilles Peskine449bd832023-01-11 14:50:10 +01006075 if (hs == NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01006076 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006077 }
Hanno Becker0271f962018-08-16 13:23:47 +01006078
Gilles Peskine449bd832023-01-11 14:50:10 +01006079 ssl_free_buffered_record(ssl);
Hanno Becker283f5ef2018-08-24 09:34:47 +01006080
Gilles Peskine449bd832023-01-11 14:50:10 +01006081 for (offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
6082 ssl_buffering_free_slot(ssl, offset);
6083 }
Hanno Beckere605b192018-08-21 15:59:07 +01006084}
6085
Gilles Peskine449bd832023-01-11 14:50:10 +01006086static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
6087 uint8_t slot)
Hanno Beckere605b192018-08-21 15:59:07 +01006088{
6089 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6090 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01006091
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 if (slot >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Beckerb309b922018-08-23 13:18:05 +01006093 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006094 }
Hanno Beckerb309b922018-08-23 13:18:05 +01006095
Gilles Peskine449bd832023-01-11 14:50:10 +01006096 if (hs_buf->is_valid == 1) {
Hanno Beckere605b192018-08-21 15:59:07 +01006097 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006098 mbedtls_zeroize_and_free(hs_buf->data, hs_buf->data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Hanno Becker0271f962018-08-16 13:23:47 +01006100 }
6101}
6102
6103#endif /* MBEDTLS_SSL_PROTO_DTLS */
6104
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006105/*
6106 * Convert version numbers to/from wire format
6107 * and, for DTLS, to/from TLS equivalent.
6108 *
6109 * For TLS this is the identity.
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006110 * For DTLS, map as follows, then use 1's complement (v -> ~v):
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006111 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006112 * DTLS 1.0 is stored as TLS 1.1 internally
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006113 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006114void mbedtls_ssl_write_version(unsigned char version[2], int transport,
6115 mbedtls_ssl_protocol_version tls_version)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006116{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006117 uint16_t tls_version_formatted;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006118#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006119 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006120 tls_version_formatted =
Gilles Peskine449bd832023-01-11 14:50:10 +01006121 ~(tls_version - (tls_version == 0x0302 ? 0x0202 : 0x0201));
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006122 } else
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006123#else
6124 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006125#endif
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006126 {
6127 tls_version_formatted = (uint16_t) tls_version;
6128 }
6129 MBEDTLS_PUT_UINT16_BE(tls_version_formatted, version, 0);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006130}
6131
Gilles Peskine449bd832023-01-11 14:50:10 +01006132uint16_t mbedtls_ssl_read_version(const unsigned char version[2],
6133 int transport)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006134{
Gilles Peskine449bd832023-01-11 14:50:10 +01006135 uint16_t tls_version = MBEDTLS_GET_UINT16_BE(version, 0);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006136#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006137 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006138 tls_version =
Gilles Peskine449bd832023-01-11 14:50:10 +01006139 ~(tls_version - (tls_version == 0xfeff ? 0x0202 : 0x0201));
6140 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006141#else
6142 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006143#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006144 return tls_version;
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006145}
6146
Jerry Yue7047812021-09-13 19:26:39 +08006147/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08006148 * Send pending fatal alert.
6149 * 0, No alert message.
6150 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
6151 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08006152 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006153int mbedtls_ssl_handle_pending_alert(mbedtls_ssl_context *ssl)
Jerry Yue7047812021-09-13 19:26:39 +08006154{
6155 int ret;
6156
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006157 /* No pending alert, return success*/
Gilles Peskine449bd832023-01-11 14:50:10 +01006158 if (ssl->send_alert == 0) {
6159 return 0;
6160 }
Jerry Yu394ece62021-09-14 22:17:21 +08006161
Gilles Peskine449bd832023-01-11 14:50:10 +01006162 ret = mbedtls_ssl_send_alert_message(ssl,
6163 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6164 ssl->alert_type);
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006165
Jerry Yu3bf1f972021-09-22 21:37:18 +08006166 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
6167 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006168 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006169 if (ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006170 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08006171 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006172
Gilles Peskine449bd832023-01-11 14:50:10 +01006173 if (ret != 0) {
6174 return ret;
6175 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006176
Gilles Peskine449bd832023-01-11 14:50:10 +01006177 return ssl->alert_reason;
Jerry Yue7047812021-09-13 19:26:39 +08006178}
6179
Jerry Yu394ece62021-09-14 22:17:21 +08006180/*
6181 * Set pending fatal alert flag.
6182 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006183void mbedtls_ssl_pend_fatal_alert(mbedtls_ssl_context *ssl,
6184 unsigned char alert_type,
6185 int alert_reason)
Jerry Yu394ece62021-09-14 22:17:21 +08006186{
6187 ssl->send_alert = 1;
6188 ssl->alert_type = alert_type;
6189 ssl->alert_reason = alert_reason;
6190}
6191
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006192#endif /* MBEDTLS_SSL_TLS_C */