blob: 69706cf532e8a0f4739adb5a28d537a0dad519a3 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Hanno Beckerf1a38282020-02-05 16:14:29 +00002 * Generic SSL/TLS messaging layer functions
3 * (record layer + retransmission state machine)
Paul Bakker5121ce52009-01-03 21:22:43 +00004 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02006 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000019 */
20/*
Paul Bakker5121ce52009-01-03 21:22:43 +000021 * http://www.ietf.org/rfc/rfc2246.txt
22 * http://www.ietf.org/rfc/rfc4346.txt
23 */
24
Gilles Peskinedb09ef62020-06-03 01:43:33 +020025#include "common.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000028
SimonBd5800b72016-04-26 07:43:27 +010029#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010030
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000031#include "mbedtls/ssl.h"
Chris Jones84a773f2021-03-05 18:38:47 +000032#include "ssl_misc.h"
Janos Follath73c616b2019-12-18 15:07:04 +000033#include "mbedtls/debug.h"
34#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050035#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010036#include "mbedtls/version.h"
Gabor Mezei22c9a6f2021-10-20 12:09:35 +020037#include "constant_time_internal.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020038#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020039
Rich Evans00ab4702015-02-06 13:43:58 +000040#include <string.h>
41
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050042#if defined(MBEDTLS_USE_PSA_CRYPTO)
43#include "mbedtls/psa_util.h"
44#include "psa/crypto.h"
45#endif
46
Janos Follath23bdca02016-10-07 14:47:14 +010047#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000048#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020049#endif
50
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050051#if defined(MBEDTLS_USE_PSA_CRYPTO)
52#define PSA_TO_MBEDTLS_ERR(status) PSA_TO_MBEDTLS_ERR_LIST(status, \
53 psa_to_ssl_errors, \
54 psa_generic_status_to_mbedtls)
55#endif
56
Dave Rodgman2801f7f2023-05-09 11:00:07 +010057#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
58
59#if defined(MBEDTLS_USE_PSA_CRYPTO)
60
61#if defined(PSA_WANT_ALG_SHA_384)
62#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_384)
63#elif defined(PSA_WANT_ALG_SHA_256)
64#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_256)
65#else /* See check_config.h */
66#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_1)
67#endif
68
69MBEDTLS_STATIC_TESTABLE
70int mbedtls_ct_hmac(mbedtls_svc_key_id_t key,
71 psa_algorithm_t mac_alg,
72 const unsigned char *add_data,
73 size_t add_data_len,
74 const unsigned char *data,
75 size_t data_len_secret,
76 size_t min_data_len,
77 size_t max_data_len,
78 unsigned char *output)
79{
80 /*
81 * This function breaks the HMAC abstraction and uses psa_hash_clone()
82 * extension in order to get constant-flow behaviour.
83 *
84 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
85 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
86 * patterns (see RFC 2104, sec. 2).
87 *
88 * We'll first compute ikey/okey, then inner_hash = HASH(ikey + msg) by
89 * hashing up to minlen, then cloning the context, and for each byte up
90 * to maxlen finishing up the hash computation, keeping only the
91 * correct result.
92 *
93 * Then we only need to compute HASH(okey + inner_hash) and we're done.
94 */
95 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH(mac_alg);
96 const size_t block_size = PSA_HASH_BLOCK_LENGTH(hash_alg);
97 unsigned char key_buf[MAX_HASH_BLOCK_LENGTH];
98 const size_t hash_size = PSA_HASH_LENGTH(hash_alg);
99 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
100 size_t hash_length;
101
102 unsigned char aux_out[PSA_HASH_MAX_SIZE];
103 psa_hash_operation_t aux_operation = PSA_HASH_OPERATION_INIT;
104 size_t offset;
105 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
106
107 size_t mac_key_length;
108 size_t i;
109
110#define PSA_CHK(func_call) \
111 do { \
112 status = (func_call); \
113 if (status != PSA_SUCCESS) \
114 goto cleanup; \
115 } while (0)
116
117 /* Export MAC key
118 * We assume key length is always exactly the output size
119 * which is never more than the block size, thus we use block_size
120 * as the key buffer size.
121 */
122 PSA_CHK(psa_export_key(key, key_buf, block_size, &mac_key_length));
123
124 /* Calculate ikey */
125 for (i = 0; i < mac_key_length; i++) {
126 key_buf[i] = (unsigned char) (key_buf[i] ^ 0x36);
127 }
128 for (; i < block_size; ++i) {
129 key_buf[i] = 0x36;
130 }
131
132 PSA_CHK(psa_hash_setup(&operation, hash_alg));
133
134 /* Now compute inner_hash = HASH(ikey + msg) */
135 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
136 PSA_CHK(psa_hash_update(&operation, add_data, add_data_len));
137 PSA_CHK(psa_hash_update(&operation, data, min_data_len));
138
139 /* Fill the hash buffer in advance with something that is
140 * not a valid hash (barring an attack on the hash and
141 * deliberately-crafted input), in case the caller doesn't
142 * check the return status properly. */
143 memset(output, '!', hash_size);
144
145 /* For each possible length, compute the hash up to that point */
146 for (offset = min_data_len; offset <= max_data_len; offset++) {
147 PSA_CHK(psa_hash_clone(&operation, &aux_operation));
148 PSA_CHK(psa_hash_finish(&aux_operation, aux_out,
149 PSA_HASH_MAX_SIZE, &hash_length));
150 /* Keep only the correct inner_hash in the output buffer */
151 mbedtls_ct_memcpy_if_eq(output, aux_out, hash_size,
152 offset, data_len_secret);
153
154 if (offset < max_data_len) {
155 PSA_CHK(psa_hash_update(&operation, data + offset, 1));
156 }
157 }
158
159 /* Abort current operation to prepare for final operation */
160 PSA_CHK(psa_hash_abort(&operation));
161
162 /* Calculate okey */
163 for (i = 0; i < mac_key_length; i++) {
164 key_buf[i] = (unsigned char) ((key_buf[i] ^ 0x36) ^ 0x5C);
165 }
166 for (; i < block_size; ++i) {
167 key_buf[i] = 0x5C;
168 }
169
170 /* Now compute HASH(okey + inner_hash) */
171 PSA_CHK(psa_hash_setup(&operation, hash_alg));
172 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
173 PSA_CHK(psa_hash_update(&operation, output, hash_size));
174 PSA_CHK(psa_hash_finish(&operation, output, hash_size, &hash_length));
175
176#undef PSA_CHK
177
178cleanup:
179 mbedtls_platform_zeroize(key_buf, MAX_HASH_BLOCK_LENGTH);
180 mbedtls_platform_zeroize(aux_out, PSA_HASH_MAX_SIZE);
181
182 psa_hash_abort(&operation);
183 psa_hash_abort(&aux_operation);
184 return PSA_TO_MBEDTLS_ERR(status);
185}
186
187#undef MAX_HASH_BLOCK_LENGTH
188
189#else
190MBEDTLS_STATIC_TESTABLE
191int mbedtls_ct_hmac(mbedtls_md_context_t *ctx,
192 const unsigned char *add_data,
193 size_t add_data_len,
194 const unsigned char *data,
195 size_t data_len_secret,
196 size_t min_data_len,
197 size_t max_data_len,
198 unsigned char *output)
199{
200 /*
201 * This function breaks the HMAC abstraction and uses the md_clone()
202 * extension to the MD API in order to get constant-flow behaviour.
203 *
204 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
205 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
206 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
207 *
208 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
209 * minlen, then cloning the context, and for each byte up to maxlen
210 * finishing up the hash computation, keeping only the correct result.
211 *
212 * Then we only need to compute HASH(okey + inner_hash) and we're done.
213 */
214 const mbedtls_md_type_t md_alg = mbedtls_md_get_type(ctx->md_info);
215 /* TLS 1.2 only supports SHA-384, SHA-256, SHA-1, MD-5,
216 * all of which have the same block size except SHA-384. */
217 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
218 const unsigned char * const ikey = ctx->hmac_ctx;
219 const unsigned char * const okey = ikey + block_size;
220 const size_t hash_size = mbedtls_md_get_size(ctx->md_info);
221
222 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
223 mbedtls_md_context_t aux;
224 size_t offset;
225 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
226
227 mbedtls_md_init(&aux);
228
229#define MD_CHK(func_call) \
230 do { \
231 ret = (func_call); \
232 if (ret != 0) \
233 goto cleanup; \
234 } while (0)
235
236 MD_CHK(mbedtls_md_setup(&aux, ctx->md_info, 0));
237
238 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
239 * so we can start directly with the message */
240 MD_CHK(mbedtls_md_update(ctx, add_data, add_data_len));
241 MD_CHK(mbedtls_md_update(ctx, data, min_data_len));
242
243 /* Fill the hash buffer in advance with something that is
244 * not a valid hash (barring an attack on the hash and
245 * deliberately-crafted input), in case the caller doesn't
246 * check the return status properly. */
247 memset(output, '!', hash_size);
248
249 /* For each possible length, compute the hash up to that point */
250 for (offset = min_data_len; offset <= max_data_len; offset++) {
251 MD_CHK(mbedtls_md_clone(&aux, ctx));
252 MD_CHK(mbedtls_md_finish(&aux, aux_out));
253 /* Keep only the correct inner_hash in the output buffer */
254 mbedtls_ct_memcpy_if_eq(output, aux_out, hash_size,
255 offset, data_len_secret);
256
257 if (offset < max_data_len) {
258 MD_CHK(mbedtls_md_update(ctx, data + offset, 1));
259 }
260 }
261
262 /* The context needs to finish() before it starts() again */
263 MD_CHK(mbedtls_md_finish(ctx, aux_out));
264
265 /* Now compute HASH(okey + inner_hash) */
266 MD_CHK(mbedtls_md_starts(ctx));
267 MD_CHK(mbedtls_md_update(ctx, okey, block_size));
268 MD_CHK(mbedtls_md_update(ctx, output, hash_size));
269 MD_CHK(mbedtls_md_finish(ctx, output));
270
271 /* Done, get ready for next time */
272 MD_CHK(mbedtls_md_hmac_reset(ctx));
273
274#undef MD_CHK
275
276cleanup:
277 mbedtls_md_free(&aux);
278 return ret;
279}
280
281#endif /* MBEDTLS_USE_PSA_CRYPTO */
282
283#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
284
Gilles Peskine449bd832023-01-11 14:50:10 +0100285static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl);
Hanno Becker2a43f6f2018-08-10 11:12:52 +0100286
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200287/*
288 * Start a timer.
289 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200290 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100291void mbedtls_ssl_set_timer(mbedtls_ssl_context *ssl, uint32_t millisecs)
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200292{
Gilles Peskine449bd832023-01-11 14:50:10 +0100293 if (ssl->f_set_timer == NULL) {
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +0200294 return;
Gilles Peskine449bd832023-01-11 14:50:10 +0100295 }
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +0200296
Gilles Peskine449bd832023-01-11 14:50:10 +0100297 MBEDTLS_SSL_DEBUG_MSG(3, ("set_timer to %d ms", (int) millisecs));
298 ssl->f_set_timer(ssl->p_timer, millisecs / 4, millisecs);
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200299}
300
301/*
302 * Return -1 is timer is expired, 0 if it isn't.
303 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100304int mbedtls_ssl_check_timer(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200305{
Gilles Peskine449bd832023-01-11 14:50:10 +0100306 if (ssl->f_get_timer == NULL) {
307 return 0;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200308 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200309
Gilles Peskine449bd832023-01-11 14:50:10 +0100310 if (ssl->f_get_timer(ssl->p_timer) == 2) {
311 MBEDTLS_SSL_DEBUG_MSG(3, ("timer expired"));
312 return -1;
313 }
314
315 return 0;
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200316}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200317
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200318MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100319static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
320 unsigned char *buf,
321 size_t len,
322 mbedtls_record *rec);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200323
Gilles Peskine449bd832023-01-11 14:50:10 +0100324int mbedtls_ssl_check_record(mbedtls_ssl_context const *ssl,
325 unsigned char *buf,
326 size_t buflen)
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200327{
328 int ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100329 MBEDTLS_SSL_DEBUG_MSG(1, ("=> mbedtls_ssl_check_record"));
330 MBEDTLS_SSL_DEBUG_BUF(3, "record buffer", buf, buflen);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200331
332 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +0200333 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200334 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100335 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM) {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200336 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
337 goto exit;
338 }
339#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100340 else {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200341 mbedtls_record rec;
342
Gilles Peskine449bd832023-01-11 14:50:10 +0100343 ret = ssl_parse_record_header(ssl, buf, buflen, &rec);
344 if (ret != 0) {
345 MBEDTLS_SSL_DEBUG_RET(3, "ssl_parse_record_header", ret);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200346 goto exit;
347 }
348
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 if (ssl->transform_in != NULL) {
350 ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in, &rec);
351 if (ret != 0) {
352 MBEDTLS_SSL_DEBUG_RET(3, "mbedtls_ssl_decrypt_buf", ret);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200353 goto exit;
354 }
355 }
356 }
357#endif /* MBEDTLS_SSL_PROTO_DTLS */
358
359exit:
360 /* On success, we have decrypted the buffer in-place, so make
361 * sure we don't leak any plaintext data. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100362 mbedtls_platform_zeroize(buf, buflen);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200363
364 /* For the purpose of this API, treat messages with unexpected CID
365 * as well as such from future epochs as unexpected. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
367 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200368 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
369 }
370
Gilles Peskine449bd832023-01-11 14:50:10 +0100371 MBEDTLS_SSL_DEBUG_MSG(1, ("<= mbedtls_ssl_check_record"));
372 return ret;
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200373}
374
Hanno Becker67bc7c32018-08-06 11:33:50 +0100375#define SSL_DONT_FORCE_FLUSH 0
376#define SSL_FORCE_FLUSH 1
377
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200378#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100379
Hanno Beckerd5847772018-08-28 10:09:23 +0100380/* Forward declarations for functions related to message buffering. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100381static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
382 uint8_t slot);
383static void ssl_free_buffered_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200384MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100385static int ssl_load_buffered_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200386MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100387static int ssl_load_buffered_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200388MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100389static int ssl_buffer_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200390MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100391static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
392 mbedtls_record const *rec);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200393MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100394static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl);
Hanno Beckerd5847772018-08-28 10:09:23 +0100395
Gilles Peskine449bd832023-01-11 14:50:10 +0100396static size_t ssl_get_maximum_datagram_size(mbedtls_ssl_context const *ssl)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100397{
Gilles Peskine449bd832023-01-11 14:50:10 +0100398 size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
Darryl Greenb33cc762019-11-28 14:29:44 +0000399#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
400 size_t out_buf_len = ssl->out_buf_len;
401#else
402 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
403#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100404
Gilles Peskine449bd832023-01-11 14:50:10 +0100405 if (mtu != 0 && mtu < out_buf_len) {
406 return mtu;
407 }
Hanno Becker2b1e3542018-08-06 11:19:13 +0100408
Gilles Peskine449bd832023-01-11 14:50:10 +0100409 return out_buf_len;
Hanno Becker2b1e3542018-08-06 11:19:13 +0100410}
411
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200412MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100413static int ssl_get_remaining_space_in_datagram(mbedtls_ssl_context const *ssl)
Hanno Becker67bc7c32018-08-06 11:33:50 +0100414{
Hanno Becker11682cc2018-08-22 14:41:02 +0100415 size_t const bytes_written = ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +0100416 size_t const mtu = ssl_get_maximum_datagram_size(ssl);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100417
418 /* Double-check that the write-index hasn't gone
419 * past what we can transmit in a single datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 if (bytes_written > mtu) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100421 /* Should never happen... */
Gilles Peskine449bd832023-01-11 14:50:10 +0100422 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100423 }
424
Gilles Peskine449bd832023-01-11 14:50:10 +0100425 return (int) (mtu - bytes_written);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100426}
427
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200428MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100429static int ssl_get_remaining_payload_in_datagram(mbedtls_ssl_context const *ssl)
Hanno Becker67bc7c32018-08-06 11:33:50 +0100430{
Janos Follath865b3eb2019-12-16 11:46:15 +0000431 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100432 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400433 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100434
435#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +0100436 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100437
Gilles Peskine449bd832023-01-11 14:50:10 +0100438 if (max_len > mfl) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100439 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +0100440 }
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100441
442 /* By the standard (RFC 6066 Sect. 4), the MFL extension
443 * only limits the maximum record payload size, so in theory
444 * we would be allowed to pack multiple records of payload size
445 * MFL into a single datagram. However, this would mean that there's
446 * no way to explicitly communicate MTU restrictions to the peer.
447 *
448 * The following reduction of max_len makes sure that we never
449 * write datagrams larger than MFL + Record Expansion Overhead.
450 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100451 if (max_len <= ssl->out_left) {
452 return 0;
453 }
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100454
455 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100456#endif
457
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 ret = ssl_get_remaining_space_in_datagram(ssl);
459 if (ret < 0) {
460 return ret;
461 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100462 remaining = (size_t) ret;
463
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 ret = mbedtls_ssl_get_record_expansion(ssl);
465 if (ret < 0) {
466 return ret;
467 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100468 expansion = (size_t) ret;
469
Gilles Peskine449bd832023-01-11 14:50:10 +0100470 if (remaining <= expansion) {
471 return 0;
472 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100473
474 remaining -= expansion;
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 if (remaining >= max_len) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100476 remaining = max_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100477 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100478
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 return (int) remaining;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100480}
481
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200482/*
483 * Double the retransmit timeout value, within the allowed range,
484 * returning -1 if the maximum value has already been reached.
485 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200486MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100487static int ssl_double_retransmit_timeout(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200488{
489 uint32_t new_timeout;
490
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 if (ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max) {
492 return -1;
493 }
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200494
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200495 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
496 * in the following way: after the initial transmission and a first
497 * retransmission, back off to a temporary estimated MTU of 508 bytes.
498 * This value is guaranteed to be deliverable (if not guaranteed to be
499 * delivered) of any compliant IPv4 (and IPv6) network, and should work
500 * on most non-IP stacks too. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100501 if (ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min) {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200502 ssl->handshake->mtu = 508;
Gilles Peskine449bd832023-01-11 14:50:10 +0100503 MBEDTLS_SSL_DEBUG_MSG(2, ("mtu autoreduction to %d bytes", ssl->handshake->mtu));
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400504 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200505
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200506 new_timeout = 2 * ssl->handshake->retransmit_timeout;
507
508 /* Avoid arithmetic overflow and range overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +0100509 if (new_timeout < ssl->handshake->retransmit_timeout ||
510 new_timeout > ssl->conf->hs_timeout_max) {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200511 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200512 }
513
514 ssl->handshake->retransmit_timeout = new_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +0100515 MBEDTLS_SSL_DEBUG_MSG(3, ("update timeout value to %lu millisecs",
516 (unsigned long) ssl->handshake->retransmit_timeout));
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200517
Gilles Peskine449bd832023-01-11 14:50:10 +0100518 return 0;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200519}
520
Gilles Peskine449bd832023-01-11 14:50:10 +0100521static void ssl_reset_retransmit_timeout(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200522{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200523 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Gilles Peskine449bd832023-01-11 14:50:10 +0100524 MBEDTLS_SSL_DEBUG_MSG(3, ("update timeout value to %lu millisecs",
525 (unsigned long) ssl->handshake->retransmit_timeout));
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200526}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200527#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200528
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100529/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000530 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200531 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000532
Ronald Cron6f135e12021-12-08 16:57:54 +0100533#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker13996922020-05-28 16:15:19 +0100534
Gilles Peskine449bd832023-01-11 14:50:10 +0100535static size_t ssl_compute_padding_length(size_t len,
536 size_t granularity)
Hanno Becker13996922020-05-28 16:15:19 +0100537{
Gilles Peskine449bd832023-01-11 14:50:10 +0100538 return (granularity - (len + 1) % granularity) % granularity;
Hanno Becker13996922020-05-28 16:15:19 +0100539}
540
Hanno Becker581bc1b2020-05-04 12:20:03 +0100541/* This functions transforms a (D)TLS plaintext fragment and a record content
542 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
543 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
544 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100545 *
546 * struct {
547 * opaque content[DTLSPlaintext.length];
548 * ContentType real_type;
549 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100550 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100551 *
552 * Input:
553 * - `content`: The beginning of the buffer holding the
554 * plaintext to be wrapped.
555 * - `*content_size`: The length of the plaintext in Bytes.
556 * - `max_len`: The number of Bytes available starting from
557 * `content`. This must be `>= *content_size`.
558 * - `rec_type`: The desired record content type.
559 *
560 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100561 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
562 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100563 *
564 * Returns:
565 * - `0` on success.
566 * - A negative error code if `max_len` didn't offer enough space
567 * for the expansion.
568 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200569MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100570static int ssl_build_inner_plaintext(unsigned char *content,
571 size_t *content_size,
572 size_t remaining,
573 uint8_t rec_type,
574 size_t pad)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100575{
576 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100577
578 /* Write real content type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 if (remaining == 0) {
580 return -1;
581 }
582 content[len] = rec_type;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100583 len++;
584 remaining--;
585
Gilles Peskine449bd832023-01-11 14:50:10 +0100586 if (remaining < pad) {
587 return -1;
588 }
589 memset(content + len, 0, pad);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100590 len += pad;
591 remaining -= pad;
592
593 *content_size = len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 return 0;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100595}
596
Hanno Becker581bc1b2020-05-04 12:20:03 +0100597/* This function parses a (D)TLSInnerPlaintext structure.
598 * See ssl_build_inner_plaintext() for details. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200599MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100600static int ssl_parse_inner_plaintext(unsigned char const *content,
601 size_t *content_size,
602 uint8_t *rec_type)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100603{
604 size_t remaining = *content_size;
605
606 /* Determine length of padding by skipping zeroes from the back. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100607 do {
608 if (remaining == 0) {
609 return -1;
610 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100611 remaining--;
Gilles Peskine449bd832023-01-11 14:50:10 +0100612 } while (content[remaining] == 0);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100613
614 *content_size = remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +0100615 *rec_type = content[remaining];
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100616
Gilles Peskine449bd832023-01-11 14:50:10 +0100617 return 0;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100618}
Ronald Cron6f135e12021-12-08 16:57:54 +0100619#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100620
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200621/* The size of the `add_data` structure depends on various
622 * factors, namely
623 *
624 * 1) CID functionality disabled
625 *
626 * additional_data =
627 * 8: seq_num +
628 * 1: type +
629 * 2: version +
630 * 2: length of inner plaintext +
631 *
632 * size = 13 bytes
633 *
634 * 2) CID functionality based on RFC 9146 enabled
635 *
636 * size = 8 + 1 + 1 + 1 + 2 + 2 + 6 + 2 + CID-length
637 * = 23 + CID-length
638 *
639 * 3) CID functionality based on legacy CID version
640 according to draft-ietf-tls-dtls-connection-id-05
641 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
642 *
643 * size = 13 + 1 + CID-length
644 *
645 * More information about the CID usage:
646 *
647 * Per Section 5.3 of draft-ietf-tls-dtls-connection-id-05 the
648 * size of the additional data structure is calculated as:
649 *
650 * additional_data =
651 * 8: seq_num +
652 * 1: tls12_cid +
653 * 2: DTLSCipherText.version +
654 * n: cid +
655 * 1: cid_length +
656 * 2: length_of_DTLSInnerPlaintext
657 *
658 * Per RFC 9146 the size of the add_data structure is calculated as:
659 *
660 * additional_data =
661 * 8: seq_num_placeholder +
662 * 1: tls12_cid +
663 * 1: cid_length +
664 * 1: tls12_cid +
665 * 2: DTLSCiphertext.version +
666 * 2: epoch +
667 * 6: sequence_number +
668 * n: cid +
669 * 2: length_of_DTLSInnerPlaintext
670 *
671 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100672static void ssl_extract_add_data_from_record(unsigned char *add_data,
673 size_t *add_data_len,
674 mbedtls_record *rec,
675 mbedtls_ssl_protocol_version
676 tls_version,
677 size_t taglen)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000678{
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200679 /* Several types of ciphers have been defined for use with TLS and DTLS,
680 * and the MAC calculations for those ciphers differ slightly. Further
681 * variants were added when the CID functionality was added with RFC 9146.
682 * This implementations also considers the use of a legacy version of the
683 * CID specification published in draft-ietf-tls-dtls-connection-id-05,
684 * which is used in deployments.
685 *
686 * We will distinguish between the non-CID and the CID cases below.
687 *
688 * --- Non-CID cases ---
689 *
690 * Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100691 *
692 * additional_data = seq_num + TLSCompressed.type +
693 * TLSCompressed.version + TLSCompressed.length;
694 *
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100695 * For TLS 1.3, the record sequence number is dropped from the AAD
696 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000697 * Moreover, the additional data involves the length of the TLS
698 * ciphertext, not the TLS plaintext as in earlier versions.
699 * Quoting RFC 8446 (TLS 1.3):
700 *
701 * additional_data = TLSCiphertext.opaque_type ||
702 * TLSCiphertext.legacy_record_version ||
703 * TLSCiphertext.length
704 *
705 * We pass the tag length to this function in order to compute the
706 * ciphertext length from the inner plaintext length rec->data_len via
707 *
708 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
709 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200710 * --- CID cases ---
711 *
712 * RFC 9146 uses a common pattern when constructing the data
713 * passed into a MAC / AEAD cipher.
714 *
715 * Data concatenation for MACs used with block ciphers with
716 * Encrypt-then-MAC Processing (with CID):
717 *
718 * data = seq_num_placeholder +
719 * tls12_cid +
720 * cid_length +
721 * tls12_cid +
722 * DTLSCiphertext.version +
723 * epoch +
724 * sequence_number +
725 * cid +
726 * DTLSCiphertext.length +
727 * IV +
728 * ENC(content + padding + padding_length)
729 *
730 * Data concatenation for MACs used with block ciphers (with CID):
731 *
732 * data = seq_num_placeholder +
733 * tls12_cid +
734 * cid_length +
735 * tls12_cid +
736 * DTLSCiphertext.version +
737 * epoch +
738 * sequence_number +
739 * cid +
740 * length_of_DTLSInnerPlaintext +
741 * DTLSInnerPlaintext.content +
742 * DTLSInnerPlaintext.real_type +
743 * DTLSInnerPlaintext.zeros
744 *
745 * AEAD ciphers use the following additional data calculation (with CIDs):
746 *
747 * additional_data = seq_num_placeholder +
748 * tls12_cid +
749 * cid_length +
750 * tls12_cid +
751 * DTLSCiphertext.version +
752 * epoch +
753 * sequence_number +
754 * cid +
755 * length_of_DTLSInnerPlaintext
756 *
757 * Section 5.3 of draft-ietf-tls-dtls-connection-id-05 (for legacy CID use)
758 * defines the additional data calculation as follows:
759 *
760 * additional_data = seq_num +
761 * tls12_cid +
762 * DTLSCipherText.version +
763 * cid +
764 * cid_length +
765 * length_of_DTLSInnerPlaintext
Gilles Peskine449bd832023-01-11 14:50:10 +0100766 */
Hanno Beckercab87e62019-04-29 13:52:53 +0100767
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100768 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000769 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100770
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200771#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
772 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
773 const unsigned char seq_num_placeholder[] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
774#endif
775
Ronald Cron6f135e12021-12-08 16:57:54 +0100776#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100777 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000778 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
779 * which differs from the length of the TLSInnerPlaintext
780 * by the length of the authentication tag. */
781 ad_len_field += taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +0100782 } else
Ronald Cron6f135e12021-12-08 16:57:54 +0100783#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100784 {
Glenn Strauss07c64162022-03-14 12:34:51 -0400785 ((void) tls_version);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000786 ((void) taglen);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200787
Manuel Pégourié-Gonnard61336842022-11-25 11:12:38 +0100788#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100789 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
790 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200791 // seq_num_placeholder
Gilles Peskine449bd832023-01-11 14:50:10 +0100792 memcpy(cur, seq_num_placeholder, sizeof(seq_num_placeholder));
793 cur += sizeof(seq_num_placeholder);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200794
795 // tls12_cid type
796 *cur = rec->type;
797 cur++;
798
799 // cid_length
800 *cur = rec->cid_len;
801 cur++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100802 } else
Manuel Pégourié-Gonnard61336842022-11-25 11:12:38 +0100803#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200804 {
805 // epoch + sequence number
Gilles Peskine449bd832023-01-11 14:50:10 +0100806 memcpy(cur, rec->ctr, sizeof(rec->ctr));
807 cur += sizeof(rec->ctr);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200808 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100809 }
810
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200811 // type
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100812 *cur = rec->type;
813 cur++;
814
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200815 // version
Gilles Peskine449bd832023-01-11 14:50:10 +0100816 memcpy(cur, rec->ver, sizeof(rec->ver));
817 cur += sizeof(rec->ver);
Hanno Beckercab87e62019-04-29 13:52:53 +0100818
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200819#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
820 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 1
821
Gilles Peskine449bd832023-01-11 14:50:10 +0100822 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200823 // CID
824 memcpy(cur, rec->cid, rec->cid_len);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100825 cur += rec->cid_len;
826
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200827 // cid_length
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100828 *cur = rec->cid_len;
829 cur++;
830
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200831 // length of inner plaintext
832 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
833 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100834 } else
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200835#elif defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
836 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
837
Gilles Peskine449bd832023-01-11 14:50:10 +0100838 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200839 // epoch + sequence number
840 memcpy(cur, rec->ctr, sizeof(rec->ctr));
841 cur += sizeof(rec->ctr);
842
843 // CID
Gilles Peskine449bd832023-01-11 14:50:10 +0100844 memcpy(cur, rec->cid, rec->cid_len);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200845 cur += rec->cid_len;
846
847 // length of inner plaintext
Gilles Peskine449bd832023-01-11 14:50:10 +0100848 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100849 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100850 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100851#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100852 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100853 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100854 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100855 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100856
857 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000858}
859
Hanno Becker67a37db2020-05-28 16:27:07 +0100860#if defined(MBEDTLS_GCM_C) || \
861 defined(MBEDTLS_CCM_C) || \
862 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200863MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker17263802020-05-28 07:05:48 +0100864static int ssl_transform_aead_dynamic_iv_is_explicit(
Gilles Peskine449bd832023-01-11 14:50:10 +0100865 mbedtls_ssl_transform const *transform)
Hanno Beckerdf8be222020-05-21 15:30:57 +0100866{
Gilles Peskine449bd832023-01-11 14:50:10 +0100867 return transform->ivlen != transform->fixed_ivlen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100868}
869
Hanno Becker17263802020-05-28 07:05:48 +0100870/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
871 *
872 * Concretely, this occurs in two variants:
873 *
874 * a) Fixed and dynamic IV lengths add up to total IV length, giving
875 * IV = fixed_iv || dynamic_iv
876 *
Hanno Becker15952812020-06-04 13:31:46 +0100877 * This variant is used in TLS 1.2 when used with GCM or CCM.
878 *
Hanno Becker17263802020-05-28 07:05:48 +0100879 * b) Fixed IV lengths matches total IV length, giving
880 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100881 *
882 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
883 *
884 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100885 *
886 * This function has the precondition that
887 *
888 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
889 *
890 * which has to be ensured by the caller. If this precondition
891 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100892 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100893static void ssl_build_record_nonce(unsigned char *dst_iv,
894 size_t dst_iv_len,
895 unsigned char const *fixed_iv,
896 size_t fixed_iv_len,
897 unsigned char const *dynamic_iv,
898 size_t dynamic_iv_len)
Hanno Becker17263802020-05-28 07:05:48 +0100899{
Hanno Beckerdf8be222020-05-21 15:30:57 +0100900 /* Start with Fixed IV || 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100901 memset(dst_iv, 0, dst_iv_len);
902 memcpy(dst_iv, fixed_iv, fixed_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100903
Hanno Becker17263802020-05-28 07:05:48 +0100904 dst_iv += dst_iv_len - dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100905 mbedtls_xor(dst_iv, dst_iv, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100906}
Hanno Becker67a37db2020-05-28 16:27:07 +0100907#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100908
Gilles Peskine449bd832023-01-11 14:50:10 +0100909int mbedtls_ssl_encrypt_buf(mbedtls_ssl_context *ssl,
910 mbedtls_ssl_transform *transform,
911 mbedtls_record *rec,
912 int (*f_rng)(void *, unsigned char *, size_t),
913 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +0000914{
Neil Armstrong136f8402022-03-30 10:58:01 +0200915 mbedtls_ssl_mode_t ssl_mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100916 int auth_done = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100917 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200918 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +0100919 * the description of ssl_extract_add_data_from_record().
920 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200921#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
922 unsigned char add_data[23 + MBEDTLS_SSL_CID_OUT_LEN_MAX];
923#else
924 unsigned char add_data[13];
925#endif
Hanno Beckercab87e62019-04-29 13:52:53 +0100926 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000927 size_t post_avail;
928
929 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000930#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200931 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000932 ((void) ssl);
933#endif
934
935 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200936 * for CBC transformations in TLS 1.2. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100937#if !(defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
938 defined(MBEDTLS_SSL_PROTO_TLS1_2))
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000939 ((void) f_rng);
940 ((void) p_rng);
941#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000942
Gilles Peskine449bd832023-01-11 14:50:10 +0100943 MBEDTLS_SSL_DEBUG_MSG(2, ("=> encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +0000944
Gilles Peskine449bd832023-01-11 14:50:10 +0100945 if (transform == NULL) {
946 MBEDTLS_SSL_DEBUG_MSG(1, ("no transform provided to encrypt_buf"));
947 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000948 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100949 if (rec == NULL
Hanno Becker43c24b82019-05-01 09:45:57 +0100950 || rec->buf == NULL
951 || rec->buf_len < rec->data_offset
952 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100953#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100954 || rec->cid_len != 0
955#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 ) {
957 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to encrypt_buf"));
958 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100959 }
960
Gilles Peskine449bd832023-01-11 14:50:10 +0100961 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Neil Armstrong136f8402022-03-30 10:58:01 +0200962
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000963 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +0100964 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
965 MBEDTLS_SSL_DEBUG_BUF(4, "before encrypt: output payload",
966 data, rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000967
Gilles Peskine449bd832023-01-11 14:50:10 +0100968 if (rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
969 MBEDTLS_SSL_DEBUG_MSG(1, ("Record content %" MBEDTLS_PRINTF_SIZET
970 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
971 rec->data_len,
972 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
973 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000974 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100975
Hanno Becker92313402020-05-20 13:58:58 +0100976 /* The following two code paths implement the (D)TLSInnerPlaintext
977 * structure present in TLS 1.3 and DTLS 1.2 + CID.
978 *
979 * See ssl_build_inner_plaintext() for more information.
980 *
981 * Note that this changes `rec->data_len`, and hence
982 * `post_avail` needs to be recalculated afterwards.
983 *
984 * Note also that the two code paths cannot occur simultaneously
985 * since they apply to different versions of the protocol. There
986 * is hence no risk of double-addition of the inner plaintext.
987 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100988#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100989 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker13996922020-05-28 16:15:19 +0100990 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +0100991 ssl_compute_padding_length(rec->data_len,
992 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
993 if (ssl_build_inner_plaintext(data,
994 &rec->data_len,
995 post_avail,
996 rec->type,
997 padding) != 0) {
998 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerccc13d02020-05-04 12:30:04 +0100999 }
1000
1001 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
1002 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001003#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001004
Hanno Beckera0e20d02019-05-15 14:03:01 +01001005#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001006 /*
1007 * Add CID information
1008 */
1009 rec->cid_len = transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001010 memcpy(rec->cid, transform->out_cid, transform->out_cid_len);
1011 MBEDTLS_SSL_DEBUG_BUF(3, "CID", rec->cid, rec->cid_len);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001012
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 if (rec->cid_len != 0) {
Hanno Becker13996922020-05-28 16:15:19 +01001014 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +01001015 ssl_compute_padding_length(rec->data_len,
1016 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001017 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +01001018 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +01001019 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001020 *
Hanno Becker07dc97d2019-05-20 15:08:01 +01001021 * Note that this changes `rec->data_len`, and hence
1022 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001023 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001024 if (ssl_build_inner_plaintext(data,
1025 &rec->data_len,
1026 post_avail,
1027 rec->type,
1028 padding) != 0) {
1029 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001030 }
1031
1032 rec->type = MBEDTLS_SSL_MSG_CID;
1033 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001034#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001035
Gilles Peskine449bd832023-01-11 14:50:10 +01001036 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001037
Paul Bakker5121ce52009-01-03 21:22:43 +00001038 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001039 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +00001040 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001041#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001042 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
1043 ssl_mode == MBEDTLS_SSL_MODE_CBC) {
1044 if (post_avail < transform->maclen) {
1045 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1046 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001047 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02001048#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001049 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001050 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstrong26e6d672022-02-23 09:30:33 +01001051#if defined(MBEDTLS_USE_PSA_CRYPTO)
1052 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1053 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1054 size_t sign_mac_length = 0;
1055#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker992b6872017-11-09 18:57:39 +00001056
Gilles Peskine449bd832023-01-11 14:50:10 +01001057 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1058 transform->tls_version,
1059 transform->taglen);
Hanno Becker992b6872017-11-09 18:57:39 +00001060
Neil Armstrong26e6d672022-02-23 09:30:33 +01001061#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001062 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1063 transform->psa_mac_alg);
1064 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001065 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001066 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001067
Gilles Peskine449bd832023-01-11 14:50:10 +01001068 status = psa_mac_update(&operation, add_data, add_data_len);
1069 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001070 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001072
Gilles Peskine449bd832023-01-11 14:50:10 +01001073 status = psa_mac_update(&operation, data, rec->data_len);
1074 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001075 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001077
Gilles Peskine449bd832023-01-11 14:50:10 +01001078 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1079 &sign_mac_length);
1080 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001081 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001082 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001083#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, add_data,
1085 add_data_len);
1086 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001087 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001088 }
1089 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, data, rec->data_len);
1090 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001091 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 }
1093 ret = mbedtls_md_hmac_finish(&transform->md_ctx_enc, mac);
1094 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001095 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 }
1097 ret = mbedtls_md_hmac_reset(&transform->md_ctx_enc);
1098 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001099 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001100 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001101#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001102
Gilles Peskine449bd832023-01-11 14:50:10 +01001103 memcpy(data + rec->data_len, mac, transform->maclen);
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001104#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001105
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 MBEDTLS_SSL_DEBUG_BUF(4, "computed mac", data + rec->data_len,
1107 transform->maclen);
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001108
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001109 rec->data_len += transform->maclen;
1110 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001111 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001112
Gilles Peskine449bd832023-01-11 14:50:10 +01001113hmac_failed_etm_disabled:
1114 mbedtls_platform_zeroize(mac, transform->maclen);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001115#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001116 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 status = psa_mac_abort(&operation);
1118 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001119 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001120 }
Neil Armstrong4313f552022-03-02 15:14:07 +01001121#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001122 if (ret != 0) {
1123 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_hmac_xxx", ret);
1124 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001125 }
Paul Bakker577e0062013-08-28 11:57:20 +02001126 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001127#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001128
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001129 /*
1130 * Encrypt
1131 */
Hanno Beckerd086bf02021-03-22 13:01:27 +00001132#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
1134 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1135 "including %d bytes of padding",
1136 rec->data_len, 0));
Paul Bakker5121ce52009-01-03 21:22:43 +00001137
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001138 /* The only supported stream cipher is "NULL",
1139 * so there's nothing to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001140 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001141#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001142
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001143#if defined(MBEDTLS_GCM_C) || \
1144 defined(MBEDTLS_CCM_C) || \
1145 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001146 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001147 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001148 unsigned char *dynamic_iv;
1149 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +01001150 int dynamic_iv_is_explicit =
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 ssl_transform_aead_dynamic_iv_is_explicit(transform);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001152#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001153 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001154#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001155 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001156
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +01001157 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001158 if (post_avail < transform->taglen) {
1159 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1160 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001161 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001162
Paul Bakker68884e32013-01-07 18:20:04 +01001163 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001164 * Build nonce for AEAD encryption.
1165 *
1166 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1167 * part of the IV is prepended to the ciphertext and
1168 * can be chosen freely - in particular, it need not
1169 * agree with the record sequence number.
1170 * However, since ChaChaPoly as well as all AEAD modes
1171 * in TLS 1.3 use the record sequence number as the
1172 * dynamic part of the nonce, we uniformly use the
1173 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +01001174 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001175 dynamic_iv = rec->ctr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001176 dynamic_iv_len = sizeof(rec->ctr);
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001177
Gilles Peskine449bd832023-01-11 14:50:10 +01001178 ssl_build_record_nonce(iv, sizeof(iv),
1179 transform->iv_enc,
1180 transform->fixed_ivlen,
1181 dynamic_iv,
1182 dynamic_iv_len);
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +01001183
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001184 /*
1185 * Build additional data for AEAD encryption.
1186 * This depends on the TLS version.
1187 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001188 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1189 transform->tls_version,
1190 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001191
Gilles Peskine449bd832023-01-11 14:50:10 +01001192 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (internal)",
1193 iv, transform->ivlen);
1194 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (transmitted)",
1195 dynamic_iv,
1196 dynamic_iv_is_explicit ? dynamic_iv_len : 0);
1197 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1198 add_data, add_data_len);
1199 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1200 "including 0 bytes of padding",
1201 rec->data_len));
Paul Bakkerca4ab492012-04-18 14:23:57 +00001202
Paul Bakker68884e32013-01-07 18:20:04 +01001203 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001204 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001205 */
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001206#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001207 status = psa_aead_encrypt(transform->psa_key_enc,
1208 transform->psa_alg,
1209 iv, transform->ivlen,
1210 add_data, add_data_len,
1211 data, rec->data_len,
1212 data, rec->buf_len - (data - rec->buf),
1213 &rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001214
Gilles Peskine449bd832023-01-11 14:50:10 +01001215 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001216 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001217 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_encrypt_buf", ret);
1218 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001219 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001220#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 if ((ret = mbedtls_cipher_auth_encrypt_ext(&transform->cipher_ctx_enc,
1222 iv, transform->ivlen,
1223 add_data, add_data_len,
1224 data, rec->data_len, /* src */
1225 data, rec->buf_len - (data - rec->buf), /* dst */
1226 &rec->data_len,
1227 transform->taglen)) != 0) {
1228 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_auth_encrypt_ext", ret);
1229 return ret;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001230 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001231#endif /* MBEDTLS_USE_PSA_CRYPTO */
1232
Gilles Peskine449bd832023-01-11 14:50:10 +01001233 MBEDTLS_SSL_DEBUG_BUF(4, "after encrypt: tag",
1234 data + rec->data_len - transform->taglen,
1235 transform->taglen);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001236 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001237 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001238
1239 /*
1240 * Prefix record content with dynamic IV in case it is explicit.
1241 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001242 if (dynamic_iv_is_explicit != 0) {
1243 if (rec->data_offset < dynamic_iv_len) {
1244 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1245 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001246 }
1247
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 memcpy(data - dynamic_iv_len, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001249 rec->data_offset -= dynamic_iv_len;
1250 rec->data_len += dynamic_iv_len;
1251 }
1252
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001253 auth_done++;
Gilles Peskine449bd832023-01-11 14:50:10 +01001254 } else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +01001255#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001256#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001257 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1258 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00001259 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001260 size_t padlen, i;
1261 size_t olen;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001262#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001263 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001264 size_t part_len;
1265 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1266#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001267
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001268 /* Currently we're always using minimal padding
1269 * (up to 255 bytes would be allowed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001270 padlen = transform->ivlen - (rec->data_len + 1) % transform->ivlen;
1271 if (padlen == transform->ivlen) {
Paul Bakker5121ce52009-01-03 21:22:43 +00001272 padlen = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001273 }
1274
Gilles Peskine449bd832023-01-11 14:50:10 +01001275 /* Check there's enough space in the buffer for the padding. */
1276 if (post_avail < padlen + 1) {
1277 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1278 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1279 }
1280
1281 for (i = 0; i <= padlen; i++) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001282 data[rec->data_len + i] = (unsigned char) padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001283 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001284
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001285 rec->data_len += padlen + 1;
1286 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001287
TRodziewicz0f82ec62021-05-12 17:49:18 +02001288#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001289 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +02001290 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +00001291 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001292 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001293 if (f_rng == NULL) {
1294 MBEDTLS_SSL_DEBUG_MSG(1, ("No PRNG provided to encrypt_record routine"));
1295 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001296 }
TRodziewicz345165c2021-07-06 13:42:11 +02001297
Gilles Peskine449bd832023-01-11 14:50:10 +01001298 if (rec->data_offset < transform->ivlen) {
1299 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1300 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
TRodziewicz345165c2021-07-06 13:42:11 +02001301 }
1302
1303 /*
1304 * Generate IV
1305 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001306 ret = f_rng(p_rng, transform->iv_enc, transform->ivlen);
1307 if (ret != 0) {
1308 return ret;
1309 }
TRodziewicz345165c2021-07-06 13:42:11 +02001310
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 memcpy(data - transform->ivlen, transform->iv_enc, transform->ivlen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001312#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001313
Gilles Peskine449bd832023-01-11 14:50:10 +01001314 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1315 "including %"
1316 MBEDTLS_PRINTF_SIZET
1317 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
1318 rec->data_len, transform->ivlen,
1319 padlen + 1));
Paul Bakker5121ce52009-01-03 21:22:43 +00001320
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001321#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001322 status = psa_cipher_encrypt_setup(&cipher_op,
1323 transform->psa_key_enc, transform->psa_alg);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001324
Gilles Peskine449bd832023-01-11 14:50:10 +01001325 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001326 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001327 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_encrypt_setup", ret);
1328 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001329 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001330
Gilles Peskine449bd832023-01-11 14:50:10 +01001331 status = psa_cipher_set_iv(&cipher_op, transform->iv_enc, transform->ivlen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001332
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001334 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1336 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001337
1338 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001339
Gilles Peskine449bd832023-01-11 14:50:10 +01001340 status = psa_cipher_update(&cipher_op,
1341 data, rec->data_len,
1342 data, rec->data_len, &olen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001343
Gilles Peskine449bd832023-01-11 14:50:10 +01001344 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001345 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001346 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1347 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001348
1349 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001350
Gilles Peskine449bd832023-01-11 14:50:10 +01001351 status = psa_cipher_finish(&cipher_op,
1352 data + olen, rec->data_len - olen,
1353 &part_len);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001354
Gilles Peskine449bd832023-01-11 14:50:10 +01001355 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001356 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001357 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1358 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001359
1360 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001361
1362 olen += part_len;
1363#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 if ((ret = mbedtls_cipher_crypt(&transform->cipher_ctx_enc,
1365 transform->iv_enc,
1366 transform->ivlen,
1367 data, rec->data_len,
1368 data, &olen)) != 0) {
1369 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_crypt", ret);
1370 return ret;
Paul Bakkercca5b812013-08-31 17:40:26 +02001371 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001372#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001373
Gilles Peskine449bd832023-01-11 14:50:10 +01001374 if (rec->data_len != olen) {
1375 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1376 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001377 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001378
TRodziewicz0f82ec62021-05-12 17:49:18 +02001379 data -= transform->ivlen;
1380 rec->data_offset -= transform->ivlen;
1381 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001382
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001383#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001384 if (auth_done == 0) {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001385 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001386#if defined(MBEDTLS_USE_PSA_CRYPTO)
1387 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1388 size_t sign_mac_length = 0;
1389#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker3d8c9072018-01-05 16:24:22 +00001390
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001391 /* MAC(MAC_write_key, add_data, IV, ENC(content + padding + padding_length))
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001392 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001393
Gilles Peskine449bd832023-01-11 14:50:10 +01001394 if (post_avail < transform->maclen) {
1395 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1396 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001397 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001398
Gilles Peskine449bd832023-01-11 14:50:10 +01001399 ssl_extract_add_data_from_record(add_data, &add_data_len,
1400 rec, transform->tls_version,
1401 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001402
Gilles Peskine449bd832023-01-11 14:50:10 +01001403 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
1404 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1405 add_data_len);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001406#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001407 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1408 transform->psa_mac_alg);
1409 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001410 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001411 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001412
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 status = psa_mac_update(&operation, add_data, add_data_len);
1414 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001415 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001416 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001417
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 status = psa_mac_update(&operation, data, rec->data_len);
1419 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001420 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001422
Gilles Peskine449bd832023-01-11 14:50:10 +01001423 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1424 &sign_mac_length);
1425 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001426 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001427 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001428#else
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001429
Gilles Peskine449bd832023-01-11 14:50:10 +01001430 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, add_data,
1431 add_data_len);
1432 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001433 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001434 }
1435 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc,
1436 data, rec->data_len);
1437 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001438 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001439 }
1440 ret = mbedtls_md_hmac_finish(&transform->md_ctx_enc, mac);
1441 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001442 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001443 }
1444 ret = mbedtls_md_hmac_reset(&transform->md_ctx_enc);
1445 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001446 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001447 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001448#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001449
Gilles Peskine449bd832023-01-11 14:50:10 +01001450 memcpy(data + rec->data_len, mac, transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001451
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001452 rec->data_len += transform->maclen;
1453 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001454 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001455
Gilles Peskine449bd832023-01-11 14:50:10 +01001456hmac_failed_etm_enabled:
1457 mbedtls_platform_zeroize(mac, transform->maclen);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001458#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001459 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001460 status = psa_mac_abort(&operation);
1461 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001462 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001463 }
Neil Armstrong4313f552022-03-02 15:14:07 +01001464#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001465 if (ret != 0) {
1466 MBEDTLS_SSL_DEBUG_RET(1, "HMAC calculation failed", ret);
1467 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001468 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001469 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001470#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01001471 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001472#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001473 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001474 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1475 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001476 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001477
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001478 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01001479 if (auth_done != 1) {
1480 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1481 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001482 }
1483
Gilles Peskine449bd832023-01-11 14:50:10 +01001484 MBEDTLS_SSL_DEBUG_MSG(2, ("<= encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001485
Gilles Peskine449bd832023-01-11 14:50:10 +01001486 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001487}
1488
Gilles Peskine449bd832023-01-11 14:50:10 +01001489int mbedtls_ssl_decrypt_buf(mbedtls_ssl_context const *ssl,
1490 mbedtls_ssl_transform *transform,
1491 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00001492{
Przemek Stekiel4c499272022-09-27 13:55:37 +02001493#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) || defined(MBEDTLS_CIPHER_MODE_AEAD)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001494 size_t olen;
Przemek Stekiel4c499272022-09-27 13:55:37 +02001495#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC || MBEDTLS_CIPHER_MODE_AEAD */
Neil Armstrong136f8402022-03-30 10:58:01 +02001496 mbedtls_ssl_mode_t ssl_mode;
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001497 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001498
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001499 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001500#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Paul Bakker1e5369c2013-12-19 16:40:57 +01001501 size_t padlen = 0, correct = 1;
1502#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001503 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001504 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +01001505 * the description of ssl_extract_add_data_from_record().
1506 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001507#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1508 unsigned char add_data[23 + MBEDTLS_SSL_CID_IN_LEN_MAX];
1509#else
1510 unsigned char add_data[13];
1511#endif
Hanno Beckercab87e62019-04-29 13:52:53 +01001512 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001513
Hanno Beckera18d1322018-01-03 14:27:32 +00001514#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001515 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001516 ((void) ssl);
1517#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001518
Gilles Peskine449bd832023-01-11 14:50:10 +01001519 MBEDTLS_SSL_DEBUG_MSG(2, ("=> decrypt buf"));
1520 if (rec == NULL ||
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001521 rec->buf == NULL ||
1522 rec->buf_len < rec->data_offset ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001523 rec->buf_len - rec->data_offset < rec->data_len) {
1524 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to decrypt_buf"));
1525 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001526 }
1527
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001528 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Paul Bakker5121ce52009-01-03 21:22:43 +00001530
Hanno Beckera0e20d02019-05-15 14:03:01 +01001531#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001532 /*
1533 * Match record's CID with incoming CID.
1534 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001535 if (rec->cid_len != transform->in_cid_len ||
1536 memcmp(rec->cid, transform->in_cid, rec->cid_len) != 0) {
1537 return MBEDTLS_ERR_SSL_UNEXPECTED_CID;
Hanno Becker938489a2019-05-08 13:02:22 +01001538 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001539#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001540
Hanno Beckerd086bf02021-03-22 13:01:27 +00001541#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001542 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001543 /* The only supported stream cipher is "NULL",
1544 * so there's nothing to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001545 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001546#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001547#if defined(MBEDTLS_GCM_C) || \
1548 defined(MBEDTLS_CCM_C) || \
1549 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001550 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001551 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001552 unsigned char *dynamic_iv;
1553 size_t dynamic_iv_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001554#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001555 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001556#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001557
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001558 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001559 * Extract dynamic part of nonce for AEAD decryption.
1560 *
1561 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1562 * part of the IV is prepended to the ciphertext and
1563 * can be chosen freely - in particular, it need not
1564 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001565 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001566 dynamic_iv_len = sizeof(rec->ctr);
1567 if (ssl_transform_aead_dynamic_iv_is_explicit(transform) == 1) {
1568 if (rec->data_len < dynamic_iv_len) {
1569 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1570 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
1571 rec->data_len,
1572 dynamic_iv_len));
1573 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001574 }
1575 dynamic_iv = data;
1576
1577 data += dynamic_iv_len;
1578 rec->data_offset += dynamic_iv_len;
1579 rec->data_len -= dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001580 } else {
Hanno Becker17263802020-05-28 07:05:48 +01001581 dynamic_iv = rec->ctr;
1582 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001583
1584 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001585 if (rec->data_len < transform->taglen) {
1586 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1587 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
1588 rec->data_len,
1589 transform->taglen));
1590 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001591 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001592 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001593
Hanno Beckerdf8be222020-05-21 15:30:57 +01001594 /*
1595 * Prepare nonce from dynamic and static parts.
1596 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001597 ssl_build_record_nonce(iv, sizeof(iv),
1598 transform->iv_dec,
1599 transform->fixed_ivlen,
1600 dynamic_iv,
1601 dynamic_iv_len);
Paul Bakker68884e32013-01-07 18:20:04 +01001602
Hanno Beckerdf8be222020-05-21 15:30:57 +01001603 /*
1604 * Build additional data for AEAD encryption.
1605 * This depends on the TLS version.
1606 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001607 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1608 transform->tls_version,
1609 transform->taglen);
1610 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1611 add_data, add_data_len);
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001612
Hanno Beckerd96a6522019-07-10 13:55:25 +01001613 /* Because of the check above, we know that there are
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001614 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001615 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001616 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001617 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001618
Gilles Peskine449bd832023-01-11 14:50:10 +01001619 MBEDTLS_SSL_DEBUG_BUF(4, "IV used", iv, transform->ivlen);
1620 MBEDTLS_SSL_DEBUG_BUF(4, "TAG used", data + rec->data_len,
1621 transform->taglen);
Paul Bakker68884e32013-01-07 18:20:04 +01001622
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001623 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001624 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001625 */
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001626#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001627 status = psa_aead_decrypt(transform->psa_key_dec,
1628 transform->psa_alg,
1629 iv, transform->ivlen,
1630 add_data, add_data_len,
1631 data, rec->data_len + transform->taglen,
1632 data, rec->buf_len - (data - rec->buf),
1633 &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001634
Gilles Peskine449bd832023-01-11 14:50:10 +01001635 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001636 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001637 MBEDTLS_SSL_DEBUG_RET(1, "psa_aead_decrypt", ret);
1638 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001639 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001640#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001641 if ((ret = mbedtls_cipher_auth_decrypt_ext(&transform->cipher_ctx_dec,
1642 iv, transform->ivlen,
1643 add_data, add_data_len,
1644 data, rec->data_len + transform->taglen, /* src */
1645 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
1646 transform->taglen)) != 0) {
1647 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_auth_decrypt_ext", ret);
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001648
Gilles Peskine449bd832023-01-11 14:50:10 +01001649 if (ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED) {
1650 return MBEDTLS_ERR_SSL_INVALID_MAC;
1651 }
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001652
Gilles Peskine449bd832023-01-11 14:50:10 +01001653 return ret;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001654 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001655#endif /* MBEDTLS_USE_PSA_CRYPTO */
1656
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001657 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001658
Hanno Beckerd96a6522019-07-10 13:55:25 +01001659 /* Double-check that AEAD decryption doesn't change content length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001660 if (olen != rec->data_len) {
1661 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1662 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001663 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001664 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001665#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001666#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001667 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1668 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001669 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001670#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001671 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001672 size_t part_len;
1673 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1674#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001675
Paul Bakker5121ce52009-01-03 21:22:43 +00001676 /*
Paul Bakker45829992013-01-03 14:52:21 +01001677 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001678 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001679#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001680 /* The ciphertext is prefixed with the CBC IV. */
1681 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001682#endif
Paul Bakker45829992013-01-03 14:52:21 +01001683
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001684 /* Size considerations:
1685 *
1686 * - The CBC cipher text must not be empty and hence
1687 * at least of size transform->ivlen.
1688 *
1689 * Together with the potential IV-prefix, this explains
1690 * the first of the two checks below.
1691 *
1692 * - The record must contain a MAC, either in plain or
1693 * encrypted, depending on whether Encrypt-then-MAC
1694 * is used or not.
1695 * - If it is, the message contains the IV-prefix,
1696 * the CBC ciphertext, and the MAC.
1697 * - If it is not, the padded plaintext, and hence
1698 * the CBC ciphertext, has at least length maclen + 1
1699 * because there is at least the padding length byte.
1700 *
1701 * As the CBC ciphertext is not empty, both cases give the
1702 * lower bound minlen + maclen + 1 on the record size, which
1703 * we test for in the second check below.
1704 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001705 if (rec->data_len < minlen + transform->ivlen ||
1706 rec->data_len < minlen + transform->maclen + 1) {
1707 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1708 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1709 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
1710 "+ 1 ) ( + expl IV )",
1711 rec->data_len,
1712 transform->ivlen,
1713 transform->maclen));
1714 return MBEDTLS_ERR_SSL_INVALID_MAC;
Paul Bakker45829992013-01-03 14:52:21 +01001715 }
1716
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001717 /*
1718 * Authenticate before decrypt if enabled
1719 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001720#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001721 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001722#if defined(MBEDTLS_USE_PSA_CRYPTO)
1723 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1724#else
Hanno Becker992b6872017-11-09 18:57:39 +00001725 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001726#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001727
Gilles Peskine449bd832023-01-11 14:50:10 +01001728 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001729
Hanno Beckerd96a6522019-07-10 13:55:25 +01001730 /* Update data_len in tandem with add_data.
1731 *
1732 * The subtraction is safe because of the previous check
1733 * data_len >= minlen + maclen + 1.
1734 *
1735 * Afterwards, we know that data + data_len is followed by at
1736 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001737 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001738 *
1739 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001740 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1742 transform->tls_version,
1743 transform->taglen);
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001744
Hanno Beckerd96a6522019-07-10 13:55:25 +01001745 /* Calculate expected MAC. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1747 add_data_len);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001748#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001749 status = psa_mac_verify_setup(&operation, transform->psa_mac_dec,
1750 transform->psa_mac_alg);
1751 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001752 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001753 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001754
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 status = psa_mac_update(&operation, add_data, add_data_len);
1756 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001757 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001758 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001759
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 status = psa_mac_update(&operation, data, rec->data_len);
1761 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001762 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001763 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001764
1765 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001766 status = psa_mac_verify_finish(&operation, data + rec->data_len,
1767 transform->maclen);
1768 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001769 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001770 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001771#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001772 ret = mbedtls_md_hmac_update(&transform->md_ctx_dec, add_data,
1773 add_data_len);
1774 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001775 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001776 }
1777 ret = mbedtls_md_hmac_update(&transform->md_ctx_dec,
1778 data, rec->data_len);
1779 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001780 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001781 }
1782 ret = mbedtls_md_hmac_finish(&transform->md_ctx_dec, mac_expect);
1783 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001784 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001785 }
1786 ret = mbedtls_md_hmac_reset(&transform->md_ctx_dec);
1787 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001788 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001789 }
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001790
Gilles Peskine449bd832023-01-11 14:50:10 +01001791 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", data + rec->data_len,
1792 transform->maclen);
1793 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect,
1794 transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001795
Hanno Beckerd96a6522019-07-10 13:55:25 +01001796 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001797 if (mbedtls_ct_memcmp(data + rec->data_len, mac_expect,
1798 transform->maclen) != 0) {
1799 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001800 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1801 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001802 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001803#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001804 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001805
Gilles Peskine449bd832023-01-11 14:50:10 +01001806hmac_failed_etm_enabled:
Neil Armstrong26e6d672022-02-23 09:30:33 +01001807#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001808 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001809 status = psa_mac_abort(&operation);
1810 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001811 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001812 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001813#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001814 mbedtls_platform_zeroize(mac_expect, transform->maclen);
Neil Armstrong4313f552022-03-02 15:14:07 +01001815#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001816 if (ret != 0) {
1817 if (ret != MBEDTLS_ERR_SSL_INVALID_MAC) {
1818 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_hmac_xxx", ret);
1819 }
1820 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001821 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001822 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001823#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001824
1825 /*
1826 * Check length sanity
1827 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001828
1829 /* We know from above that data_len > minlen >= 0,
1830 * so the following check in particular implies that
1831 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001832 if (rec->data_len % transform->ivlen != 0) {
1833 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1834 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
1835 rec->data_len, transform->ivlen));
1836 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001837 }
1838
TRodziewicz0f82ec62021-05-12 17:49:18 +02001839#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001840 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001841 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001842 */
TRodziewicz345165c2021-07-06 13:42:11 +02001843 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001844 memcpy(transform->iv_dec, data, transform->ivlen);
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001845
TRodziewicz345165c2021-07-06 13:42:11 +02001846 data += transform->ivlen;
1847 rec->data_offset += transform->ivlen;
1848 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001849#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001850
Hanno Beckerd96a6522019-07-10 13:55:25 +01001851 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1852
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001853#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001854 status = psa_cipher_decrypt_setup(&cipher_op,
1855 transform->psa_key_dec, transform->psa_alg);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001856
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001858 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_decrypt_setup", ret);
1860 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001861 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001862
Gilles Peskine449bd832023-01-11 14:50:10 +01001863 status = psa_cipher_set_iv(&cipher_op, transform->iv_dec, transform->ivlen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001864
Gilles Peskine449bd832023-01-11 14:50:10 +01001865 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001866 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001867 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1868 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001869 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001870
Gilles Peskine449bd832023-01-11 14:50:10 +01001871 status = psa_cipher_update(&cipher_op,
1872 data, rec->data_len,
1873 data, rec->data_len, &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001874
Gilles Peskine449bd832023-01-11 14:50:10 +01001875 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001876 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001877 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1878 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001879 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001880
Gilles Peskine449bd832023-01-11 14:50:10 +01001881 status = psa_cipher_finish(&cipher_op,
1882 data + olen, rec->data_len - olen,
1883 &part_len);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001884
Gilles Peskine449bd832023-01-11 14:50:10 +01001885 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001886 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001887 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1888 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001889 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001890
1891 olen += part_len;
1892#else
1893
Gilles Peskine449bd832023-01-11 14:50:10 +01001894 if ((ret = mbedtls_cipher_crypt(&transform->cipher_ctx_dec,
1895 transform->iv_dec, transform->ivlen,
1896 data, rec->data_len, data, &olen)) != 0) {
1897 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_crypt", ret);
1898 return ret;
Paul Bakkercca5b812013-08-31 17:40:26 +02001899 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001900#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001901
Hanno Beckerd96a6522019-07-10 13:55:25 +01001902 /* Double-check that length hasn't changed during decryption. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001903 if (rec->data_len != olen) {
1904 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1905 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001906 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001907
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001908 /* Safe since data_len >= minlen + maclen + 1, so after having
1909 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001910 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1911 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001912 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001913
Gilles Peskine449bd832023-01-11 14:50:10 +01001914 if (auth_done == 1) {
Gabor Mezei90437e32021-10-20 11:59:27 +02001915 const size_t mask = mbedtls_ct_size_mask_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001916 rec->data_len,
1917 padlen + 1);
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001918 correct &= mask;
1919 padlen &= mask;
Gilles Peskine449bd832023-01-11 14:50:10 +01001920 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001921#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001922 if (rec->data_len < transform->maclen + padlen + 1) {
1923 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1924 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1925 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
1926 rec->data_len,
1927 transform->maclen,
1928 padlen + 1));
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001929 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001930#endif
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001931
Gabor Mezei90437e32021-10-20 11:59:27 +02001932 const size_t mask = mbedtls_ct_size_mask_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001933 rec->data_len,
1934 transform->maclen + padlen + 1);
Manuel Pégourié-Gonnard2ddec432020-08-24 12:49:23 +02001935 correct &= mask;
1936 padlen &= mask;
Paul Bakker45829992013-01-03 14:52:21 +01001937 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001938
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001939 padlen++;
1940
1941 /* Regardless of the validity of the padding,
1942 * we have data_len >= padlen here. */
1943
TRodziewicz0f82ec62021-05-12 17:49:18 +02001944#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001945 /* The padding check involves a series of up to 256
Gilles Peskine449bd832023-01-11 14:50:10 +01001946 * consecutive memory reads at the end of the record
1947 * plaintext buffer. In order to hide the length and
1948 * validity of the padding, always perform exactly
1949 * `min(256,plaintext_len)` reads (but take into account
1950 * only the last `padlen` bytes for the padding check). */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001951 size_t pad_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 volatile unsigned char * const check = data;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001953
1954 /* Index of first padding byte; it has been ensured above
Gilles Peskine449bd832023-01-11 14:50:10 +01001955 * that the subtraction is safe. */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001956 size_t const padding_idx = rec->data_len - padlen;
1957 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1958 size_t const start_idx = rec->data_len - num_checks;
1959 size_t idx;
1960
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 for (idx = start_idx; idx < rec->data_len; idx++) {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001962 /* pad_count += (idx >= padding_idx) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001963 * (check[idx] == padlen - 1);
1964 */
1965 const size_t mask = mbedtls_ct_size_mask_ge(idx, padding_idx);
1966 const size_t equal = mbedtls_ct_size_bool_eq(check[idx],
1967 padlen - 1);
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001968 pad_count += mask & equal;
1969 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 correct &= mbedtls_ct_size_bool_eq(pad_count, padlen);
Paul Bakkere47b34b2013-02-27 14:48:00 +01001971
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001972#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 if (padlen > 0 && correct == 0) {
1974 MBEDTLS_SSL_DEBUG_MSG(1, ("bad padding byte detected"));
1975 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001976#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 padlen &= mbedtls_ct_size_mask(correct);
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001978
TRodziewicz0f82ec62021-05-12 17:49:18 +02001979#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001980
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001981 /* If the padding was found to be invalid, padlen == 0
1982 * and the subtraction is safe. If the padding was found valid,
1983 * padlen hasn't been changed and the previous assertion
1984 * data_len >= padlen still holds. */
1985 rec->data_len -= padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001987#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001988 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001989 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1990 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001991 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001992
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001993#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001994 MBEDTLS_SSL_DEBUG_BUF(4, "raw buffer after decryption",
1995 data, rec->data_len);
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02001996#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001997
1998 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001999 * Authenticate if not done yet.
2000 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00002001 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00002002#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 if (auth_done == 0) {
Paul Elliott5260ce22022-05-09 18:15:54 +01002004 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
2005 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01002006
Hanno Becker2e24c3b2017-12-27 21:28:58 +00002007 /* If the initial value of padlen was such that
2008 * data_len < maclen + padlen + 1, then padlen
2009 * got reset to 1, and the initial check
2010 * data_len >= minlen + maclen + 1
2011 * guarantees that at this point we still
2012 * have at least data_len >= maclen.
2013 *
2014 * If the initial value of padlen was such that
2015 * data_len >= maclen + padlen + 1, then we have
2016 * subtracted either padlen + 1 (if the padding was correct)
2017 * or 0 (if the padding was incorrect) since then,
2018 * hence data_len >= maclen in any case.
2019 */
2020 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01002021 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
2022 transform->tls_version,
2023 transform->taglen);
Paul Bakker5121ce52009-01-03 21:22:43 +00002024
TRodziewicz0f82ec62021-05-12 17:49:18 +02002025#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002026 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01002027 * The next two sizes are the minimum and maximum values of
2028 * data_len over all padlen values.
2029 *
2030 * They're independent of padlen, since we previously did
2031 * data_len -= padlen.
2032 *
2033 * Note that max_len + maclen is never more than the buffer
2034 * length, as we previously did in_msglen -= maclen too.
2035 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002036 const size_t max_len = rec->data_len + padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 const size_t min_len = (max_len > 256) ? max_len - 256 : 0;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002038
Neil Armstronge8589962022-02-25 15:14:29 +01002039#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002040 ret = mbedtls_ct_hmac(transform->psa_mac_dec,
2041 transform->psa_mac_alg,
2042 add_data, add_data_len,
2043 data, rec->data_len, min_len, max_len,
2044 mac_expect);
Neil Armstronge8589962022-02-25 15:14:29 +01002045#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002046 ret = mbedtls_ct_hmac(&transform->md_ctx_dec,
2047 add_data, add_data_len,
2048 data, rec->data_len, min_len, max_len,
2049 mac_expect);
Neil Armstronge8589962022-02-25 15:14:29 +01002050#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 if (ret != 0) {
2052 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ct_hmac", ret);
Gilles Peskined5ba50e2021-12-10 21:33:21 +01002053 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002054 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002055
Gilles Peskine449bd832023-01-11 14:50:10 +01002056 mbedtls_ct_memcpy_offset(mac_peer, data,
2057 rec->data_len,
2058 min_len, max_len,
2059 transform->maclen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02002060#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002061
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02002062#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect, transform->maclen);
2064 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", mac_peer, transform->maclen);
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02002065#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002066
Gilles Peskine449bd832023-01-11 14:50:10 +01002067 if (mbedtls_ct_memcmp(mac_peer, mac_expect,
2068 transform->maclen) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002069#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Paul Bakkere47b34b2013-02-27 14:48:00 +01002071#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002072 correct = 0;
2073 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002074 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01002075
Gilles Peskine449bd832023-01-11 14:50:10 +01002076hmac_failed_etm_disabled:
2077 mbedtls_platform_zeroize(mac_peer, transform->maclen);
2078 mbedtls_platform_zeroize(mac_expect, transform->maclen);
2079 if (ret != 0) {
2080 return ret;
2081 }
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002082 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01002083
2084 /*
2085 * Finally check the correct flag
2086 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002087 if (correct == 0) {
2088 return MBEDTLS_ERR_SSL_INVALID_MAC;
2089 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00002090#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002091
2092 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01002093 if (auth_done != 1) {
2094 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2095 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002096 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002097
Ronald Cron6f135e12021-12-08 16:57:54 +01002098#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Beckerccc13d02020-05-04 12:30:04 +01002100 /* Remove inner padding and infer true content type. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
2102 &rec->type);
Hanno Beckerccc13d02020-05-04 12:30:04 +01002103
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 if (ret != 0) {
2105 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2106 }
Hanno Beckerccc13d02020-05-04 12:30:04 +01002107 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002108#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01002109
Hanno Beckera0e20d02019-05-15 14:03:01 +01002110#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01002111 if (rec->cid_len != 0) {
2112 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
2113 &rec->type);
2114 if (ret != 0) {
2115 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2116 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01002117 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01002118#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01002119
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 MBEDTLS_SSL_DEBUG_MSG(2, ("<= decrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002121
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002123}
2124
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01002125#undef MAC_NONE
2126#undef MAC_PLAINTEXT
2127#undef MAC_CIPHERTEXT
2128
Paul Bakker5121ce52009-01-03 21:22:43 +00002129/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002130 * Fill the input message buffer by appending data to it.
2131 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002132 *
2133 * If we return 0, is it guaranteed that (at least) nb_want bytes are
2134 * available (from this read and/or a previous one). Otherwise, an error code
2135 * is returned (possibly EOF or WANT_READ).
2136 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002137 * With stream transport (TLS) on success ssl->in_left == nb_want, but
2138 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
2139 * since we always read a whole datagram at once.
2140 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02002141 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002142 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00002143 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002144int mbedtls_ssl_fetch_input(mbedtls_ssl_context *ssl, size_t nb_want)
Paul Bakker5121ce52009-01-03 21:22:43 +00002145{
Janos Follath865b3eb2019-12-16 11:46:15 +00002146 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00002147 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00002148#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2149 size_t in_buf_len = ssl->in_buf_len;
2150#else
2151 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
2152#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002153
Gilles Peskine449bd832023-01-11 14:50:10 +01002154 MBEDTLS_SSL_DEBUG_MSG(2, ("=> fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002155
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 if (ssl->f_recv == NULL && ssl->f_recv_timeout == NULL) {
2157 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2158 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002159 }
2160
Gilles Peskine449bd832023-01-11 14:50:10 +01002161 if (nb_want > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
2162 MBEDTLS_SSL_DEBUG_MSG(1, ("requesting more data than fits"));
2163 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Paul Bakker1a1fbba2014-04-30 14:38:05 +02002164 }
2165
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002166#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002168 uint32_t timeout;
2169
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002170 /*
2171 * The point is, we need to always read a full datagram at once, so we
2172 * sometimes read more then requested, and handle the additional data.
2173 * It could be the rest of the current record (while fetching the
2174 * header) and/or some other records in the same datagram.
2175 */
2176
2177 /*
2178 * Move to the next record in the already read datagram if applicable
2179 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002180 if (ssl->next_record_offset != 0) {
2181 if (ssl->in_left < ssl->next_record_offset) {
2182 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2183 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002184 }
2185
2186 ssl->in_left -= ssl->next_record_offset;
2187
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 if (ssl->in_left != 0) {
2189 MBEDTLS_SSL_DEBUG_MSG(2, ("next record in same datagram, offset: %"
2190 MBEDTLS_PRINTF_SIZET,
2191 ssl->next_record_offset));
2192 memmove(ssl->in_hdr,
2193 ssl->in_hdr + ssl->next_record_offset,
2194 ssl->in_left);
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002195 }
2196
2197 ssl->next_record_offset = 0;
2198 }
2199
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2201 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2202 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002203
2204 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002205 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002206 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 if (nb_want <= ssl->in_left) {
2208 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
2209 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002210 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002211
2212 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01002213 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002214 * are not at the beginning of a new record, the caller did something
2215 * wrong.
2216 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 if (ssl->in_left != 0) {
2218 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2219 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002220 }
2221
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002222 /*
2223 * Don't even try to read if time's out already.
2224 * This avoids by-passing the timer when repeatedly receiving messages
2225 * that will end up being dropped.
2226 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002227 if (mbedtls_ssl_check_timer(ssl) != 0) {
2228 MBEDTLS_SSL_DEBUG_MSG(2, ("timer has expired"));
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002229 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002230 } else {
2231 len = in_buf_len - (ssl->in_hdr - ssl->in_buf);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002232
Gilles Peskine449bd832023-01-11 14:50:10 +01002233 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002234 timeout = ssl->handshake->retransmit_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 } else {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002236 timeout = ssl->conf->read_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01002237 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002238
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 MBEDTLS_SSL_DEBUG_MSG(3, ("f_recv_timeout: %lu ms", (unsigned long) timeout));
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002240
Gilles Peskine449bd832023-01-11 14:50:10 +01002241 if (ssl->f_recv_timeout != NULL) {
2242 ret = ssl->f_recv_timeout(ssl->p_bio, ssl->in_hdr, len,
2243 timeout);
2244 } else {
2245 ret = ssl->f_recv(ssl->p_bio, ssl->in_hdr, len);
2246 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002247
Gilles Peskine449bd832023-01-11 14:50:10 +01002248 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002249
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 if (ret == 0) {
2251 return MBEDTLS_ERR_SSL_CONN_EOF;
2252 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002253 }
2254
Gilles Peskine449bd832023-01-11 14:50:10 +01002255 if (ret == MBEDTLS_ERR_SSL_TIMEOUT) {
2256 MBEDTLS_SSL_DEBUG_MSG(2, ("timeout"));
2257 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002258
Gilles Peskine449bd832023-01-11 14:50:10 +01002259 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
2260 if (ssl_double_retransmit_timeout(ssl) != 0) {
2261 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake timeout"));
2262 return MBEDTLS_ERR_SSL_TIMEOUT;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002263 }
2264
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
2266 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
2267 return ret;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002268 }
2269
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002271 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002272#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 else if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
2274 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
2275 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
2276 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
2277 ret);
2278 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002279 }
2280
Gilles Peskine449bd832023-01-11 14:50:10 +01002281 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002282 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002283#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002284 }
2285
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 if (ret < 0) {
2287 return ret;
2288 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002289
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002290 ssl->in_left = ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 } else
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002292#endif
2293 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002294 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2295 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2296 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002297
Gilles Peskine449bd832023-01-11 14:50:10 +01002298 while (ssl->in_left < nb_want) {
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002299 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002300
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 if (mbedtls_ssl_check_timer(ssl) != 0) {
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002302 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 } else {
2304 if (ssl->f_recv_timeout != NULL) {
2305 ret = ssl->f_recv_timeout(ssl->p_bio,
2306 ssl->in_hdr + ssl->in_left, len,
2307 ssl->conf->read_timeout);
2308 } else {
2309 ret = ssl->f_recv(ssl->p_bio,
2310 ssl->in_hdr + ssl->in_left, len);
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002311 }
2312 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002313
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2315 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2316 ssl->in_left, nb_want));
2317 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002318
Gilles Peskine449bd832023-01-11 14:50:10 +01002319 if (ret == 0) {
2320 return MBEDTLS_ERR_SSL_CONN_EOF;
2321 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002322
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 if (ret < 0) {
2324 return ret;
2325 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002326
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002327 if ((size_t) ret > len) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 MBEDTLS_SSL_DEBUG_MSG(1,
2329 ("f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2330 " were requested",
2331 ret, len));
2332 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16035bd15cb2018-02-28 04:30:59 -08002333 }
2334
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002335 ssl->in_left += ret;
2336 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002337 }
2338
Gilles Peskine449bd832023-01-11 14:50:10 +01002339 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002340
Gilles Peskine449bd832023-01-11 14:50:10 +01002341 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002342}
2343
2344/*
2345 * Flush any data not yet written
2346 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002347int mbedtls_ssl_flush_output(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002348{
Janos Follath865b3eb2019-12-16 11:46:15 +00002349 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002350 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002351
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 MBEDTLS_SSL_DEBUG_MSG(2, ("=> flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002353
Gilles Peskine449bd832023-01-11 14:50:10 +01002354 if (ssl->f_send == NULL) {
2355 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2356 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002357 }
2358
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002359 /* Avoid incrementing counter if data is flushed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 if (ssl->out_left == 0) {
2361 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
2362 return 0;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002363 }
2364
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 while (ssl->out_left > 0) {
2366 MBEDTLS_SSL_DEBUG_MSG(2, ("message length: %" MBEDTLS_PRINTF_SIZET
2367 ", out_left: %" MBEDTLS_PRINTF_SIZET,
2368 mbedtls_ssl_out_hdr_len(ssl) + ssl->out_msglen, ssl->out_left));
Paul Bakker5121ce52009-01-03 21:22:43 +00002369
Hanno Becker2b1e3542018-08-06 11:19:13 +01002370 buf = ssl->out_hdr - ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +01002371 ret = ssl->f_send(ssl->p_bio, buf, ssl->out_left);
Paul Bakker186751d2012-05-08 13:16:14 +00002372
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", ret);
Paul Bakker5121ce52009-01-03 21:22:43 +00002374
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 if (ret <= 0) {
2376 return ret;
2377 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002378
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002379 if ((size_t) ret > ssl->out_left) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 MBEDTLS_SSL_DEBUG_MSG(1,
2381 ("f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2382 " bytes were sent",
2383 ret, ssl->out_left));
2384 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16034bbaeb42018-02-22 04:29:04 -08002385 }
2386
Paul Bakker5121ce52009-01-03 21:22:43 +00002387 ssl->out_left -= ret;
2388 }
2389
Hanno Becker2b1e3542018-08-06 11:19:13 +01002390#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002392 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002393 } else
Hanno Becker2b1e3542018-08-06 11:19:13 +01002394#endif
2395 {
2396 ssl->out_hdr = ssl->out_buf + 8;
2397 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002398 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002399
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002401
Gilles Peskine449bd832023-01-11 14:50:10 +01002402 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002403}
2404
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002405/*
2406 * Functions to handle the DTLS retransmission state machine
2407 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002408#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002409/*
2410 * Append current handshake message to current outgoing flight
2411 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002412MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002413static int ssl_flight_append(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002414{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002415 mbedtls_ssl_flight_item *msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002416 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_flight_append"));
2417 MBEDTLS_SSL_DEBUG_BUF(4, "message appended to flight",
2418 ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002419
2420 /* Allocate space for current message */
Gilles Peskine449bd832023-01-11 14:50:10 +01002421 if ((msg = mbedtls_calloc(1, sizeof(mbedtls_ssl_flight_item))) == NULL) {
2422 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2423 sizeof(mbedtls_ssl_flight_item)));
2424 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002425 }
2426
Gilles Peskine449bd832023-01-11 14:50:10 +01002427 if ((msg->p = mbedtls_calloc(1, ssl->out_msglen)) == NULL) {
2428 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2429 ssl->out_msglen));
2430 mbedtls_free(msg);
2431 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002432 }
2433
2434 /* Copy current handshake message with headers */
Gilles Peskine449bd832023-01-11 14:50:10 +01002435 memcpy(msg->p, ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002436 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002437 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002438 msg->next = NULL;
2439
2440 /* Append to the current flight */
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 if (ssl->handshake->flight == NULL) {
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002442 ssl->handshake->flight = msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002444 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Gilles Peskine449bd832023-01-11 14:50:10 +01002445 while (cur->next != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002446 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002448 cur->next = msg;
2449 }
2450
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_flight_append"));
2452 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002453}
2454
2455/*
2456 * Free the current flight of handshake messages
2457 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002458void mbedtls_ssl_flight_free(mbedtls_ssl_flight_item *flight)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002459{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002460 mbedtls_ssl_flight_item *cur = flight;
2461 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002462
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 while (cur != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002464 next = cur->next;
2465
Gilles Peskine449bd832023-01-11 14:50:10 +01002466 mbedtls_free(cur->p);
2467 mbedtls_free(cur);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002468
2469 cur = next;
2470 }
2471}
2472
2473/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002474 * Swap transform_out and out_ctr with the alternative ones
2475 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002476MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002477static int ssl_swap_epochs(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002478{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002479 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002480 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002481
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 if (ssl->transform_out == ssl->handshake->alt_transform_out) {
2483 MBEDTLS_SSL_DEBUG_MSG(3, ("skip swap epochs"));
2484 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002485 }
2486
Gilles Peskine449bd832023-01-11 14:50:10 +01002487 MBEDTLS_SSL_DEBUG_MSG(3, ("swap epochs"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002488
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002489 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002490 tmp_transform = ssl->transform_out;
2491 ssl->transform_out = ssl->handshake->alt_transform_out;
2492 ssl->handshake->alt_transform_out = tmp_transform;
2493
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002494 /* Swap epoch + sequence_number */
Gilles Peskine449bd832023-01-11 14:50:10 +01002495 memcpy(tmp_out_ctr, ssl->cur_out_ctr, sizeof(tmp_out_ctr));
2496 memcpy(ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2497 sizeof(ssl->cur_out_ctr));
2498 memcpy(ssl->handshake->alt_out_ctr, tmp_out_ctr,
2499 sizeof(ssl->handshake->alt_out_ctr));
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002500
2501 /* Adjust to the newly activated transform */
Gilles Peskine449bd832023-01-11 14:50:10 +01002502 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002503
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002505}
2506
2507/*
2508 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002509 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002510int mbedtls_ssl_resend(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002511{
2512 int ret = 0;
2513
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002515
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 ret = mbedtls_ssl_flight_transmit(ssl);
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002517
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002519
Gilles Peskine449bd832023-01-11 14:50:10 +01002520 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002521}
2522
2523/*
2524 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002525 *
2526 * Need to remember the current message in case flush_output returns
2527 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002528 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002529 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002530int mbedtls_ssl_flight_transmit(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002531{
Janos Follath865b3eb2019-12-16 11:46:15 +00002532 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002533 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_flight_transmit"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002534
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 if (ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING) {
2536 MBEDTLS_SSL_DEBUG_MSG(2, ("initialise flight transmission"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002537
2538 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002539 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002540 ret = ssl_swap_epochs(ssl);
2541 if (ret != 0) {
2542 return ret;
2543 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002544
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002545 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002546 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002547
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 while (ssl->handshake->cur_msg != NULL) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002549 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002550 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002551
Hanno Beckere1dcb032018-08-17 16:47:58 +01002552 int const is_finished =
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 (cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2554 cur->p[0] == MBEDTLS_SSL_HS_FINISHED);
Hanno Beckere1dcb032018-08-17 16:47:58 +01002555
Ronald Cron00d012f22022-03-08 15:57:12 +01002556 int const force_flush = ssl->disable_datagram_packing == 1 ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
Hanno Becker04da1892018-08-14 13:22:10 +01002558
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002559 /* Swap epochs before sending Finished: we can't do it after
2560 * sending ChangeCipherSpec, in case write returns WANT_READ.
2561 * Must be done before copying, may change out_msg pointer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002562 if (is_finished && ssl->handshake->cur_msg_p == (cur->p + 12)) {
2563 MBEDTLS_SSL_DEBUG_MSG(2, ("swap epochs to send finished message"));
2564 ret = ssl_swap_epochs(ssl);
2565 if (ret != 0) {
2566 return ret;
2567 }
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002568 }
2569
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 ret = ssl_get_remaining_payload_in_datagram(ssl);
2571 if (ret < 0) {
2572 return ret;
2573 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002574 max_frag_len = (size_t) ret;
2575
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002576 /* CCS is copied as is, while HS messages may need fragmentation */
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 if (cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2578 if (max_frag_len == 0) {
2579 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2580 return ret;
2581 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002582
2583 continue;
2584 }
2585
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 memcpy(ssl->out_msg, cur->p, cur->len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002587 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002588 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002589
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002590 /* Update position inside current message */
2591 ssl->handshake->cur_msg_p += cur->len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002592 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002593 const unsigned char * const p = ssl->handshake->cur_msg_p;
2594 const size_t hs_len = cur->len - 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002595 const size_t frag_off = p - (cur->p + 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002596 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002597 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002598
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 if ((max_frag_len < 12) || (max_frag_len == 12 && hs_len != 0)) {
2600 if (is_finished) {
2601 ret = ssl_swap_epochs(ssl);
2602 if (ret != 0) {
2603 return ret;
2604 }
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002605 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002606
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2608 return ret;
2609 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002610
2611 continue;
2612 }
2613 max_hs_frag_len = max_frag_len - 12;
2614
2615 cur_hs_frag_len = rem_len > max_hs_frag_len ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002616 max_hs_frag_len : rem_len;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002617
Gilles Peskine449bd832023-01-11 14:50:10 +01002618 if (frag_off == 0 && cur_hs_frag_len != hs_len) {
2619 MBEDTLS_SSL_DEBUG_MSG(2, ("fragmenting handshake message (%u > %u)",
2620 (unsigned) cur_hs_frag_len,
2621 (unsigned) max_hs_frag_len));
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002622 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002623
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002624 /* Messages are stored with handshake headers as if not fragmented,
2625 * copy beginning of headers then fill fragmentation fields.
2626 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002627 memcpy(ssl->out_msg, cur->p, 6);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002628
Gilles Peskine449bd832023-01-11 14:50:10 +01002629 ssl->out_msg[6] = MBEDTLS_BYTE_2(frag_off);
2630 ssl->out_msg[7] = MBEDTLS_BYTE_1(frag_off);
2631 ssl->out_msg[8] = MBEDTLS_BYTE_0(frag_off);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002632
Gilles Peskine449bd832023-01-11 14:50:10 +01002633 ssl->out_msg[9] = MBEDTLS_BYTE_2(cur_hs_frag_len);
2634 ssl->out_msg[10] = MBEDTLS_BYTE_1(cur_hs_frag_len);
2635 ssl->out_msg[11] = MBEDTLS_BYTE_0(cur_hs_frag_len);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002636
Gilles Peskine449bd832023-01-11 14:50:10 +01002637 MBEDTLS_SSL_DEBUG_BUF(3, "handshake header", ssl->out_msg, 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002638
Hanno Becker3f7b9732018-08-28 09:53:25 +01002639 /* Copy the handshake message content and set records fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002640 memcpy(ssl->out_msg + 12, p, cur_hs_frag_len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002641 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002642 ssl->out_msgtype = cur->type;
2643
2644 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002645 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002646 }
2647
2648 /* If done with the current message move to the next one if any */
Gilles Peskine449bd832023-01-11 14:50:10 +01002649 if (ssl->handshake->cur_msg_p >= cur->p + cur->len) {
2650 if (cur->next != NULL) {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002651 ssl->handshake->cur_msg = cur->next;
2652 ssl->handshake->cur_msg_p = cur->next->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002653 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002654 ssl->handshake->cur_msg = NULL;
2655 ssl->handshake->cur_msg_p = NULL;
2656 }
2657 }
2658
2659 /* Actually send the message out */
Gilles Peskine449bd832023-01-11 14:50:10 +01002660 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2661 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
2662 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002663 }
2664 }
2665
Gilles Peskine449bd832023-01-11 14:50:10 +01002666 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2667 return ret;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002668 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002669
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 /* Update state and set timer */
2671 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
2672 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
2673 } else {
2674 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
2675 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
2676 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002677
Gilles Peskine449bd832023-01-11 14:50:10 +01002678 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_flight_transmit"));
2679
2680 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002681}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002682
2683/*
2684 * To be called when the last message of an incoming flight is received.
2685 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002686void mbedtls_ssl_recv_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002687{
2688 /* We won't need to resend that one any more */
Gilles Peskine449bd832023-01-11 14:50:10 +01002689 mbedtls_ssl_flight_free(ssl->handshake->flight);
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002690 ssl->handshake->flight = NULL;
2691 ssl->handshake->cur_msg = NULL;
2692
2693 /* The next incoming flight will start with this msg_seq */
2694 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2695
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002696 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002697 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002698
Hanno Becker0271f962018-08-16 13:23:47 +01002699 /* Clear future message buffering structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 mbedtls_ssl_buffering_free(ssl);
Hanno Becker0271f962018-08-16 13:23:47 +01002701
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002702 /* Cancel timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002703 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002704
Gilles Peskine449bd832023-01-11 14:50:10 +01002705 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2706 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002707 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002708 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002709 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002711}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002712
2713/*
2714 * To be called when the last message of an outgoing flight is send.
2715 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002716void mbedtls_ssl_send_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002717{
Gilles Peskine449bd832023-01-11 14:50:10 +01002718 ssl_reset_retransmit_timeout(ssl);
2719 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002720
Gilles Peskine449bd832023-01-11 14:50:10 +01002721 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2722 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002723 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002724 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002725 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002727}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002728#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002729
Paul Bakker5121ce52009-01-03 21:22:43 +00002730/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002731 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002732 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002733int mbedtls_ssl_start_handshake_msg(mbedtls_ssl_context *ssl, unsigned hs_type,
2734 unsigned char **buf, size_t *buf_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002735{
2736 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002737 * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002738 * ...
2739 * HandshakeType msg_type;
2740 * uint24 length;
2741 * ...
2742 */
2743 *buf = ssl->out_msg + 4;
2744 *buf_len = MBEDTLS_SSL_OUT_CONTENT_LEN - 4;
2745
2746 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2747 ssl->out_msg[0] = hs_type;
2748
Gilles Peskine449bd832023-01-11 14:50:10 +01002749 return 0;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002750}
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002751
2752/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002753 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002754 *
2755 * - fill in handshake headers
2756 * - update handshake checksum
2757 * - DTLS: save message for resending
2758 * - then pass to the record layer
2759 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002760 * DTLS: except for HelloRequest, messages are only queued, and will only be
2761 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002762 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002763 * Inputs:
2764 * - ssl->out_msglen: 4 + actual handshake message len
2765 * (4 is the size of handshake headers for TLS)
2766 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2767 * - ssl->out_msg + 4: the handshake message body
2768 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002769 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002770 * - ssl->out_msglen: the length of the record contents
2771 * (including handshake headers but excluding record headers)
2772 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002773 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002774int mbedtls_ssl_write_handshake_msg_ext(mbedtls_ssl_context *ssl,
2775 int update_checksum,
2776 int force_flush)
Paul Bakker5121ce52009-01-03 21:22:43 +00002777{
Janos Follath865b3eb2019-12-16 11:46:15 +00002778 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002779 const size_t hs_len = ssl->out_msglen - 4;
2780 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002781
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002783
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002784 /*
2785 * Sanity checks
2786 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002787 if (ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
2788 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2789 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2790 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002791 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002792
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002793 /* Whenever we send anything different from a
2794 * HelloRequest we should be in a handshake - double check. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002795 if (!(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2796 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST) &&
2797 ssl->handshake == NULL) {
2798 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2799 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002800 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002802#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002803 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002804 ssl->handshake != NULL &&
Gilles Peskine449bd832023-01-11 14:50:10 +01002805 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
2806 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2807 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002808 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002809#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002810
Hanno Beckerb50a2532018-08-06 11:52:54 +01002811 /* Double-check that we did not exceed the bounds
2812 * of the outgoing record buffer.
2813 * This should never fail as the various message
2814 * writing functions must obey the bounds of the
2815 * outgoing record buffer, but better be safe.
2816 *
2817 * Note: We deliberately do not check for the MTU or MFL here.
2818 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002819 if (ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2820 MBEDTLS_SSL_DEBUG_MSG(1, ("Record too large: "
2821 "size %" MBEDTLS_PRINTF_SIZET
2822 ", maximum %" MBEDTLS_PRINTF_SIZET,
2823 ssl->out_msglen,
2824 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
2825 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerb50a2532018-08-06 11:52:54 +01002826 }
2827
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002828 /*
2829 * Fill handshake headers
2830 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002831 if (ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
2832 ssl->out_msg[1] = MBEDTLS_BYTE_2(hs_len);
2833 ssl->out_msg[2] = MBEDTLS_BYTE_1(hs_len);
2834 ssl->out_msg[3] = MBEDTLS_BYTE_0(hs_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00002835
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002836 /*
2837 * DTLS has additional fields in the Handshake layer,
2838 * between the length field and the actual payload:
2839 * uint16 message_seq;
2840 * uint24 fragment_offset;
2841 * uint24 fragment_length;
2842 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002843#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002844 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002845 /* Make room for the additional DTLS fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002846 if (MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8) {
2847 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS handshake message too large: "
2848 "size %" MBEDTLS_PRINTF_SIZET ", maximum %"
2849 MBEDTLS_PRINTF_SIZET,
2850 hs_len,
2851 (size_t) (MBEDTLS_SSL_OUT_CONTENT_LEN - 12)));
2852 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9648f8b2017-09-18 10:55:54 +01002853 }
2854
Gilles Peskine449bd832023-01-11 14:50:10 +01002855 memmove(ssl->out_msg + 12, ssl->out_msg + 4, hs_len);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002856 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002857
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002858 /* Write message_seq and update it, except for HelloRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01002859 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST) {
2860 MBEDTLS_PUT_UINT16_BE(ssl->handshake->out_msg_seq, ssl->out_msg, 4);
2861 ++(ssl->handshake->out_msg_seq);
2862 } else {
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002863 ssl->out_msg[4] = 0;
2864 ssl->out_msg[5] = 0;
2865 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002866
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002867 /* Handshake hashes are computed without fragmentation,
2868 * so set frag_offset = 0 and frag_len = hs_len for now */
Gilles Peskine449bd832023-01-11 14:50:10 +01002869 memset(ssl->out_msg + 6, 0x00, 3);
2870 memcpy(ssl->out_msg + 9, ssl->out_msg + 1, 3);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002871 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002872#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002873
Hanno Becker0207e532018-08-28 10:28:28 +01002874 /* Update running hashes of handshake messages seen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002876 ret = ssl->handshake->update_checksum(ssl, ssl->out_msg,
2877 ssl->out_msglen);
2878 if (ret != 0) {
2879 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
2880 return ret;
2881 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002882 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002883 }
2884
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002885 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002886#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2888 !(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2889 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST)) {
2890 if ((ret = ssl_flight_append(ssl)) != 0) {
2891 MBEDTLS_SSL_DEBUG_RET(1, "ssl_flight_append", ret);
2892 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002893 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002894 } else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002895#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002896 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2898 MBEDTLS_SSL_DEBUG_RET(1, "ssl_write_record", ret);
2899 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002900 }
2901 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002902
Gilles Peskine449bd832023-01-11 14:50:10 +01002903 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002904
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 return 0;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002906}
2907
Gilles Peskine449bd832023-01-11 14:50:10 +01002908int mbedtls_ssl_finish_handshake_msg(mbedtls_ssl_context *ssl,
2909 size_t buf_len, size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002910{
2911 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2912 size_t msg_with_header_len;
2913 ((void) buf_len);
2914
2915 /* Add reserved 4 bytes for handshake header */
2916 msg_with_header_len = msg_len + 4;
2917 ssl->out_msglen = msg_with_header_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_write_handshake_msg_ext(ssl, 0, 0));
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002919
2920cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 return ret;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002922}
2923
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002924/*
2925 * Record layer functions
2926 */
2927
2928/*
2929 * Write current record.
2930 *
2931 * Uses:
2932 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2933 * - ssl->out_msglen: length of the record content (excl headers)
2934 * - ssl->out_msg: record content
2935 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002936int mbedtls_ssl_write_record(mbedtls_ssl_context *ssl, int force_flush)
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002937{
2938 int ret, done = 0;
2939 size_t len = ssl->out_msglen;
Ronald Cron00d012f22022-03-08 15:57:12 +01002940 int flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002941
Gilles Peskine449bd832023-01-11 14:50:10 +01002942 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write record"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002943
Gilles Peskine449bd832023-01-11 14:50:10 +01002944 if (!done) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002945 unsigned i;
2946 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002947#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2948 size_t out_buf_len = ssl->out_buf_len;
2949#else
2950 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2951#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002952 /* Skip writing the record content type to after the encryption,
2953 * as it may change when using the CID extension. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002954 mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
Ronald Cron6f135e12021-12-08 16:57:54 +01002955#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002956 /* TLS 1.3 still uses the TLS 1.2 version identifier
2957 * for backwards compatibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 if (tls_ver == MBEDTLS_SSL_VERSION_TLS1_3) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002959 tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002960 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002961#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002962 mbedtls_ssl_write_version(ssl->out_hdr + 1, ssl->conf->transport,
2963 tls_ver);
Hanno Becker6430faf2019-05-08 11:57:13 +01002964
Gilles Peskine449bd832023-01-11 14:50:10 +01002965 memcpy(ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
2966 MBEDTLS_PUT_UINT16_BE(len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002967
Gilles Peskine449bd832023-01-11 14:50:10 +01002968 if (ssl->transform_out != NULL) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002969 mbedtls_record rec;
2970
2971 rec.buf = ssl->out_iv;
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 rec.buf_len = out_buf_len - (ssl->out_iv - ssl->out_buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002973 rec.data_len = ssl->out_msglen;
2974 rec.data_offset = ssl->out_msg - rec.buf;
2975
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 memcpy(&rec.ctr[0], ssl->out_ctr, sizeof(rec.ctr));
2977 mbedtls_ssl_write_version(rec.ver, ssl->conf->transport, tls_ver);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002978 rec.type = ssl->out_msgtype;
2979
Hanno Beckera0e20d02019-05-15 14:03:01 +01002980#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002981 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002982 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002983#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002984
Gilles Peskine449bd832023-01-11 14:50:10 +01002985 if ((ret = mbedtls_ssl_encrypt_buf(ssl, ssl->transform_out, &rec,
2986 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
2987 MBEDTLS_SSL_DEBUG_RET(1, "ssl_encrypt_buf", ret);
2988 return ret;
Paul Bakker05ef8352012-05-08 09:17:57 +00002989 }
2990
Gilles Peskine449bd832023-01-11 14:50:10 +01002991 if (rec.data_offset != 0) {
2992 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2993 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002994 }
2995
Hanno Becker6430faf2019-05-08 11:57:13 +01002996 /* Update the record content type and CID. */
2997 ssl->out_msgtype = rec.type;
Gilles Peskine449bd832023-01-11 14:50:10 +01002998#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
2999 memcpy(ssl->out_cid, rec.cid, rec.cid_len);
Hanno Beckera0e20d02019-05-15 14:03:01 +01003000#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00003001 ssl->out_msglen = len = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003002 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00003003 }
3004
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 protected_record_size = len + mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003006
3007#if defined(MBEDTLS_SSL_PROTO_DTLS)
3008 /* In case of DTLS, double-check that we don't exceed
3009 * the remaining space in the datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003010 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3011 ret = ssl_get_remaining_space_in_datagram(ssl);
3012 if (ret < 0) {
3013 return ret;
3014 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01003015
Gilles Peskine449bd832023-01-11 14:50:10 +01003016 if (protected_record_size > (size_t) ret) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01003017 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01003018 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker2b1e3542018-08-06 11:19:13 +01003019 }
3020 }
3021#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00003022
Hanno Becker6430faf2019-05-08 11:57:13 +01003023 /* Now write the potentially updated record content type. */
3024 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
3025
Gilles Peskine449bd832023-01-11 14:50:10 +01003026 MBEDTLS_SSL_DEBUG_MSG(3, ("output record: msgtype = %u, "
3027 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
3028 ssl->out_hdr[0], ssl->out_hdr[1],
3029 ssl->out_hdr[2], len));
Paul Bakker05ef8352012-05-08 09:17:57 +00003030
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3032 ssl->out_hdr, protected_record_size);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003033
3034 ssl->out_left += protected_record_size;
3035 ssl->out_hdr += protected_record_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01003036 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003037
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 for (i = 8; i > mbedtls_ssl_ep_len(ssl); i--) {
3039 if (++ssl->cur_out_ctr[i - 1] != 0) {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02003040 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 }
3042 }
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02003043
Gabor Mezei96ae9262022-06-28 11:45:18 +02003044 /* The loop goes to its end if the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 if (i == mbedtls_ssl_ep_len(ssl)) {
3046 MBEDTLS_SSL_DEBUG_MSG(1, ("outgoing message counter would wrap"));
3047 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker04484622018-08-06 09:49:38 +01003048 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003049 }
3050
Hanno Becker67bc7c32018-08-06 11:33:50 +01003051#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003052 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3053 flush == SSL_DONT_FORCE_FLUSH) {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01003054 size_t remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 ret = ssl_get_remaining_payload_in_datagram(ssl);
3056 if (ret < 0) {
3057 MBEDTLS_SSL_DEBUG_RET(1, "ssl_get_remaining_payload_in_datagram",
3058 ret);
3059 return ret;
Hanno Becker1f5a15d2018-08-21 13:31:31 +01003060 }
3061
3062 remaining = (size_t) ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003063 if (remaining == 0) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01003064 flush = SSL_FORCE_FLUSH;
Gilles Peskine449bd832023-01-11 14:50:10 +01003065 } else {
3066 MBEDTLS_SSL_DEBUG_MSG(2,
3067 ("Still %u bytes available in current datagram",
3068 (unsigned) remaining));
Hanno Becker67bc7c32018-08-06 11:33:50 +01003069 }
3070 }
3071#endif /* MBEDTLS_SSL_PROTO_DTLS */
3072
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 if ((flush == SSL_FORCE_FLUSH) &&
3074 (ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3075 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
3076 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003077 }
3078
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write record"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003080
Gilles Peskine449bd832023-01-11 14:50:10 +01003081 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003082}
3083
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003084#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01003085
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003086MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003087static int ssl_hs_is_proper_fragment(mbedtls_ssl_context *ssl)
Hanno Beckere25e3b72018-08-16 09:30:53 +01003088{
Gilles Peskine449bd832023-01-11 14:50:10 +01003089 if (ssl->in_msglen < ssl->in_hslen ||
3090 memcmp(ssl->in_msg + 6, "\0\0\0", 3) != 0 ||
3091 memcmp(ssl->in_msg + 9, ssl->in_msg + 1, 3) != 0) {
3092 return 1;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003093 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003094 return 0;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003095}
Hanno Becker44650b72018-08-16 12:51:11 +01003096
Gilles Peskine449bd832023-01-11 14:50:10 +01003097static uint32_t ssl_get_hs_frag_len(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003098{
Gilles Peskine449bd832023-01-11 14:50:10 +01003099 return (ssl->in_msg[9] << 16) |
3100 (ssl->in_msg[10] << 8) |
3101 ssl->in_msg[11];
Hanno Becker44650b72018-08-16 12:51:11 +01003102}
3103
Gilles Peskine449bd832023-01-11 14:50:10 +01003104static uint32_t ssl_get_hs_frag_off(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003105{
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 return (ssl->in_msg[6] << 16) |
3107 (ssl->in_msg[7] << 8) |
3108 ssl->in_msg[8];
Hanno Becker44650b72018-08-16 12:51:11 +01003109}
3110
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003111MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003112static int ssl_check_hs_header(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003113{
3114 uint32_t msg_len, frag_off, frag_len;
3115
Gilles Peskine449bd832023-01-11 14:50:10 +01003116 msg_len = ssl_get_hs_total_len(ssl);
3117 frag_off = ssl_get_hs_frag_off(ssl);
3118 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker44650b72018-08-16 12:51:11 +01003119
Gilles Peskine449bd832023-01-11 14:50:10 +01003120 if (frag_off > msg_len) {
3121 return -1;
3122 }
Hanno Becker44650b72018-08-16 12:51:11 +01003123
Gilles Peskine449bd832023-01-11 14:50:10 +01003124 if (frag_len > msg_len - frag_off) {
3125 return -1;
3126 }
Hanno Becker44650b72018-08-16 12:51:11 +01003127
Gilles Peskine449bd832023-01-11 14:50:10 +01003128 if (frag_len + 12 > ssl->in_msglen) {
3129 return -1;
3130 }
Hanno Becker44650b72018-08-16 12:51:11 +01003131
Gilles Peskine449bd832023-01-11 14:50:10 +01003132 return 0;
Hanno Becker44650b72018-08-16 12:51:11 +01003133}
3134
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003135/*
3136 * Mark bits in bitmask (used for DTLS HS reassembly)
3137 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003138static void ssl_bitmask_set(unsigned char *mask, size_t offset, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003139{
3140 unsigned int start_bits, end_bits;
3141
Gilles Peskine449bd832023-01-11 14:50:10 +01003142 start_bits = 8 - (offset % 8);
3143 if (start_bits != 8) {
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003144 size_t first_byte_idx = offset / 8;
3145
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003146 /* Special case */
Gilles Peskine449bd832023-01-11 14:50:10 +01003147 if (len <= start_bits) {
3148 for (; len != 0; len--) {
3149 mask[first_byte_idx] |= 1 << (start_bits - len);
3150 }
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003151
3152 /* Avoid potential issues with offset or len becoming invalid */
3153 return;
3154 }
3155
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003156 offset += start_bits; /* Now offset % 8 == 0 */
3157 len -= start_bits;
3158
Gilles Peskine449bd832023-01-11 14:50:10 +01003159 for (; start_bits != 0; start_bits--) {
3160 mask[first_byte_idx] |= 1 << (start_bits - 1);
3161 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003162 }
3163
3164 end_bits = len % 8;
Gilles Peskine449bd832023-01-11 14:50:10 +01003165 if (end_bits != 0) {
3166 size_t last_byte_idx = (offset + len) / 8;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003167
3168 len -= end_bits; /* Now len % 8 == 0 */
3169
Gilles Peskine449bd832023-01-11 14:50:10 +01003170 for (; end_bits != 0; end_bits--) {
3171 mask[last_byte_idx] |= 1 << (8 - end_bits);
3172 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003173 }
3174
Gilles Peskine449bd832023-01-11 14:50:10 +01003175 memset(mask + offset / 8, 0xFF, len / 8);
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003176}
3177
3178/*
3179 * Check that bitmask is full
3180 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003181MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003182static int ssl_bitmask_check(unsigned char *mask, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003183{
3184 size_t i;
3185
Gilles Peskine449bd832023-01-11 14:50:10 +01003186 for (i = 0; i < len / 8; i++) {
3187 if (mask[i] != 0xFF) {
3188 return -1;
3189 }
3190 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003191
Gilles Peskine449bd832023-01-11 14:50:10 +01003192 for (i = 0; i < len % 8; i++) {
3193 if ((mask[len / 8] & (1 << (7 - i))) == 0) {
3194 return -1;
3195 }
3196 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003197
Gilles Peskine449bd832023-01-11 14:50:10 +01003198 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003199}
3200
Hanno Becker56e205e2018-08-16 09:06:12 +01003201/* msg_len does not include the handshake header */
Gilles Peskine449bd832023-01-11 14:50:10 +01003202static size_t ssl_get_reassembly_buffer_size(size_t msg_len,
3203 unsigned add_bitmap)
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003204{
Hanno Becker56e205e2018-08-16 09:06:12 +01003205 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003206
Hanno Becker56e205e2018-08-16 09:06:12 +01003207 alloc_len = 12; /* Handshake header */
3208 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003209
Gilles Peskine449bd832023-01-11 14:50:10 +01003210 if (add_bitmap) {
3211 alloc_len += msg_len / 8 + (msg_len % 8 != 0); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003212
Gilles Peskine449bd832023-01-11 14:50:10 +01003213 }
3214 return alloc_len;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003215}
Hanno Becker56e205e2018-08-16 09:06:12 +01003216
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003217#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003218
Gilles Peskine449bd832023-01-11 14:50:10 +01003219static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl)
Hanno Becker12555c62018-08-16 12:47:53 +01003220{
Gilles Peskine449bd832023-01-11 14:50:10 +01003221 return (ssl->in_msg[1] << 16) |
3222 (ssl->in_msg[2] << 8) |
3223 ssl->in_msg[3];
Hanno Becker12555c62018-08-16 12:47:53 +01003224}
Hanno Beckere25e3b72018-08-16 09:30:53 +01003225
Gilles Peskine449bd832023-01-11 14:50:10 +01003226int mbedtls_ssl_prepare_handshake_record(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003227{
Gilles Peskine449bd832023-01-11 14:50:10 +01003228 if (ssl->in_msglen < mbedtls_ssl_hs_hdr_len(ssl)) {
3229 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake message too short: %" MBEDTLS_PRINTF_SIZET,
3230 ssl->in_msglen));
3231 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003232 }
3233
Gilles Peskine449bd832023-01-11 14:50:10 +01003234 ssl->in_hslen = mbedtls_ssl_hs_hdr_len(ssl) + ssl_get_hs_total_len(ssl);
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003235
Gilles Peskine449bd832023-01-11 14:50:10 +01003236 MBEDTLS_SSL_DEBUG_MSG(3, ("handshake message: msglen ="
3237 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %"
3238 MBEDTLS_PRINTF_SIZET,
3239 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen));
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003241#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003242 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00003243 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01003244 unsigned int recv_msg_seq = (ssl->in_msg[4] << 8) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003245
Gilles Peskine449bd832023-01-11 14:50:10 +01003246 if (ssl_check_hs_header(ssl) != 0) {
3247 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid handshake header"));
3248 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker44650b72018-08-16 12:51:11 +01003249 }
3250
Gilles Peskine449bd832023-01-11 14:50:10 +01003251 if (ssl->handshake != NULL &&
3252 ((mbedtls_ssl_is_handshake_over(ssl) == 0 &&
3253 recv_msg_seq != ssl->handshake->in_msg_seq) ||
3254 (mbedtls_ssl_is_handshake_over(ssl) == 1 &&
3255 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO))) {
3256 if (recv_msg_seq > ssl->handshake->in_msg_seq) {
3257 MBEDTLS_SSL_DEBUG_MSG(2,
3258 (
3259 "received future handshake message of sequence number %u (next %u)",
3260 recv_msg_seq,
3261 ssl->handshake->in_msg_seq));
3262 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Becker9e1ec222018-08-15 15:54:43 +01003263 }
3264
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003265 /* Retransmit only on last message from previous flight, to avoid
3266 * too many retransmissions.
3267 * Besides, No sane server ever retransmits HelloVerifyRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01003268 if (recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
3269 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST) {
3270 MBEDTLS_SSL_DEBUG_MSG(2, ("received message from last flight, "
3271 "message_seq = %u, start_of_flight = %u",
3272 recv_msg_seq,
3273 ssl->handshake->in_flight_start_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003274
Gilles Peskine449bd832023-01-11 14:50:10 +01003275 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
3276 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
3277 return ret;
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003278 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003279 } else {
3280 MBEDTLS_SSL_DEBUG_MSG(2, ("dropping out-of-sequence message: "
3281 "message_seq = %u, expected = %u",
3282 recv_msg_seq,
3283 ssl->handshake->in_msg_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003284 }
3285
Gilles Peskine449bd832023-01-11 14:50:10 +01003286 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003287 }
3288 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003289
Hanno Becker6d97ef52018-08-16 13:09:04 +01003290 /* Message reassembly is handled alongside buffering of future
3291 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003292 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003293 * handshake logic layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003294 if (ssl_hs_is_proper_fragment(ssl) == 1) {
3295 MBEDTLS_SSL_DEBUG_MSG(2, ("found fragmented DTLS handshake message"));
3296 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003297 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003298 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003299#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003300 /* With TLS we don't handle fragmentation (for now) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003301 if (ssl->in_msglen < ssl->in_hslen) {
3302 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS handshake fragmentation not supported"));
3303 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003304 }
3305
Gilles Peskine449bd832023-01-11 14:50:10 +01003306 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01003307}
3308
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003309int mbedtls_ssl_update_handshake_status(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01003310{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003311 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker0271f962018-08-16 13:23:47 +01003312 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003313
Gilles Peskine449bd832023-01-11 14:50:10 +01003314 if (mbedtls_ssl_is_handshake_over(ssl) == 0 && hs != NULL) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003315 ret = ssl->handshake->update_checksum(ssl, ssl->in_msg, ssl->in_hslen);
3316 if (ret != 0) {
3317 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
3318 return ret;
3319 }
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003320 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003321
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003322 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003323#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003324 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3325 ssl->handshake != NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01003326 unsigned offset;
3327 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003328
Hanno Becker0271f962018-08-16 13:23:47 +01003329 /* Increment handshake sequence number */
3330 hs->in_msg_seq++;
3331
3332 /*
3333 * Clear up handshake buffering and reassembly structure.
3334 */
3335
3336 /* Free first entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003337 ssl_buffering_free_slot(ssl, 0);
Hanno Becker0271f962018-08-16 13:23:47 +01003338
3339 /* Shift all other entries */
Gilles Peskine449bd832023-01-11 14:50:10 +01003340 for (offset = 0, hs_buf = &hs->buffering.hs[0];
Hanno Beckere605b192018-08-21 15:59:07 +01003341 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Gilles Peskine449bd832023-01-11 14:50:10 +01003342 offset++, hs_buf++) {
Hanno Becker0271f962018-08-16 13:23:47 +01003343 *hs_buf = *(hs_buf + 1);
3344 }
3345
3346 /* Create a fresh last entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003347 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003348 }
3349#endif
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003350 return 0;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003351}
3352
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003353/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003354 * DTLS anti-replay: RFC 6347 4.1.2.6
3355 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003356 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3357 * Bit n is set iff record number in_window_top - n has been seen.
3358 *
3359 * Usually, in_window_top is the last record number seen and the lsb of
3360 * in_window is set. The only exception is the initial state (record number 0
3361 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003362 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003363#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003364void mbedtls_ssl_dtls_replay_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003365{
3366 ssl->in_window_top = 0;
3367 ssl->in_window = 0;
3368}
3369
Gilles Peskine449bd832023-01-11 14:50:10 +01003370static inline uint64_t ssl_load_six_bytes(unsigned char *buf)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003371{
Gilles Peskine449bd832023-01-11 14:50:10 +01003372 return ((uint64_t) buf[0] << 40) |
3373 ((uint64_t) buf[1] << 32) |
3374 ((uint64_t) buf[2] << 24) |
3375 ((uint64_t) buf[3] << 16) |
3376 ((uint64_t) buf[4] << 8) |
3377 ((uint64_t) buf[5]);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003378}
3379
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003380MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003381static int mbedtls_ssl_dtls_record_replay_check(mbedtls_ssl_context *ssl, uint8_t *record_in_ctr)
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003382{
Janos Follath865b3eb2019-12-16 11:46:15 +00003383 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003384 unsigned char *original_in_ctr;
3385
3386 // save original in_ctr
3387 original_in_ctr = ssl->in_ctr;
3388
3389 // use counter from record
3390 ssl->in_ctr = record_in_ctr;
3391
Gilles Peskine449bd832023-01-11 14:50:10 +01003392 ret = mbedtls_ssl_dtls_replay_check((mbedtls_ssl_context const *) ssl);
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003393
3394 // restore the counter
3395 ssl->in_ctr = original_in_ctr;
3396
3397 return ret;
3398}
3399
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003400/*
3401 * Return 0 if sequence number is acceptable, -1 otherwise
3402 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003403int mbedtls_ssl_dtls_replay_check(mbedtls_ssl_context const *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003404{
Gilles Peskine449bd832023-01-11 14:50:10 +01003405 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003406 uint64_t bit;
3407
Gilles Peskine449bd832023-01-11 14:50:10 +01003408 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
3409 return 0;
3410 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003411
Gilles Peskine449bd832023-01-11 14:50:10 +01003412 if (rec_seqnum > ssl->in_window_top) {
3413 return 0;
3414 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003415
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003416 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003417
Gilles Peskine449bd832023-01-11 14:50:10 +01003418 if (bit >= 64) {
3419 return -1;
3420 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003421
Gilles Peskine449bd832023-01-11 14:50:10 +01003422 if ((ssl->in_window & ((uint64_t) 1 << bit)) != 0) {
3423 return -1;
3424 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003425
Gilles Peskine449bd832023-01-11 14:50:10 +01003426 return 0;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003427}
3428
3429/*
3430 * Update replay window on new validated record
3431 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003432void mbedtls_ssl_dtls_replay_update(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003433{
Gilles Peskine449bd832023-01-11 14:50:10 +01003434 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003435
Gilles Peskine449bd832023-01-11 14:50:10 +01003436 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003437 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01003438 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003439
Gilles Peskine449bd832023-01-11 14:50:10 +01003440 if (rec_seqnum > ssl->in_window_top) {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003441 /* Update window_top and the contents of the window */
3442 uint64_t shift = rec_seqnum - ssl->in_window_top;
3443
Gilles Peskine449bd832023-01-11 14:50:10 +01003444 if (shift >= 64) {
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003445 ssl->in_window = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003446 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003447 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003448 ssl->in_window |= 1;
3449 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003450
3451 ssl->in_window_top = rec_seqnum;
Gilles Peskine449bd832023-01-11 14:50:10 +01003452 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003453 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003454 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003455
Gilles Peskine449bd832023-01-11 14:50:10 +01003456 if (bit < 64) { /* Always true, but be extra sure */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003457 ssl->in_window |= (uint64_t) 1 << bit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003458 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003459 }
3460}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003461#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003462
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003463#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003464/*
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003465 * Check if a datagram looks like a ClientHello with a valid cookie,
3466 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003467 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003468 *
3469 * - if cookie is valid, return 0
3470 * - if ClientHello looks superficially valid but cookie is not,
3471 * fill obuf and set olen, then
3472 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3473 * - otherwise return a specific error code
3474 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003475MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003476MBEDTLS_STATIC_TESTABLE
3477int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003478 mbedtls_ssl_context *ssl,
3479 const unsigned char *cli_id, size_t cli_id_len,
3480 const unsigned char *in, size_t in_len,
3481 unsigned char *obuf, size_t buf_len, size_t *olen)
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003482{
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003483 size_t sid_len, cookie_len, epoch, fragment_offset;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003484 unsigned char *p;
3485
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003486 /*
3487 * Structure of ClientHello with record and handshake headers,
3488 * and expected values. We don't need to check a lot, more checks will be
3489 * done when actually parsing the ClientHello - skipping those checks
3490 * avoids code duplication and does not make cookie forging any easier.
3491 *
3492 * 0-0 ContentType type; copied, must be handshake
3493 * 1-2 ProtocolVersion version; copied
3494 * 3-4 uint16 epoch; copied, must be 0
3495 * 5-10 uint48 sequence_number; copied
3496 * 11-12 uint16 length; (ignored)
3497 *
3498 * 13-13 HandshakeType msg_type; (ignored)
3499 * 14-16 uint24 length; (ignored)
3500 * 17-18 uint16 message_seq; copied
3501 * 19-21 uint24 fragment_offset; copied, must be 0
3502 * 22-24 uint24 fragment_length; (ignored)
3503 *
3504 * 25-26 ProtocolVersion client_version; (ignored)
3505 * 27-58 Random random; (ignored)
3506 * 59-xx SessionID session_id; 1 byte len + sid_len content
3507 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3508 * ...
3509 *
3510 * Minimum length is 61 bytes.
3511 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003512 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: in_len=%u",
3513 (unsigned) in_len));
3514 MBEDTLS_SSL_DEBUG_BUF(4, "cli_id", cli_id, cli_id_len);
3515 if (in_len < 61) {
3516 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: record too short"));
3517 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003518 }
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003519
Gilles Peskine449bd832023-01-11 14:50:10 +01003520 epoch = MBEDTLS_GET_UINT16_BE(in, 3);
3521 fragment_offset = MBEDTLS_GET_UINT24_BE(in, 19);
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003522
Gilles Peskine449bd832023-01-11 14:50:10 +01003523 if (in[0] != MBEDTLS_SSL_MSG_HANDSHAKE || epoch != 0 ||
3524 fragment_offset != 0) {
3525 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: not a good ClientHello"));
3526 MBEDTLS_SSL_DEBUG_MSG(4, (" type=%u epoch=%u fragment_offset=%u",
3527 in[0], (unsigned) epoch,
3528 (unsigned) fragment_offset));
3529 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003530 }
3531
3532 sid_len = in[59];
Gilles Peskine449bd832023-01-11 14:50:10 +01003533 if (59 + 1 + sid_len + 1 > in_len) {
3534 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: sid_len=%u > %u",
3535 (unsigned) sid_len,
3536 (unsigned) in_len - 61));
3537 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003538 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003539 MBEDTLS_SSL_DEBUG_BUF(4, "sid received from network",
3540 in + 60, sid_len);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003541
3542 cookie_len = in[60 + sid_len];
Gilles Peskine449bd832023-01-11 14:50:10 +01003543 if (59 + 1 + sid_len + 1 + cookie_len > in_len) {
3544 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: cookie_len=%u > %u",
3545 (unsigned) cookie_len,
3546 (unsigned) (in_len - sid_len - 61)));
3547 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003548 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003549
Gilles Peskine449bd832023-01-11 14:50:10 +01003550 MBEDTLS_SSL_DEBUG_BUF(4, "cookie received from network",
3551 in + sid_len + 61, cookie_len);
3552 if (ssl->conf->f_cookie_check(ssl->conf->p_cookie,
3553 in + sid_len + 61, cookie_len,
3554 cli_id, cli_id_len) == 0) {
3555 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: valid"));
3556 return 0;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003557 }
3558
3559 /*
3560 * If we get here, we've got an invalid cookie, let's prepare HVR.
3561 *
3562 * 0-0 ContentType type; copied
3563 * 1-2 ProtocolVersion version; copied
3564 * 3-4 uint16 epoch; copied
3565 * 5-10 uint48 sequence_number; copied
3566 * 11-12 uint16 length; olen - 13
3567 *
3568 * 13-13 HandshakeType msg_type; hello_verify_request
3569 * 14-16 uint24 length; olen - 25
3570 * 17-18 uint16 message_seq; copied
3571 * 19-21 uint24 fragment_offset; copied
3572 * 22-24 uint24 fragment_length; olen - 25
3573 *
3574 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3575 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3576 *
3577 * Minimum length is 28.
3578 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003579 if (buf_len < 28) {
3580 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3581 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003582
3583 /* Copy most fields and adapt others */
Gilles Peskine449bd832023-01-11 14:50:10 +01003584 memcpy(obuf, in, 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003585 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3586 obuf[25] = 0xfe;
3587 obuf[26] = 0xff;
3588
3589 /* Generate and write actual cookie */
3590 p = obuf + 28;
Gilles Peskine449bd832023-01-11 14:50:10 +01003591 if (ssl->conf->f_cookie_write(ssl->conf->p_cookie,
3592 &p, obuf + buf_len,
3593 cli_id, cli_id_len) != 0) {
3594 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003595 }
3596
3597 *olen = p - obuf;
3598
3599 /* Go back and fill length fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01003600 obuf[27] = (unsigned char) (*olen - 28);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003601
Gilles Peskine449bd832023-01-11 14:50:10 +01003602 obuf[14] = obuf[22] = MBEDTLS_BYTE_2(*olen - 25);
3603 obuf[15] = obuf[23] = MBEDTLS_BYTE_1(*olen - 25);
3604 obuf[16] = obuf[24] = MBEDTLS_BYTE_0(*olen - 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003605
Gilles Peskine449bd832023-01-11 14:50:10 +01003606 MBEDTLS_PUT_UINT16_BE(*olen - 13, obuf, 11);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003607
Gilles Peskine449bd832023-01-11 14:50:10 +01003608 return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003609}
3610
3611/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003612 * Handle possible client reconnect with the same UDP quadruplet
3613 * (RFC 6347 Section 4.2.8).
3614 *
3615 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3616 * that looks like a ClientHello.
3617 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003618 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003619 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003620 * - if the input looks like a ClientHello with a valid cookie,
3621 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003622 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003623 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003624 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003625 * This function is called (through ssl_check_client_reconnect()) when an
3626 * unexpected record is found in ssl_get_next_record(), which will discard the
3627 * record if we return 0, and bubble up the return value otherwise (this
3628 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3629 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003630 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003631MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003632static int ssl_handle_possible_reconnect(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003633{
Janos Follath865b3eb2019-12-16 11:46:15 +00003634 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003635 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003636
Gilles Peskine449bd832023-01-11 14:50:10 +01003637 if (ssl->conf->f_cookie_write == NULL ||
3638 ssl->conf->f_cookie_check == NULL) {
Hanno Becker2fddd372019-07-10 14:37:41 +01003639 /* If we can't use cookies to verify reachability of the peer,
3640 * drop the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003641 MBEDTLS_SSL_DEBUG_MSG(1, ("no cookie callbacks, "
3642 "can't check reconnect validity"));
3643 return 0;
Hanno Becker2fddd372019-07-10 14:37:41 +01003644 }
3645
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003646 ret = mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003647 ssl,
3648 ssl->cli_id, ssl->cli_id_len,
3649 ssl->in_buf, ssl->in_left,
3650 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len);
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003651
Gilles Peskine449bd832023-01-11 14:50:10 +01003652 MBEDTLS_SSL_DEBUG_RET(2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003653
Gilles Peskine449bd832023-01-11 14:50:10 +01003654 if (ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED) {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003655 int send_ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003656 MBEDTLS_SSL_DEBUG_MSG(1, ("sending HelloVerifyRequest"));
3657 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3658 ssl->out_buf, len);
Brian J Murray1903fb32016-11-06 04:45:15 -08003659 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003660 * If the error is permanent we'll catch it later,
3661 * if it's not, then hopefully it'll work next time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003662 send_ret = ssl->f_send(ssl->p_bio, ssl->out_buf, len);
3663 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", send_ret);
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003664 (void) send_ret;
3665
Gilles Peskine449bd832023-01-11 14:50:10 +01003666 return 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003667 }
3668
Gilles Peskine449bd832023-01-11 14:50:10 +01003669 if (ret == 0) {
3670 MBEDTLS_SSL_DEBUG_MSG(1, ("cookie is valid, resetting context"));
3671 if ((ret = mbedtls_ssl_session_reset_int(ssl, 1)) != 0) {
3672 MBEDTLS_SSL_DEBUG_RET(1, "reset", ret);
3673 return ret;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003674 }
3675
Gilles Peskine449bd832023-01-11 14:50:10 +01003676 return MBEDTLS_ERR_SSL_CLIENT_RECONNECT;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003677 }
3678
Gilles Peskine449bd832023-01-11 14:50:10 +01003679 return ret;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003680}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003681#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003682
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003683MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003684static int ssl_check_record_type(uint8_t record_type)
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003685{
Gilles Peskine449bd832023-01-11 14:50:10 +01003686 if (record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003687 record_type != MBEDTLS_SSL_MSG_ALERT &&
3688 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003689 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
3690 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003691 }
3692
Gilles Peskine449bd832023-01-11 14:50:10 +01003693 return 0;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003694}
3695
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003696/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003697 * ContentType type;
3698 * ProtocolVersion version;
3699 * uint16 epoch; // DTLS only
3700 * uint48 sequence_number; // DTLS only
3701 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003702 *
3703 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003704 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003705 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3706 *
3707 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003708 * 1. proceed with the record if this function returns 0
3709 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3710 * 3. return CLIENT_RECONNECT if this function return that value
3711 * 4. drop the whole datagram if this function returns anything else.
3712 * Point 2 is needed when the peer is resending, and we have already received
3713 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003714 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003715MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003716static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
3717 unsigned char *buf,
3718 size_t len,
3719 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00003720{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003721 mbedtls_ssl_protocol_version tls_version;
Paul Bakker5121ce52009-01-03 21:22:43 +00003722
Hanno Beckere5e7e782019-07-11 12:29:35 +01003723 size_t const rec_hdr_type_offset = 0;
3724 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003725
Hanno Beckere5e7e782019-07-11 12:29:35 +01003726 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3727 rec_hdr_type_len;
3728 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003729
Hanno Beckere5e7e782019-07-11 12:29:35 +01003730 size_t const rec_hdr_ctr_len = 8;
3731#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003732 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003733 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3734 rec_hdr_version_len;
3735
Hanno Beckera0e20d02019-05-15 14:03:01 +01003736#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003737 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3738 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003739 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003740#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3741#endif /* MBEDTLS_SSL_PROTO_DTLS */
3742
3743 size_t rec_hdr_len_offset; /* To be determined */
3744 size_t const rec_hdr_len_len = 2;
3745
3746 /*
3747 * Check minimum lengths for record header.
3748 */
3749
3750#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003751 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003752 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003753 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003754#endif /* MBEDTLS_SSL_PROTO_DTLS */
3755 {
3756 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3757 }
3758
Gilles Peskine449bd832023-01-11 14:50:10 +01003759 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3760 MBEDTLS_SSL_DEBUG_MSG(1,
3761 (
3762 "datagram of length %u too small to hold DTLS record header of length %u",
3763 (unsigned) len,
3764 (unsigned) (rec_hdr_len_len + rec_hdr_len_len)));
3765 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003766 }
3767
3768 /*
3769 * Parse and validate record content type
3770 */
3771
Gilles Peskine449bd832023-01-11 14:50:10 +01003772 rec->type = buf[rec_hdr_type_offset];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003773
3774 /* Check record content type */
3775#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3776 rec->cid_len = 0;
3777
Gilles Peskine449bd832023-01-11 14:50:10 +01003778 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003779 ssl->conf->cid_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003780 rec->type == MBEDTLS_SSL_MSG_CID) {
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003781 /* Shift pointers to account for record header including CID
3782 * struct {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02003783 * ContentType outer_type = tls12_cid;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003784 * ProtocolVersion version;
3785 * uint16 epoch;
3786 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003787 * opaque cid[cid_length]; // Additional field compared to
3788 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003789 * uint16 length;
3790 * opaque enc_content[DTLSCiphertext.length];
3791 * } DTLSCiphertext;
3792 */
3793
3794 /* So far, we only support static CID lengths
3795 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003796 rec_hdr_cid_len = ssl->conf->cid_len;
3797 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003798
Gilles Peskine449bd832023-01-11 14:50:10 +01003799 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3800 MBEDTLS_SSL_DEBUG_MSG(1,
3801 (
3802 "datagram of length %u too small to hold DTLS record header including CID, length %u",
3803 (unsigned) len,
3804 (unsigned) (rec_hdr_len_offset + rec_hdr_len_len)));
3805 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere538d822019-07-10 14:50:10 +01003806 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003807
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003808 /* configured CID len is guaranteed at most 255, see
3809 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3810 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003811 memcpy(rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len);
3812 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003813#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003814 {
Gilles Peskine449bd832023-01-11 14:50:10 +01003815 if (ssl_check_record_type(rec->type)) {
3816 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type %u",
3817 (unsigned) rec->type));
3818 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003819 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003820 }
3821
Hanno Beckere5e7e782019-07-11 12:29:35 +01003822 /*
3823 * Parse and validate record version
3824 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003825 rec->ver[0] = buf[rec_hdr_version_offset + 0];
3826 rec->ver[1] = buf[rec_hdr_version_offset + 1];
3827 tls_version = mbedtls_ssl_read_version(buf + rec_hdr_version_offset,
3828 ssl->conf->transport);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003829
Gilles Peskine449bd832023-01-11 14:50:10 +01003830 if (tls_version > ssl->conf->max_tls_version) {
3831 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS version mismatch: got %u, expected max %u",
3832 (unsigned) tls_version,
3833 (unsigned) ssl->conf->max_tls_version));
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003834
Gilles Peskine449bd832023-01-11 14:50:10 +01003835 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Paul Bakker5121ce52009-01-03 21:22:43 +00003836 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003837 /*
3838 * Parse/Copy record sequence number.
3839 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003840
Hanno Beckere5e7e782019-07-11 12:29:35 +01003841#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003842 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003843 /* Copy explicit record sequence number from input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003844 memcpy(&rec->ctr[0], buf + rec_hdr_ctr_offset,
3845 rec_hdr_ctr_len);
3846 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003847#endif /* MBEDTLS_SSL_PROTO_DTLS */
3848 {
3849 /* Copy implicit record sequence number from SSL context structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003850 memcpy(&rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003851 }
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003852
Hanno Beckere5e7e782019-07-11 12:29:35 +01003853 /*
3854 * Parse record length.
3855 */
3856
Hanno Beckere5e7e782019-07-11 12:29:35 +01003857 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003858 rec->data_len = ((size_t) buf[rec_hdr_len_offset + 0] << 8) |
3859 ((size_t) buf[rec_hdr_len_offset + 1] << 0);
3860 MBEDTLS_SSL_DEBUG_BUF(4, "input record header", buf, rec->data_offset);
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003861
Gilles Peskine449bd832023-01-11 14:50:10 +01003862 MBEDTLS_SSL_DEBUG_MSG(3, ("input record: msgtype = %u, "
3863 "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3864 rec->type, (unsigned) tls_version, rec->data_len));
Hanno Beckere5e7e782019-07-11 12:29:35 +01003865
3866 rec->buf = buf;
3867 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003868
Gilles Peskine449bd832023-01-11 14:50:10 +01003869 if (rec->data_len == 0) {
3870 return MBEDTLS_ERR_SSL_INVALID_RECORD;
3871 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003872
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003873 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003874 * DTLS-related tests.
3875 * Check epoch before checking length constraint because
3876 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3877 * message gets duplicated before the corresponding Finished message,
3878 * the second ChangeCipherSpec should be discarded because it belongs
3879 * to an old epoch, but not because its length is shorter than
3880 * the minimum record length for packets using the new record transform.
3881 * Note that these two kinds of failures are handled differently,
3882 * as an unexpected record is silently skipped but an invalid
3883 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003884 */
3885#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003886 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3887 rec_epoch = (rec->ctr[0] << 8) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003888
Hanno Becker955a5c92019-07-10 17:12:07 +01003889 /* Check that the datagram is large enough to contain a record
3890 * of the advertised length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003891 if (len < rec->data_offset + rec->data_len) {
3892 MBEDTLS_SSL_DEBUG_MSG(1,
3893 (
3894 "Datagram of length %u too small to contain record of advertised length %u.",
3895 (unsigned) len,
3896 (unsigned) (rec->data_offset + rec->data_len)));
3897 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker955a5c92019-07-10 17:12:07 +01003898 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003899
Hanno Becker37cfe732019-07-10 17:20:01 +01003900 /* Records from other, non-matching epochs are silently discarded.
3901 * (The case of same-port Client reconnects must be considered in
3902 * the caller). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003903 if (rec_epoch != ssl->in_epoch) {
3904 MBEDTLS_SSL_DEBUG_MSG(1, ("record from another epoch: "
3905 "expected %u, received %lu",
3906 ssl->in_epoch, (unsigned long) rec_epoch));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003907
Hanno Becker552f7472019-07-19 10:59:12 +01003908 /* Records from the next epoch are considered for buffering
3909 * (concretely: early Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003910 if (rec_epoch == (unsigned) ssl->in_epoch + 1) {
3911 MBEDTLS_SSL_DEBUG_MSG(2, ("Consider record for buffering"));
3912 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003913 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003914
Gilles Peskine449bd832023-01-11 14:50:10 +01003915 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003916 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003917#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003918 /* For records from the correct epoch, check whether their
3919 * sequence number has been seen before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003920 else if (mbedtls_ssl_dtls_record_replay_check((mbedtls_ssl_context *) ssl,
3921 &rec->ctr[0]) != 0) {
3922 MBEDTLS_SSL_DEBUG_MSG(1, ("replayed record"));
3923 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003924 }
3925#endif
3926 }
3927#endif /* MBEDTLS_SSL_PROTO_DTLS */
3928
Gilles Peskine449bd832023-01-11 14:50:10 +01003929 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003930}
Paul Bakker5121ce52009-01-03 21:22:43 +00003931
Paul Bakker5121ce52009-01-03 21:22:43 +00003932
Hanno Becker2fddd372019-07-10 14:37:41 +01003933#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003934MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003935static int ssl_check_client_reconnect(mbedtls_ssl_context *ssl)
Hanno Becker2fddd372019-07-10 14:37:41 +01003936{
Gilles Peskine449bd832023-01-11 14:50:10 +01003937 unsigned int rec_epoch = (ssl->in_ctr[0] << 8) | ssl->in_ctr[1];
Hanno Becker2fddd372019-07-10 14:37:41 +01003938
3939 /*
3940 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3941 * access the first byte of record content (handshake type), as we
3942 * have an active transform (possibly iv_len != 0), so use the
3943 * fact that the record header len is 13 instead.
3944 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003945 if (rec_epoch == 0 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003946 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003947 mbedtls_ssl_is_handshake_over(ssl) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003948 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3949 ssl->in_left > 13 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003950 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO) {
3951 MBEDTLS_SSL_DEBUG_MSG(1, ("possible client reconnect "
3952 "from the same port"));
3953 return ssl_handle_possible_reconnect(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003954 }
3955
Gilles Peskine449bd832023-01-11 14:50:10 +01003956 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003957}
Hanno Becker2fddd372019-07-10 14:37:41 +01003958#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003959
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003960/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003961 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003962 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003963MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003964static int ssl_prepare_record_content(mbedtls_ssl_context *ssl,
3965 mbedtls_record *rec)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003966{
3967 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003968
Gilles Peskine449bd832023-01-11 14:50:10 +01003969 MBEDTLS_SSL_DEBUG_BUF(4, "input record from network",
3970 rec->buf, rec->buf_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00003971
Ronald Cron7e38cba2021-11-24 12:43:39 +01003972 /*
3973 * In TLS 1.3, always treat ChangeCipherSpec records
3974 * as unencrypted. The only thing we do with them is
3975 * check the length and content and ignore them.
3976 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003977#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003978 if (ssl->transform_in != NULL &&
3979 ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3980 if (rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01003981 done = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003982 }
Ronald Cron7e38cba2021-11-24 12:43:39 +01003983 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003984#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003985
Gilles Peskine449bd832023-01-11 14:50:10 +01003986 if (!done && ssl->transform_in != NULL) {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003987 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003988
Gilles Peskine449bd832023-01-11 14:50:10 +01003989 if ((ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in,
3990 rec)) != 0) {
3991 MBEDTLS_SSL_DEBUG_RET(1, "ssl_decrypt_buf", ret);
Hanno Becker8367ccc2019-05-14 11:30:10 +01003992
Hanno Beckera0e20d02019-05-15 14:03:01 +01003993#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01003994 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
Hanno Becker8367ccc2019-05-14 11:30:10 +01003995 ssl->conf->ignore_unexpected_cid
Gilles Peskine449bd832023-01-11 14:50:10 +01003996 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
3997 MBEDTLS_SSL_DEBUG_MSG(3, ("ignoring unexpected CID"));
Hanno Becker16ded982019-05-08 13:02:55 +01003998 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01003999 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01004000#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01004001
Gilles Peskine449bd832023-01-11 14:50:10 +01004002 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004003 }
4004
Gilles Peskine449bd832023-01-11 14:50:10 +01004005 if (old_msg_type != rec->type) {
4006 MBEDTLS_SSL_DEBUG_MSG(4, ("record type after decrypt (before %d): %d",
4007 old_msg_type, rec->type));
Hanno Becker6430faf2019-05-08 11:57:13 +01004008 }
4009
Gilles Peskine449bd832023-01-11 14:50:10 +01004010 MBEDTLS_SSL_DEBUG_BUF(4, "input payload after decrypt",
4011 rec->buf + rec->data_offset, rec->data_len);
Hanno Becker1c0c37f2018-08-07 14:29:29 +01004012
Hanno Beckera0e20d02019-05-15 14:03:01 +01004013#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01004014 /* We have already checked the record content type
4015 * in ssl_parse_record_header(), failing or silently
4016 * dropping the record in the case of an unknown type.
4017 *
4018 * Since with the use of CIDs, the record content type
4019 * might change during decryption, re-check the record
4020 * content type, but treat a failure as fatal this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004021 if (ssl_check_record_type(rec->type)) {
4022 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type"));
4023 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker6430faf2019-05-08 11:57:13 +01004024 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01004025#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01004026
Gilles Peskine449bd832023-01-11 14:50:10 +01004027 if (rec->data_len == 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004028#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004029 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
4030 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004031 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004032 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid zero-length message type: %d", ssl->in_msgtype));
4033 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004034 }
4035#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4036
4037 ssl->nb_zero++;
4038
4039 /*
4040 * Three or more empty messages may be a DoS attack
4041 * (excessive CPU consumption).
4042 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004043 if (ssl->nb_zero > 3) {
4044 MBEDTLS_SSL_DEBUG_MSG(1, ("received four consecutive empty "
4045 "messages, possible DoS attack"));
Hanno Becker6e7700d2019-05-08 10:38:32 +01004046 /* Treat the records as if they were not properly authenticated,
4047 * thereby failing the connection if we see more than allowed
4048 * by the configured bad MAC threshold. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004049 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004050 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004051 } else {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004052 ssl->nb_zero = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004053 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004054
4055#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004056 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004057 ; /* in_ctr read from peer, not maintained internally */
Gilles Peskine449bd832023-01-11 14:50:10 +01004058 } else
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004059#endif
4060 {
4061 unsigned i;
Gilles Peskine449bd832023-01-11 14:50:10 +01004062 for (i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
4063 i > mbedtls_ssl_ep_len(ssl); i--) {
4064 if (++ssl->in_ctr[i - 1] != 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004065 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004066 }
Jerry Yuae0b2e22021-10-08 15:21:19 +08004067 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004068
4069 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01004070 if (i == mbedtls_ssl_ep_len(ssl)) {
4071 MBEDTLS_SSL_DEBUG_MSG(1, ("incoming message counter would wrap"));
4072 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004073 }
4074 }
4075
Paul Bakker5121ce52009-01-03 21:22:43 +00004076 }
4077
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004078#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004079 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4080 mbedtls_ssl_dtls_replay_update(ssl);
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02004081 }
4082#endif
4083
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004084 /* Check actual (decrypted) record content length against
4085 * configured maximum. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004086 if (rec->data_len > MBEDTLS_SSL_IN_CONTENT_LEN) {
4087 MBEDTLS_SSL_DEBUG_MSG(1, ("bad message length"));
4088 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004089 }
4090
Gilles Peskine449bd832023-01-11 14:50:10 +01004091 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004092}
4093
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004094/*
4095 * Read a record.
4096 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004097 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
4098 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
4099 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004100 */
Hanno Becker1097b342018-08-15 14:09:41 +01004101
4102/* Helper functions for mbedtls_ssl_read_record(). */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004103MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004104static int ssl_consume_current_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004105MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004106static int ssl_get_next_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004107MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004108static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl);
Hanno Becker4162b112018-08-15 14:05:04 +01004109
Gilles Peskine449bd832023-01-11 14:50:10 +01004110int mbedtls_ssl_read_record(mbedtls_ssl_context *ssl,
4111 unsigned update_hs_digest)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004112{
Janos Follath865b3eb2019-12-16 11:46:15 +00004113 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004114
Gilles Peskine449bd832023-01-11 14:50:10 +01004115 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read record"));
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004116
Gilles Peskine449bd832023-01-11 14:50:10 +01004117 if (ssl->keep_current_message == 0) {
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004118 do {
Simon Butcher99000142016-10-13 17:21:01 +01004119
Gilles Peskine449bd832023-01-11 14:50:10 +01004120 ret = ssl_consume_current_message(ssl);
4121 if (ret != 0) {
4122 return ret;
4123 }
Hanno Becker26994592018-08-15 14:14:59 +01004124
Gilles Peskine449bd832023-01-11 14:50:10 +01004125 if (ssl_record_is_in_progress(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004126 int dtls_have_buffered = 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004127#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere74d5562018-08-15 14:26:08 +01004128
Hanno Becker40f50842018-08-15 14:48:01 +01004129 /* We only check for buffered messages if the
4130 * current datagram is fully consumed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004131 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4132 ssl_next_record_is_in_datagram(ssl) == 0) {
4133 if (ssl_load_buffered_message(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004134 dtls_have_buffered = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004135 }
Hanno Becker40f50842018-08-15 14:48:01 +01004136 }
4137
Hanno Becker40f50842018-08-15 14:48:01 +01004138#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 if (dtls_have_buffered == 0) {
4140 ret = ssl_get_next_record(ssl);
4141 if (ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING) {
Hanno Becker40f50842018-08-15 14:48:01 +01004142 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01004143 }
Hanno Becker40f50842018-08-15 14:48:01 +01004144
Gilles Peskine449bd832023-01-11 14:50:10 +01004145 if (ret != 0) {
4146 MBEDTLS_SSL_DEBUG_RET(1, ("ssl_get_next_record"), ret);
4147 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004148 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004149 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004150 }
4151
Gilles Peskine449bd832023-01-11 14:50:10 +01004152 ret = mbedtls_ssl_handle_message_type(ssl);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004153
Hanno Becker40f50842018-08-15 14:48:01 +01004154#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004155 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
Hanno Becker40f50842018-08-15 14:48:01 +01004156 /* Buffer future message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004157 ret = ssl_buffer_message(ssl);
4158 if (ret != 0) {
4159 return ret;
4160 }
Hanno Becker40f50842018-08-15 14:48:01 +01004161
4162 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4163 }
4164#endif /* MBEDTLS_SSL_PROTO_DTLS */
4165
Gilles Peskine449bd832023-01-11 14:50:10 +01004166 } while (MBEDTLS_ERR_SSL_NON_FATAL == ret ||
4167 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004168
Gilles Peskine449bd832023-01-11 14:50:10 +01004169 if (0 != ret) {
4170 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_handle_message_type"), ret);
4171 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004172 }
4173
Gilles Peskine449bd832023-01-11 14:50:10 +01004174 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
4175 update_hs_digest == 1) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01004176 ret = mbedtls_ssl_update_handshake_status(ssl);
4177 if (0 != ret) {
4178 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_update_handshake_status"), ret);
4179 return ret;
4180 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004181 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004182 } else {
4183 MBEDTLS_SSL_DEBUG_MSG(2, ("reuse previously read message"));
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004184 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004185 }
4186
Gilles Peskine449bd832023-01-11 14:50:10 +01004187 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read record"));
Simon Butcher99000142016-10-13 17:21:01 +01004188
Gilles Peskine449bd832023-01-11 14:50:10 +01004189 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004190}
4191
Hanno Becker40f50842018-08-15 14:48:01 +01004192#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004193MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004194static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004195{
Gilles Peskine449bd832023-01-11 14:50:10 +01004196 if (ssl->in_left > ssl->next_record_offset) {
4197 return 1;
4198 }
Simon Butcher99000142016-10-13 17:21:01 +01004199
Gilles Peskine449bd832023-01-11 14:50:10 +01004200 return 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004201}
4202
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004203MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004204static int ssl_load_buffered_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004205{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004206 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004208 int ret = 0;
4209
Gilles Peskine449bd832023-01-11 14:50:10 +01004210 if (hs == NULL) {
4211 return -1;
4212 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004213
Gilles Peskine449bd832023-01-11 14:50:10 +01004214 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_message"));
Hanno Beckere00ae372018-08-20 09:39:42 +01004215
Gilles Peskine449bd832023-01-11 14:50:10 +01004216 if (ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4217 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004218 /* Check if we have seen a ChangeCipherSpec before.
4219 * If yes, synthesize a CCS record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004220 if (!hs->buffering.seen_ccs) {
4221 MBEDTLS_SSL_DEBUG_MSG(2, ("CCS not seen in the current flight"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004222 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004223 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004224 }
4225
Gilles Peskine449bd832023-01-11 14:50:10 +01004226 MBEDTLS_SSL_DEBUG_MSG(2, ("Injecting buffered CCS message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004227 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4228 ssl->in_msglen = 1;
4229 ssl->in_msg[0] = 1;
4230
4231 /* As long as they are equal, the exact value doesn't matter. */
4232 ssl->in_left = 0;
4233 ssl->next_record_offset = 0;
4234
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004235 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004236 goto exit;
4237 }
Hanno Becker37f95322018-08-16 13:55:32 +01004238
Hanno Beckerb8f50142018-08-28 10:01:34 +01004239#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004240 /* Debug only */
4241 {
4242 unsigned offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004243 for (offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
Hanno Becker37f95322018-08-16 13:55:32 +01004244 hs_buf = &hs->buffering.hs[offset];
Gilles Peskine449bd832023-01-11 14:50:10 +01004245 if (hs_buf->is_valid == 1) {
4246 MBEDTLS_SSL_DEBUG_MSG(2, ("Future message with sequence number %u %s buffered.",
4247 hs->in_msg_seq + offset,
4248 hs_buf->is_complete ? "fully" : "partially"));
Hanno Becker37f95322018-08-16 13:55:32 +01004249 }
4250 }
4251 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004252#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004253
4254 /* Check if we have buffered and/or fully reassembled the
4255 * next handshake message. */
4256 hs_buf = &hs->buffering.hs[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 if ((hs_buf->is_valid == 1) && (hs_buf->is_complete == 1)) {
Hanno Becker37f95322018-08-16 13:55:32 +01004258 /* Synthesize a record containing the buffered HS message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004259 size_t msg_len = (hs_buf->data[1] << 16) |
4260 (hs_buf->data[2] << 8) |
4261 hs_buf->data[3];
Hanno Becker37f95322018-08-16 13:55:32 +01004262
4263 /* Double-check that we haven't accidentally buffered
4264 * a message that doesn't fit into the input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004265 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
4266 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4267 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004268 }
4269
Gilles Peskine449bd832023-01-11 14:50:10 +01004270 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message has been buffered - load"));
4271 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered handshake message (incl. header)",
4272 hs_buf->data, msg_len + 12);
Hanno Becker37f95322018-08-16 13:55:32 +01004273
4274 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4275 ssl->in_hslen = msg_len + 12;
4276 ssl->in_msglen = msg_len + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01004277 memcpy(ssl->in_msg, hs_buf->data, ssl->in_hslen);
Hanno Becker37f95322018-08-16 13:55:32 +01004278
4279 ret = 0;
4280 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004281 } else {
4282 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message %u not or only partially bufffered",
4283 hs->in_msg_seq));
Hanno Becker37f95322018-08-16 13:55:32 +01004284 }
4285
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004286 ret = -1;
4287
4288exit:
4289
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_message"));
4291 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004292}
4293
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004294MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004295static int ssl_buffer_make_space(mbedtls_ssl_context *ssl,
4296 size_t desired)
Hanno Beckera02b0b42018-08-21 17:20:27 +01004297{
4298 int offset;
4299 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004300 MBEDTLS_SSL_DEBUG_MSG(2, ("Attempt to free buffered messages to have %u bytes available",
4301 (unsigned) desired));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004302
Hanno Becker01315ea2018-08-21 17:22:17 +01004303 /* Get rid of future records epoch first, if such exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004304 ssl_free_buffered_record(ssl);
Hanno Becker01315ea2018-08-21 17:22:17 +01004305
4306 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004307 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4308 hs->buffering.total_bytes_buffered)) {
4309 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing future epoch record"));
4310 return 0;
Hanno Becker01315ea2018-08-21 17:22:17 +01004311 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004312
Hanno Becker4f432ad2018-08-28 10:02:32 +01004313 /* We don't have enough space to buffer the next expected handshake
4314 * message. Remove buffers used for future messages to gain space,
4315 * starting with the most distant one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004316 for (offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4317 offset >= 0; offset--) {
4318 MBEDTLS_SSL_DEBUG_MSG(2,
4319 (
4320 "Free buffering slot %d to make space for reassembly of next handshake message",
4321 offset));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004322
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 ssl_buffering_free_slot(ssl, (uint8_t) offset);
Hanno Beckera02b0b42018-08-21 17:20:27 +01004324
4325 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004326 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4327 hs->buffering.total_bytes_buffered)) {
4328 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing buffered HS messages"));
4329 return 0;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004330 }
4331 }
4332
Gilles Peskine449bd832023-01-11 14:50:10 +01004333 return -1;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004334}
4335
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004336MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004337static int ssl_buffer_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004338{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004339 int ret = 0;
4340 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4341
Gilles Peskine449bd832023-01-11 14:50:10 +01004342 if (hs == NULL) {
4343 return 0;
4344 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004345
Gilles Peskine449bd832023-01-11 14:50:10 +01004346 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_buffer_message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004347
Gilles Peskine449bd832023-01-11 14:50:10 +01004348 switch (ssl->in_msgtype) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004349 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
Gilles Peskine449bd832023-01-11 14:50:10 +01004350 MBEDTLS_SSL_DEBUG_MSG(2, ("Remember CCS message"));
Hanno Beckere678eaa2018-08-21 14:57:46 +01004351
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004352 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004353 break;
4354
4355 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004356 {
4357 unsigned recv_msg_seq_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 unsigned recv_msg_seq = (ssl->in_msg[4] << 8) | ssl->in_msg[5];
Hanno Becker37f95322018-08-16 13:55:32 +01004359 mbedtls_ssl_hs_buffer *hs_buf;
4360 size_t msg_len = ssl->in_hslen - 12;
4361
4362 /* We should never receive an old handshake
4363 * message - double-check nonetheless. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004364 if (recv_msg_seq < ssl->handshake->in_msg_seq) {
4365 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4366 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004367 }
4368
4369 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
Gilles Peskine449bd832023-01-11 14:50:10 +01004370 if (recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Becker37f95322018-08-16 13:55:32 +01004371 /* Silently ignore -- message too far in the future */
Gilles Peskine449bd832023-01-11 14:50:10 +01004372 MBEDTLS_SSL_DEBUG_MSG(2,
4373 ("Ignore future HS message with sequence number %u, "
4374 "buffering window %u - %u",
4375 recv_msg_seq, ssl->handshake->in_msg_seq,
4376 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS -
4377 1));
Hanno Becker37f95322018-08-16 13:55:32 +01004378
4379 goto exit;
4380 }
4381
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering HS message with sequence number %u, offset %u ",
4383 recv_msg_seq, recv_msg_seq_offset));
Hanno Becker37f95322018-08-16 13:55:32 +01004384
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 hs_buf = &hs->buffering.hs[recv_msg_seq_offset];
Hanno Becker37f95322018-08-16 13:55:32 +01004386
4387 /* Check if the buffering for this seq nr has already commenced. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004388 if (!hs_buf->is_valid) {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004389 size_t reassembly_buf_sz;
4390
Hanno Becker37f95322018-08-16 13:55:32 +01004391 hs_buf->is_fragmented =
Gilles Peskine449bd832023-01-11 14:50:10 +01004392 (ssl_hs_is_proper_fragment(ssl) == 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004393
4394 /* We copy the message back into the input buffer
4395 * after reassembly, so check that it's not too large.
4396 * This is an implementation-specific limitation
4397 * and not one from the standard, hence it is not
4398 * checked in ssl_check_hs_header(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
Hanno Becker37f95322018-08-16 13:55:32 +01004400 /* Ignore message */
4401 goto exit;
4402 }
4403
Hanno Beckere0b150f2018-08-21 15:51:03 +01004404 /* Check if we have enough space to buffer the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004405 if (hs->buffering.total_bytes_buffered >
4406 MBEDTLS_SSL_DTLS_MAX_BUFFERING) {
4407 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4408 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004409 }
4410
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 reassembly_buf_sz = ssl_get_reassembly_buffer_size(msg_len,
4412 hs_buf->is_fragmented);
Hanno Beckere0b150f2018-08-21 15:51:03 +01004413
Gilles Peskine449bd832023-01-11 14:50:10 +01004414 if (reassembly_buf_sz > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4415 hs->buffering.total_bytes_buffered)) {
4416 if (recv_msg_seq_offset > 0) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004417 /* If we can't buffer a future message because
4418 * of space limitations -- ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 MBEDTLS_SSL_DEBUG_MSG(2,
4420 ("Buffering of future message of size %"
4421 MBEDTLS_PRINTF_SIZET
4422 " would exceed the compile-time limit %"
4423 MBEDTLS_PRINTF_SIZET
4424 " (already %" MBEDTLS_PRINTF_SIZET
4425 " bytes buffered) -- ignore\n",
4426 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4427 hs->buffering.total_bytes_buffered));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004428 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004429 } else {
4430 MBEDTLS_SSL_DEBUG_MSG(2,
4431 ("Buffering of future message of size %"
4432 MBEDTLS_PRINTF_SIZET
4433 " would exceed the compile-time limit %"
4434 MBEDTLS_PRINTF_SIZET
4435 " (already %" MBEDTLS_PRINTF_SIZET
4436 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
4437 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4438 hs->buffering.total_bytes_buffered));
Hanno Beckere1801392018-08-21 16:51:05 +01004439 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004440
Gilles Peskine449bd832023-01-11 14:50:10 +01004441 if (ssl_buffer_make_space(ssl, reassembly_buf_sz) != 0) {
4442 MBEDTLS_SSL_DEBUG_MSG(2,
4443 ("Reassembly of next message of size %"
4444 MBEDTLS_PRINTF_SIZET
4445 " (%" MBEDTLS_PRINTF_SIZET
4446 " with bitmap) would exceed"
4447 " the compile-time limit %"
4448 MBEDTLS_PRINTF_SIZET
4449 " (already %" MBEDTLS_PRINTF_SIZET
4450 " bytes buffered) -- fail\n",
4451 msg_len,
4452 reassembly_buf_sz,
4453 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4454 hs->buffering.total_bytes_buffered));
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004455 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4456 goto exit;
4457 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004458 }
4459
Gilles Peskine449bd832023-01-11 14:50:10 +01004460 MBEDTLS_SSL_DEBUG_MSG(2,
4461 ("initialize reassembly, total length = %"
4462 MBEDTLS_PRINTF_SIZET,
4463 msg_len));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004464
Gilles Peskine449bd832023-01-11 14:50:10 +01004465 hs_buf->data = mbedtls_calloc(1, reassembly_buf_sz);
4466 if (hs_buf->data == NULL) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004467 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004468 goto exit;
4469 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004470 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004471
4472 /* Prepare final header: copy msg_type, length and message_seq,
4473 * then add standardised fragment_offset and fragment_length */
Gilles Peskine449bd832023-01-11 14:50:10 +01004474 memcpy(hs_buf->data, ssl->in_msg, 6);
4475 memset(hs_buf->data + 6, 0, 3);
4476 memcpy(hs_buf->data + 9, hs_buf->data + 1, 3);
Hanno Becker37f95322018-08-16 13:55:32 +01004477
4478 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004479
4480 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Gilles Peskine449bd832023-01-11 14:50:10 +01004481 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004482 /* Make sure msg_type and length are consistent */
Gilles Peskine449bd832023-01-11 14:50:10 +01004483 if (memcmp(hs_buf->data, ssl->in_msg, 4) != 0) {
4484 MBEDTLS_SSL_DEBUG_MSG(1, ("Fragment header mismatch - ignore"));
Hanno Becker37f95322018-08-16 13:55:32 +01004485 /* Ignore */
4486 goto exit;
4487 }
4488 }
4489
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 if (!hs_buf->is_complete) {
Hanno Becker37f95322018-08-16 13:55:32 +01004491 size_t frag_len, frag_off;
4492 unsigned char * const msg = hs_buf->data + 12;
4493
4494 /*
4495 * Check and copy current fragment
4496 */
4497
4498 /* Validation of header fields already done in
4499 * mbedtls_ssl_prepare_handshake_record(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004500 frag_off = ssl_get_hs_frag_off(ssl);
4501 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker37f95322018-08-16 13:55:32 +01004502
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 MBEDTLS_SSL_DEBUG_MSG(2, ("adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4504 ", length = %" MBEDTLS_PRINTF_SIZET,
4505 frag_off, frag_len));
4506 memcpy(msg + frag_off, ssl->in_msg + 12, frag_len);
Hanno Becker37f95322018-08-16 13:55:32 +01004507
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 if (hs_buf->is_fragmented) {
Hanno Becker37f95322018-08-16 13:55:32 +01004509 unsigned char * const bitmask = msg + msg_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004510 ssl_bitmask_set(bitmask, frag_off, frag_len);
4511 hs_buf->is_complete = (ssl_bitmask_check(bitmask,
4512 msg_len) == 0);
4513 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004514 hs_buf->is_complete = 1;
4515 }
4516
Gilles Peskine449bd832023-01-11 14:50:10 +01004517 MBEDTLS_SSL_DEBUG_MSG(2, ("message %scomplete",
4518 hs_buf->is_complete ? "" : "not yet "));
Hanno Becker37f95322018-08-16 13:55:32 +01004519 }
4520
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004521 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004522 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004523
4524 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004525 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004526 break;
4527 }
4528
4529exit:
4530
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_buffer_message"));
4532 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004533}
4534#endif /* MBEDTLS_SSL_PROTO_DTLS */
4535
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004536MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004537static int ssl_consume_current_message(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004538{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004539 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004540 * Consume last content-layer message and potentially
4541 * update in_msglen which keeps track of the contents'
4542 * consumption state.
4543 *
4544 * (1) Handshake messages:
4545 * Remove last handshake message, move content
4546 * and adapt in_msglen.
4547 *
4548 * (2) Alert messages:
4549 * Consume whole record content, in_msglen = 0.
4550 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004551 * (3) Change cipher spec:
4552 * Consume whole record content, in_msglen = 0.
4553 *
4554 * (4) Application data:
4555 * Don't do anything - the record layer provides
4556 * the application data as a stream transport
4557 * and consumes through mbedtls_ssl_read only.
4558 *
4559 */
4560
4561 /* Case (1): Handshake messages */
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 if (ssl->in_hslen != 0) {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004563 /* Hard assertion to be sure that no application data
4564 * is in flight, as corrupting ssl->in_msglen during
4565 * ssl->in_offt != NULL is fatal. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004566 if (ssl->in_offt != NULL) {
4567 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4568 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004569 }
4570
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004571 /*
4572 * Get next Handshake message in the current record
4573 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004574
Hanno Becker4a810fb2017-05-24 16:27:30 +01004575 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004576 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004577 * current handshake content: If DTLS handshake
4578 * fragmentation is used, that's the fragment
4579 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004580 * size here is faulty and should be changed at
4581 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004582 * (2) While it doesn't seem to cause problems, one
4583 * has to be very careful not to assume that in_hslen
4584 * is always <= in_msglen in a sensible communication.
4585 * Again, it's wrong for DTLS handshake fragmentation.
4586 * The following check is therefore mandatory, and
4587 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004588 * Additionally, ssl->in_hslen might be arbitrarily out of
4589 * bounds after handling a DTLS message with an unexpected
4590 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004591 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004592 if (ssl->in_hslen < ssl->in_msglen) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004593 ssl->in_msglen -= ssl->in_hslen;
Gilles Peskine449bd832023-01-11 14:50:10 +01004594 memmove(ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4595 ssl->in_msglen);
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004596
Gilles Peskine449bd832023-01-11 14:50:10 +01004597 MBEDTLS_SSL_DEBUG_BUF(4, "remaining content in record",
4598 ssl->in_msg, ssl->in_msglen);
4599 } else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004600 ssl->in_msglen = 0;
4601 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004602
Hanno Becker4a810fb2017-05-24 16:27:30 +01004603 ssl->in_hslen = 0;
4604 }
4605 /* Case (4): Application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004606 else if (ssl->in_offt != NULL) {
4607 return 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01004608 }
4609 /* Everything else (CCS & Alerts) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004610 else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004611 ssl->in_msglen = 0;
4612 }
4613
Gilles Peskine449bd832023-01-11 14:50:10 +01004614 return 0;
Hanno Becker1097b342018-08-15 14:09:41 +01004615}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004616
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004617MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004618static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl)
Hanno Beckere74d5562018-08-15 14:26:08 +01004619{
Gilles Peskine449bd832023-01-11 14:50:10 +01004620 if (ssl->in_msglen > 0) {
4621 return 1;
4622 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004623
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 return 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01004625}
4626
Hanno Becker5f066e72018-08-16 14:56:31 +01004627#if defined(MBEDTLS_SSL_PROTO_DTLS)
4628
Gilles Peskine449bd832023-01-11 14:50:10 +01004629static void ssl_free_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004630{
4631 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004632 if (hs == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004633 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004634 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004635
Gilles Peskine449bd832023-01-11 14:50:10 +01004636 if (hs->buffering.future_record.data != NULL) {
Hanno Becker01315ea2018-08-21 17:22:17 +01004637 hs->buffering.total_bytes_buffered -=
4638 hs->buffering.future_record.len;
4639
Gilles Peskine449bd832023-01-11 14:50:10 +01004640 mbedtls_free(hs->buffering.future_record.data);
Hanno Becker01315ea2018-08-21 17:22:17 +01004641 hs->buffering.future_record.data = NULL;
4642 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004643}
4644
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004645MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004646static int ssl_load_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004647{
4648 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 unsigned char *rec;
Hanno Becker5f066e72018-08-16 14:56:31 +01004650 size_t rec_len;
4651 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004652#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4653 size_t in_buf_len = ssl->in_buf_len;
4654#else
4655 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4656#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4658 return 0;
4659 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004660
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 if (hs == NULL) {
4662 return 0;
4663 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004664
Hanno Becker5f066e72018-08-16 14:56:31 +01004665 rec = hs->buffering.future_record.data;
4666 rec_len = hs->buffering.future_record.len;
4667 rec_epoch = hs->buffering.future_record.epoch;
4668
Gilles Peskine449bd832023-01-11 14:50:10 +01004669 if (rec == NULL) {
4670 return 0;
4671 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004672
Hanno Becker4cb782d2018-08-20 11:19:05 +01004673 /* Only consider loading future records if the
4674 * input buffer is empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004675 if (ssl_next_record_is_in_datagram(ssl) == 1) {
4676 return 0;
4677 }
Hanno Becker4cb782d2018-08-20 11:19:05 +01004678
Gilles Peskine449bd832023-01-11 14:50:10 +01004679 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_record"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004680
Gilles Peskine449bd832023-01-11 14:50:10 +01004681 if (rec_epoch != ssl->in_epoch) {
4682 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffered record not from current epoch."));
Hanno Becker5f066e72018-08-16 14:56:31 +01004683 goto exit;
4684 }
4685
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 MBEDTLS_SSL_DEBUG_MSG(2, ("Found buffered record from current epoch - load"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004687
4688 /* Double-check that the record is not too large */
Gilles Peskine449bd832023-01-11 14:50:10 +01004689 if (rec_len > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
4690 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4691 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker5f066e72018-08-16 14:56:31 +01004692 }
4693
Gilles Peskine449bd832023-01-11 14:50:10 +01004694 memcpy(ssl->in_hdr, rec, rec_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004695 ssl->in_left = rec_len;
4696 ssl->next_record_offset = 0;
4697
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 ssl_free_buffered_record(ssl);
Hanno Becker5f066e72018-08-16 14:56:31 +01004699
4700exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004701 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_record"));
4702 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004703}
4704
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004705MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004706static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
4707 mbedtls_record const *rec)
Hanno Becker5f066e72018-08-16 14:56:31 +01004708{
4709 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004710
4711 /* Don't buffer future records outside handshakes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 if (hs == NULL) {
4713 return 0;
4714 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004715
4716 /* Only buffer handshake records (we are only interested
4717 * in Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004718 if (rec->type != MBEDTLS_SSL_MSG_HANDSHAKE) {
4719 return 0;
4720 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004721
4722 /* Don't buffer more than one future epoch record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004723 if (hs->buffering.future_record.data != NULL) {
4724 return 0;
4725 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004726
Hanno Becker01315ea2018-08-21 17:22:17 +01004727 /* Don't buffer record if there's not enough buffering space remaining. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004728 if (rec->buf_len > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4729 hs->buffering.total_bytes_buffered)) {
4730 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4731 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4732 " (already %" MBEDTLS_PRINTF_SIZET
4733 " bytes buffered) -- ignore\n",
4734 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4735 hs->buffering.total_bytes_buffered));
4736 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004737 }
4738
Hanno Becker5f066e72018-08-16 14:56:31 +01004739 /* Buffer record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004740 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffer record from epoch %u",
4741 ssl->in_epoch + 1U));
4742 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered record", rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004743
4744 /* ssl_parse_record_header() only considers records
4745 * of the next epoch as candidates for buffering. */
4746 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004747 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004748
4749 hs->buffering.future_record.data =
Gilles Peskine449bd832023-01-11 14:50:10 +01004750 mbedtls_calloc(1, hs->buffering.future_record.len);
4751 if (hs->buffering.future_record.data == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004752 /* If we run out of RAM trying to buffer a
4753 * record from the next epoch, just ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004754 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004755 }
4756
Gilles Peskine449bd832023-01-11 14:50:10 +01004757 memcpy(hs->buffering.future_record.data, rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004758
Hanno Becker519f15d2019-07-11 12:43:20 +01004759 hs->buffering.total_bytes_buffered += rec->buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004760 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004761}
4762
4763#endif /* MBEDTLS_SSL_PROTO_DTLS */
4764
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004765MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004766static int ssl_get_next_record(mbedtls_ssl_context *ssl)
Hanno Becker1097b342018-08-15 14:09:41 +01004767{
Janos Follath865b3eb2019-12-16 11:46:15 +00004768 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004769 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004770
Hanno Becker5f066e72018-08-16 14:56:31 +01004771#if defined(MBEDTLS_SSL_PROTO_DTLS)
4772 /* We might have buffered a future record; if so,
4773 * and if the epoch matches now, load it.
4774 * On success, this call will set ssl->in_left to
4775 * the length of the buffered record, so that
4776 * the calls to ssl_fetch_input() below will
4777 * essentially be no-ops. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004778 ret = ssl_load_buffered_record(ssl);
4779 if (ret != 0) {
4780 return ret;
4781 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004782#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004783
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004784 /* Ensure that we have enough space available for the default form
4785 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4786 * with no space for CIDs counted in). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004787 ret = mbedtls_ssl_fetch_input(ssl, mbedtls_ssl_in_hdr_len(ssl));
4788 if (ret != 0) {
4789 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4790 return ret;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004791 }
4792
Gilles Peskine449bd832023-01-11 14:50:10 +01004793 ret = ssl_parse_record_header(ssl, ssl->in_hdr, ssl->in_left, &rec);
4794 if (ret != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004795#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004796 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4797 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
4798 ret = ssl_buffer_future_record(ssl, &rec);
4799 if (ret != 0) {
4800 return ret;
4801 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004802
4803 /* Fall through to handling of unexpected records */
4804 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4805 }
4806
Gilles Peskine449bd832023-01-11 14:50:10 +01004807 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD) {
Hanno Becker2fddd372019-07-10 14:37:41 +01004808#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004809 /* Reset in pointers to default state for TLS/DTLS records,
4810 * assuming no CID and no offset between record content and
4811 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 mbedtls_ssl_update_in_pointers(ssl);
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004813
Hanno Becker7ae20e02019-07-12 08:33:49 +01004814 /* Setup internal message pointers from record structure. */
4815 ssl->in_msgtype = rec.type;
4816#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4817 ssl->in_len = ssl->in_cid + rec.cid_len;
4818#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4819 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4820 ssl->in_msglen = rec.data_len;
4821
Gilles Peskine449bd832023-01-11 14:50:10 +01004822 ret = ssl_check_client_reconnect(ssl);
4823 MBEDTLS_SSL_DEBUG_RET(2, "ssl_check_client_reconnect", ret);
4824 if (ret != 0) {
4825 return ret;
4826 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004827#endif
4828
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004829 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004830 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004831
Gilles Peskine449bd832023-01-11 14:50:10 +01004832 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding unexpected record "
4833 "(header)"));
4834 } else {
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004835 /* Skip invalid record and the rest of the datagram */
4836 ssl->next_record_offset = 0;
4837 ssl->in_left = 0;
4838
Gilles Peskine449bd832023-01-11 14:50:10 +01004839 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record "
4840 "(header)"));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004841 }
4842
4843 /* Get next record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004844 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4845 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004846#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004847 {
Gilles Peskine449bd832023-01-11 14:50:10 +01004848 return ret;
Hanno Becker2fddd372019-07-10 14:37:41 +01004849 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004850 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004851
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004852#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004853 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckera8814792019-07-10 15:01:45 +01004854 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004855 ssl->next_record_offset = rec.buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 if (ssl->next_record_offset < ssl->in_left) {
4857 MBEDTLS_SSL_DEBUG_MSG(3, ("more than one record within datagram"));
Hanno Beckere65ce782017-05-22 14:47:48 +01004858 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004859 } else
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004860#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004861 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004862 /*
4863 * Fetch record contents from underlying transport.
4864 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004865 ret = mbedtls_ssl_fetch_input(ssl, rec.buf_len);
4866 if (ret != 0) {
4867 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4868 return ret;
Hanno Beckera8814792019-07-10 15:01:45 +01004869 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004870
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004871 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004872 }
4873
4874 /*
4875 * Decrypt record contents.
4876 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004877
Gilles Peskine449bd832023-01-11 14:50:10 +01004878 if ((ret = ssl_prepare_record_content(ssl, &rec)) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004879#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004880 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004881 /* Silently discard invalid records */
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004883 /* Except when waiting for Finished as a bad mac here
4884 * probably means something went wrong in the handshake
4885 * (eg wrong psk used, mitm downgrade attempt, etc.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004886 if (ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4887 ssl->state == MBEDTLS_SSL_SERVER_FINISHED) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004888#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004889 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4890 mbedtls_ssl_send_alert_message(ssl,
4891 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4892 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004893 }
4894#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 return ret;
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004896 }
4897
Gilles Peskine449bd832023-01-11 14:50:10 +01004898 if (ssl->conf->badmac_limit != 0 &&
4899 ++ssl->badmac_seen >= ssl->conf->badmac_limit) {
4900 MBEDTLS_SSL_DEBUG_MSG(1, ("too many records with bad MAC"));
4901 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004902 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004903
Hanno Becker4a810fb2017-05-24 16:27:30 +01004904 /* As above, invalid records cause
4905 * dismissal of the whole datagram. */
4906
4907 ssl->next_record_offset = 0;
4908 ssl->in_left = 0;
4909
Gilles Peskine449bd832023-01-11 14:50:10 +01004910 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record (mac)"));
4911 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004912 }
4913
Gilles Peskine449bd832023-01-11 14:50:10 +01004914 return ret;
4915 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004916#endif
4917 {
4918 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004919#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004920 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4921 mbedtls_ssl_send_alert_message(ssl,
4922 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4923 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004924 }
4925#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004926 return ret;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004927 }
4928 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004929
Hanno Becker44d89b22019-07-12 09:40:44 +01004930
4931 /* Reset in pointers to default state for TLS/DTLS records,
4932 * assuming no CID and no offset between record content and
4933 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004934 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker44d89b22019-07-12 09:40:44 +01004935#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4936 ssl->in_len = ssl->in_cid + rec.cid_len;
4937#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004938 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004939
Hanno Becker8685c822019-07-12 09:37:30 +01004940 /* The record content type may change during decryption,
4941 * so re-read it. */
4942 ssl->in_msgtype = rec.type;
4943 /* Also update the input buffer, because unfortunately
4944 * the server-side ssl_parse_client_hello() reparses the
4945 * record header when receiving a ClientHello initiating
4946 * a renegotiation. */
4947 ssl->in_hdr[0] = rec.type;
4948 ssl->in_msg = rec.buf + rec.data_offset;
4949 ssl->in_msglen = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004950 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->in_len, 0);
Hanno Becker8685c822019-07-12 09:37:30 +01004951
Gilles Peskine449bd832023-01-11 14:50:10 +01004952 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004953}
4954
Gilles Peskine449bd832023-01-11 14:50:10 +01004955int mbedtls_ssl_handle_message_type(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004956{
Janos Follath865b3eb2019-12-16 11:46:15 +00004957 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004958
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004959 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004960 * Handle particular types of records
4961 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004962 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
4963 if ((ret = mbedtls_ssl_prepare_handshake_record(ssl)) != 0) {
4964 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004965 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004966 }
4967
Gilles Peskine449bd832023-01-11 14:50:10 +01004968 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
4969 if (ssl->in_msglen != 1) {
4970 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
4971 ssl->in_msglen));
4972 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004973 }
4974
Gilles Peskine449bd832023-01-11 14:50:10 +01004975 if (ssl->in_msg[0] != 1) {
4976 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, content: %02x",
4977 ssl->in_msg[0]));
4978 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004979 }
4980
4981#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004982 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere678eaa2018-08-21 14:57:46 +01004983 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01004984 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
4985 if (ssl->handshake == NULL) {
4986 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping ChangeCipherSpec outside handshake"));
4987 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004988 }
4989
Gilles Peskine449bd832023-01-11 14:50:10 +01004990 MBEDTLS_SSL_DEBUG_MSG(1, ("received out-of-order ChangeCipherSpec - remember"));
4991 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004992 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004993#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01004994
Ronald Cron6f135e12021-12-08 16:57:54 +01004995#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004996 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01004997#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004998 MBEDTLS_SSL_DEBUG_MSG(1,
4999 ("Ignore ChangeCipherSpec in TLS 1.3 compatibility mode"));
5000 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Ronald Cron7e38cba2021-11-24 12:43:39 +01005001#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005002 MBEDTLS_SSL_DEBUG_MSG(1,
5003 ("ChangeCipherSpec invalid in TLS 1.3 without compatibility mode"));
5004 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Ronald Cron7e38cba2021-11-24 12:43:39 +01005005#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
5006 }
Ronald Cron6f135e12021-12-08 16:57:54 +01005007#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01005008 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01005009
Gilles Peskine449bd832023-01-11 14:50:10 +01005010 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5011 if (ssl->in_msglen != 2) {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10005012 /* Note: Standard allows for more than one 2 byte alert
5013 to be packed in a single message, but Mbed TLS doesn't
5014 currently support this. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005015 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
5016 ssl->in_msglen));
5017 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Angus Gratton1a7a17e2018-06-20 15:43:50 +10005018 }
5019
Gilles Peskine449bd832023-01-11 14:50:10 +01005020 MBEDTLS_SSL_DEBUG_MSG(2, ("got an alert message, type: [%u:%u]",
5021 ssl->in_msg[0], ssl->in_msg[1]));
Paul Bakker5121ce52009-01-03 21:22:43 +00005022
5023 /*
Simon Butcher459a9502015-10-27 16:09:03 +00005024 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00005025 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005026 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL) {
5027 MBEDTLS_SSL_DEBUG_MSG(1, ("is a fatal alert message (msg %d)",
5028 ssl->in_msg[1]));
5029 return MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005030 }
5031
Gilles Peskine449bd832023-01-11 14:50:10 +01005032 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
5033 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY) {
5034 MBEDTLS_SSL_DEBUG_MSG(2, ("is a close notify message"));
5035 return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY;
Paul Bakker5121ce52009-01-03 21:22:43 +00005036 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005037
5038#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005039 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
5040 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION) {
5041 MBEDTLS_SSL_DEBUG_MSG(2, ("is a no renegotiation alert"));
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005042 /* Will be handled when trying to parse ServerHello */
Gilles Peskine449bd832023-01-11 14:50:10 +01005043 return 0;
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005044 }
5045#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005046 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01005047 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005048 }
5049
Hanno Beckerc76c6192017-06-06 10:03:17 +01005050#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005051 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker37ae9522019-05-03 16:54:26 +01005052 /* Drop unexpected ApplicationData records,
5053 * except at the beginning of renegotiations */
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
5055 mbedtls_ssl_is_handshake_over(ssl) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01005056#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005057 && !(ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
5058 ssl->state == MBEDTLS_SSL_SERVER_HELLO)
Hanno Beckerc76c6192017-06-06 10:03:17 +01005059#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005060 ) {
5061 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping unexpected ApplicationData"));
5062 return MBEDTLS_ERR_SSL_NON_FATAL;
Hanno Becker37ae9522019-05-03 16:54:26 +01005063 }
5064
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 if (ssl->handshake != NULL &&
5066 mbedtls_ssl_is_handshake_over(ssl) == 1) {
5067 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Hanno Becker37ae9522019-05-03 16:54:26 +01005068 }
5069 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01005070#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01005071
Gilles Peskine449bd832023-01-11 14:50:10 +01005072 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005073}
5074
Gilles Peskine449bd832023-01-11 14:50:10 +01005075int mbedtls_ssl_send_fatal_handshake_failure(mbedtls_ssl_context *ssl)
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005076{
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 return mbedtls_ssl_send_alert_message(ssl,
5078 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5079 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE);
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005080}
5081
Gilles Peskine449bd832023-01-11 14:50:10 +01005082int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
5083 unsigned char level,
5084 unsigned char message)
Paul Bakker0a925182012-04-16 06:46:41 +00005085{
Janos Follath865b3eb2019-12-16 11:46:15 +00005086 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00005087
Gilles Peskine449bd832023-01-11 14:50:10 +01005088 if (ssl == NULL || ssl->conf == NULL) {
5089 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5090 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005091
Gilles Peskine449bd832023-01-11 14:50:10 +01005092 if (ssl->out_left != 0) {
5093 return mbedtls_ssl_flush_output(ssl);
5094 }
Hanno Becker5e18f742018-08-06 11:35:16 +01005095
Gilles Peskine449bd832023-01-11 14:50:10 +01005096 MBEDTLS_SSL_DEBUG_MSG(2, ("=> send alert message"));
5097 MBEDTLS_SSL_DEBUG_MSG(3, ("send alert level=%u message=%u", level, message));
Paul Bakker0a925182012-04-16 06:46:41 +00005098
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005099 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00005100 ssl->out_msglen = 2;
5101 ssl->out_msg[0] = level;
5102 ssl->out_msg[1] = message;
5103
Gilles Peskine449bd832023-01-11 14:50:10 +01005104 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5105 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5106 return ret;
Paul Bakker0a925182012-04-16 06:46:41 +00005107 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 MBEDTLS_SSL_DEBUG_MSG(2, ("<= send alert message"));
Paul Bakker0a925182012-04-16 06:46:41 +00005109
Gilles Peskine449bd832023-01-11 14:50:10 +01005110 return 0;
Paul Bakker0a925182012-04-16 06:46:41 +00005111}
5112
Gilles Peskine449bd832023-01-11 14:50:10 +01005113int mbedtls_ssl_write_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005114{
Janos Follath865b3eb2019-12-16 11:46:15 +00005115 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005116
Gilles Peskine449bd832023-01-11 14:50:10 +01005117 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005118
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005119 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00005120 ssl->out_msglen = 1;
5121 ssl->out_msg[0] = 1;
5122
Paul Bakker5121ce52009-01-03 21:22:43 +00005123 ssl->state++;
5124
Gilles Peskine449bd832023-01-11 14:50:10 +01005125 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
5126 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
5127 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005128 }
5129
Gilles Peskine449bd832023-01-11 14:50:10 +01005130 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005131
Gilles Peskine449bd832023-01-11 14:50:10 +01005132 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005133}
5134
Gilles Peskine449bd832023-01-11 14:50:10 +01005135int mbedtls_ssl_parse_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005136{
Janos Follath865b3eb2019-12-16 11:46:15 +00005137 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005138
Gilles Peskine449bd832023-01-11 14:50:10 +01005139 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005140
Gilles Peskine449bd832023-01-11 14:50:10 +01005141 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5142 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5143 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005144 }
5145
Gilles Peskine449bd832023-01-11 14:50:10 +01005146 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
5147 MBEDTLS_SSL_DEBUG_MSG(1, ("bad change cipher spec message"));
5148 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5149 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
5150 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005151 }
5152
Hanno Beckere678eaa2018-08-21 14:57:46 +01005153 /* CCS records are only accepted if they have length 1 and content '1',
5154 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005155
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005156 /*
5157 * Switch to our negotiated transform and session parameters for inbound
5158 * data.
5159 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for inbound data"));
Jerry Yu2e199812022-12-01 18:57:19 +08005161#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005162 ssl->transform_in = ssl->transform_negotiate;
Jerry Yu2e199812022-12-01 18:57:19 +08005163#endif
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005164 ssl->session_in = ssl->session_negotiate;
5165
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005166#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005167 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005168#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005169 mbedtls_ssl_dtls_replay_reset(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005170#endif
5171
5172 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 if (++ssl->in_epoch == 0) {
5174 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005175 /* This is highly unlikely to happen for legitimate reasons, so
5176 treat it as an attack and don't send an alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005177 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005178 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005179 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005180#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005181 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005182
Gilles Peskine449bd832023-01-11 14:50:10 +01005183 mbedtls_ssl_update_in_pointers(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005184
Paul Bakker5121ce52009-01-03 21:22:43 +00005185 ssl->state++;
5186
Gilles Peskine449bd832023-01-11 14:50:10 +01005187 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005188
Gilles Peskine449bd832023-01-11 14:50:10 +01005189 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005190}
5191
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005192/* Once ssl->out_hdr as the address of the beginning of the
5193 * next outgoing record is set, deduce the other pointers.
5194 *
5195 * Note: For TLS, we save the implicit record sequence number
5196 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5197 * and the caller has to make sure there's space for this.
5198 */
5199
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005200static size_t ssl_transform_get_explicit_iv_len(
Gilles Peskine449bd832023-01-11 14:50:10 +01005201 mbedtls_ssl_transform const *transform)
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005202{
Gilles Peskine449bd832023-01-11 14:50:10 +01005203 return transform->ivlen - transform->fixed_ivlen;
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005204}
5205
Gilles Peskine449bd832023-01-11 14:50:10 +01005206void mbedtls_ssl_update_out_pointers(mbedtls_ssl_context *ssl,
5207 mbedtls_ssl_transform *transform)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005208{
5209#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005210 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005211 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005212#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005213 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005214 ssl->out_len = ssl->out_cid;
Gilles Peskine449bd832023-01-11 14:50:10 +01005215 if (transform != NULL) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005216 ssl->out_len += transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005218#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005219 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005220#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005221 ssl->out_iv = ssl->out_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005222 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005223#endif
5224 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005225 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005226#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005227 ssl->out_cid = ssl->out_len;
5228#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005229 ssl->out_iv = ssl->out_hdr + 5;
5230 }
5231
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005232 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005233 /* Adjust out_msg to make space for explicit IV, if used. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005234 if (transform != NULL) {
5235 ssl->out_msg += ssl_transform_get_explicit_iv_len(transform);
5236 }
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005237}
5238
5239/* Once ssl->in_hdr as the address of the beginning of the
5240 * next incoming record is set, deduce the other pointers.
5241 *
5242 * Note: For TLS, we save the implicit record sequence number
5243 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5244 * and the caller has to make sure there's space for this.
5245 */
5246
Gilles Peskine449bd832023-01-11 14:50:10 +01005247void mbedtls_ssl_update_in_pointers(mbedtls_ssl_context *ssl)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005248{
Hanno Becker79594fd2019-05-08 09:38:41 +01005249 /* This function sets the pointers to match the case
5250 * of unprotected TLS/DTLS records, with both ssl->in_iv
5251 * and ssl->in_msg pointing to the beginning of the record
5252 * content.
5253 *
5254 * When decrypting a protected record, ssl->in_msg
5255 * will be shifted to point to the beginning of the
5256 * record plaintext.
5257 */
5258
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005259#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005260 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005261 /* This sets the header pointers to match records
5262 * without CID. When we receive a record containing
5263 * a CID, the fields are shifted accordingly in
5264 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005265 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005266#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005267 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005268 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005269#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005270 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005271#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005272 ssl->in_iv = ssl->in_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005273 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005274#endif
5275 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08005276 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005277 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005278#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005279 ssl->in_cid = ssl->in_len;
5280#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005281 ssl->in_iv = ssl->in_hdr + 5;
5282 }
5283
Hanno Becker79594fd2019-05-08 09:38:41 +01005284 /* This will be adjusted at record decryption time. */
5285 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005286}
5287
Paul Bakker5121ce52009-01-03 21:22:43 +00005288/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005289 * Setup an SSL context
5290 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005291
Gilles Peskine449bd832023-01-11 14:50:10 +01005292void mbedtls_ssl_reset_in_out_pointers(mbedtls_ssl_context *ssl)
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005293{
5294 /* Set the incoming and outgoing record pointers. */
5295#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005296 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005297 ssl->out_hdr = ssl->out_buf;
5298 ssl->in_hdr = ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01005299 } else
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005300#endif /* MBEDTLS_SSL_PROTO_DTLS */
5301 {
Hanno Becker12078f42021-03-02 15:28:41 +00005302 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005303 ssl->out_hdr = ssl->out_buf + 8;
5304 ssl->in_hdr = ssl->in_buf + 8;
5305 }
5306
5307 /* Derive other internal pointers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005308 mbedtls_ssl_update_out_pointers(ssl, NULL /* no transform enabled */);
5309 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005310}
5311
Paul Bakker5121ce52009-01-03 21:22:43 +00005312/*
5313 * SSL get accessors
5314 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005315size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005316{
Gilles Peskine449bd832023-01-11 14:50:10 +01005317 return ssl->in_offt == NULL ? 0 : ssl->in_msglen;
Paul Bakker5121ce52009-01-03 21:22:43 +00005318}
5319
Gilles Peskine449bd832023-01-11 14:50:10 +01005320int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl)
Hanno Becker8b170a02017-10-10 11:51:19 +01005321{
5322 /*
5323 * Case A: We're currently holding back
5324 * a message for further processing.
5325 */
5326
Gilles Peskine449bd832023-01-11 14:50:10 +01005327 if (ssl->keep_current_message == 1) {
5328 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: record held back for processing"));
5329 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005330 }
5331
5332 /*
5333 * Case B: Further records are pending in the current datagram.
5334 */
5335
5336#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005337 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5338 ssl->in_left > ssl->next_record_offset) {
5339 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: more records within current datagram"));
5340 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005341 }
5342#endif /* MBEDTLS_SSL_PROTO_DTLS */
5343
5344 /*
5345 * Case C: A handshake message is being processed.
5346 */
5347
Gilles Peskine449bd832023-01-11 14:50:10 +01005348 if (ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen) {
5349 MBEDTLS_SSL_DEBUG_MSG(3,
5350 ("ssl_check_pending: more handshake messages within current record"));
5351 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005352 }
5353
5354 /*
5355 * Case D: An application data message is being processed
5356 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005357 if (ssl->in_offt != NULL) {
5358 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: application data record is being processed"));
5359 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005360 }
5361
5362 /*
5363 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005364 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005365 * we implement support for multiple alerts in single records.
5366 */
5367
Gilles Peskine449bd832023-01-11 14:50:10 +01005368 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: nothing pending"));
5369 return 0;
Hanno Becker8b170a02017-10-10 11:51:19 +01005370}
5371
Paul Bakker43ca69c2011-01-15 17:35:19 +00005372
Gilles Peskine449bd832023-01-11 14:50:10 +01005373int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005374{
Hanno Becker3136ede2018-08-17 15:28:19 +01005375 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005376 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005377 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005378#if defined(MBEDTLS_USE_PSA_CRYPTO)
5379 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5380 psa_key_type_t key_type;
5381#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005382
Gilles Peskine449bd832023-01-11 14:50:10 +01005383 size_t out_hdr_len = mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker5903de42019-05-03 14:46:38 +01005384
Gilles Peskine449bd832023-01-11 14:50:10 +01005385 if (transform == NULL) {
5386 return (int) out_hdr_len;
5387 }
Hanno Becker78640902018-08-13 16:35:15 +01005388
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005389
5390#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005391 if (transform->psa_alg == PSA_ALG_GCM ||
5392 transform->psa_alg == PSA_ALG_CCM ||
5393 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 8) ||
5394 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
5395 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005396 transform_expansion = transform->minlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01005397 } else if (transform->psa_alg == PSA_ALG_CBC_NO_PADDING) {
5398 (void) psa_get_key_attributes(transform->psa_key_enc, &attr);
5399 key_type = psa_get_key_type(&attr);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005400
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005402
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005403 /* Expansion due to the addition of the MAC. */
5404 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005405
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005406 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005407 * Theoretically up to 256 bytes, but we never use
5408 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005409 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005410
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005411 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005412 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005413#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005414 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005415#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 } else {
5417 MBEDTLS_SSL_DEBUG_MSG(1,
5418 ("Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()"));
5419 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005420 }
5421#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005422 switch (mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005423 case MBEDTLS_MODE_GCM:
5424 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005425 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005426 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005427 transform_expansion = transform->minlen;
5428 break;
5429
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005430 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005431
5432 block_size = mbedtls_cipher_get_block_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 &transform->cipher_ctx_enc);
Hanno Becker5b559ac2018-08-03 09:40:07 +01005434
Hanno Becker3136ede2018-08-17 15:28:19 +01005435 /* Expansion due to the addition of the MAC. */
5436 transform_expansion += transform->maclen;
5437
5438 /* Expansion due to the addition of CBC padding;
5439 * Theoretically up to 256 bytes, but we never use
5440 * more than the block size of the underlying cipher. */
5441 transform_expansion += block_size;
5442
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005443 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005444 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005445#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005446 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005447#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005448
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005449 break;
5450
5451 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005452 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
5453 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005454 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005455#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005456
Hanno Beckera0e20d02019-05-15 14:03:01 +01005457#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01005458 if (transform->out_cid_len != 0) {
Hanno Becker6cbad552019-05-08 15:40:11 +01005459 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01005460 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005461#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005462
Gilles Peskine449bd832023-01-11 14:50:10 +01005463 return (int) (out_hdr_len + transform_expansion);
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005464}
5465
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005466#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005467/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005468 * Check record counters and renegotiate if they're above the limit.
5469 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005470MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005471static int ssl_check_ctr_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005472{
Gilles Peskine449bd832023-01-11 14:50:10 +01005473 size_t ep_len = mbedtls_ssl_ep_len(ssl);
Andres AG2196c7f2016-12-15 17:01:16 +00005474 int in_ctr_cmp;
5475 int out_ctr_cmp;
5476
Gilles Peskine449bd832023-01-11 14:50:10 +01005477 if (mbedtls_ssl_is_handshake_over(ssl) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005478 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Gilles Peskine449bd832023-01-11 14:50:10 +01005479 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5480 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005481 }
5482
Gilles Peskine449bd832023-01-11 14:50:10 +01005483 in_ctr_cmp = memcmp(ssl->in_ctr + ep_len,
5484 &ssl->conf->renego_period[ep_len],
5485 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len);
5486 out_ctr_cmp = memcmp(&ssl->cur_out_ctr[ep_len],
Jerry Yud9a94fe2021-09-28 18:58:59 +08005487 &ssl->conf->renego_period[ep_len],
Gilles Peskine449bd832023-01-11 14:50:10 +01005488 sizeof(ssl->cur_out_ctr) - ep_len);
Andres AG2196c7f2016-12-15 17:01:16 +00005489
Gilles Peskine449bd832023-01-11 14:50:10 +01005490 if (in_ctr_cmp <= 0 && out_ctr_cmp <= 0) {
5491 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005492 }
5493
Gilles Peskine449bd832023-01-11 14:50:10 +01005494 MBEDTLS_SSL_DEBUG_MSG(1, ("record counter limit reached: renegotiate"));
5495 return mbedtls_ssl_renegotiate(ssl);
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005496}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005497#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005498
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005499#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5500
5501#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Jerry Yua0446a02022-07-13 11:22:55 +08005502MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005503static int ssl_tls13_check_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005504{
5505
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 if ((ssl->in_hslen == mbedtls_ssl_hs_hdr_len(ssl)) ||
5507 (ssl->in_msg[0] != MBEDTLS_SSL_HS_NEW_SESSION_TICKET)) {
5508 return 0;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005509 }
5510
5511 ssl->keep_current_message = 1;
5512
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 MBEDTLS_SSL_DEBUG_MSG(3, ("NewSessionTicket received"));
5514 mbedtls_ssl_handshake_set_state(ssl,
5515 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005516
Gilles Peskine449bd832023-01-11 14:50:10 +01005517 return MBEDTLS_ERR_SSL_WANT_READ;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005518}
5519#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5520
Jerry Yua0446a02022-07-13 11:22:55 +08005521MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005522static int ssl_tls13_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005523{
5524
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 MBEDTLS_SSL_DEBUG_MSG(3, ("received post-handshake message"));
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005526
5527#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005528 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
5529 int ret = ssl_tls13_check_new_session_ticket(ssl);
5530 if (ret != 0) {
5531 return ret;
5532 }
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005533 }
5534#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5535
5536 /* Fail in all other cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005537 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005538}
5539#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5540
5541#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005542/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005543 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005544 * may only be sent for the purpose of initiating renegotiations.
5545 *
5546 * This function is introduced as a separate helper since the handling
5547 * of post-handshake handshake messages changes significantly in TLS 1.3,
5548 * and having a helper function allows to distinguish between TLS <= 1.2 and
5549 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5550 */
Jerry Yua0446a02022-07-13 11:22:55 +08005551MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005552static int ssl_tls12_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005553{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005554 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005555
5556 /*
5557 * - For client-side, expect SERVER_HELLO_REQUEST.
5558 * - For server-side, expect CLIENT_HELLO.
5559 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5560 */
5561
5562#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005563 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5564 (ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5565 ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl))) {
5566 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not HelloRequest)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005567
5568 /* With DTLS, drop the packet (probably from last handshake) */
5569#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005570 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5571 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005572 }
5573#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005574 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005575 }
5576#endif /* MBEDTLS_SSL_CLI_C */
5577
5578#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005579 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5580 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO) {
5581 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not ClientHello)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005582
5583 /* With DTLS, drop the packet (probably from last handshake) */
5584#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005585 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5586 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005587 }
5588#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005589 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005590 }
5591#endif /* MBEDTLS_SSL_SRV_C */
5592
5593#if defined(MBEDTLS_SSL_RENEGOTIATION)
5594 /* Determine whether renegotiation attempt should be accepted */
Gilles Peskine449bd832023-01-11 14:50:10 +01005595 if (!(ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5596 (ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5597 ssl->conf->allow_legacy_renegotiation ==
5598 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION))) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005599 /*
5600 * Accept renegotiation request
5601 */
5602
5603 /* DTLS clients need to know renego is server-initiated */
5604#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005605 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5606 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005607 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5608 }
5609#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005610 ret = mbedtls_ssl_start_renegotiation(ssl);
5611 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5612 ret != 0) {
5613 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation",
5614 ret);
5615 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005616 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005617 } else
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005618#endif /* MBEDTLS_SSL_RENEGOTIATION */
5619 {
5620 /*
5621 * Refuse renegotiation
5622 */
5623
Gilles Peskine449bd832023-01-11 14:50:10 +01005624 MBEDTLS_SSL_DEBUG_MSG(3, ("refusing renegotiation, sending alert"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005625
Gilles Peskine449bd832023-01-11 14:50:10 +01005626 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5627 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5628 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION)) != 0) {
5629 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005630 }
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005631 }
5632
Gilles Peskine449bd832023-01-11 14:50:10 +01005633 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005634}
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005635#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5636
5637MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005638static int ssl_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005639{
5640 /* Check protocol version and dispatch accordingly. */
5641#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005642 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
5643 return ssl_tls13_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005644 }
5645#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5646
5647#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005648 if (ssl->tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
5649 return ssl_tls12_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005650 }
5651#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5652
5653 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01005654 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005655}
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005656
Paul Bakker48916f92012-09-16 19:57:18 +00005657/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005658 * Receive application data decrypted from the SSL layer
5659 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005660int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005661{
Janos Follath865b3eb2019-12-16 11:46:15 +00005662 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005663 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005664
Gilles Peskine449bd832023-01-11 14:50:10 +01005665 if (ssl == NULL || ssl->conf == NULL) {
5666 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5667 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005668
Gilles Peskine449bd832023-01-11 14:50:10 +01005669 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005670
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005671#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005672 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5673 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5674 return ret;
5675 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005676
Gilles Peskine449bd832023-01-11 14:50:10 +01005677 if (ssl->handshake != NULL &&
5678 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
5679 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
5680 return ret;
5681 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005682 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005683 }
5684#endif
5685
Hanno Becker4a810fb2017-05-24 16:27:30 +01005686 /*
5687 * Check if renegotiation is necessary and/or handshake is
5688 * in process. If yes, perform/continue, and fall through
5689 * if an unexpected packet is received while the client
5690 * is waiting for the ServerHello.
5691 *
5692 * (There is no equivalent to the last condition on
5693 * the server-side as it is not treated as within
5694 * a handshake while waiting for the ClientHello
5695 * after a renegotiation request.)
5696 */
5697
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005698#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005699 ret = ssl_check_ctr_renegotiate(ssl);
5700 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5701 ret != 0) {
5702 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5703 return ret;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005704 }
5705#endif
5706
Gilles Peskine449bd832023-01-11 14:50:10 +01005707 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5708 ret = mbedtls_ssl_handshake(ssl);
5709 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5710 ret != 0) {
5711 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5712 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005713 }
5714 }
5715
Hanno Beckere41158b2017-10-23 13:30:32 +01005716 /* Loop as long as no application data record is available */
Gilles Peskine449bd832023-01-11 14:50:10 +01005717 while (ssl->in_offt == NULL) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005718 /* Start timer if not already running */
Gilles Peskine449bd832023-01-11 14:50:10 +01005719 if (ssl->f_get_timer != NULL &&
5720 ssl->f_get_timer(ssl->p_timer) == -1) {
5721 mbedtls_ssl_set_timer(ssl, ssl->conf->read_timeout);
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005722 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005723
Gilles Peskine449bd832023-01-11 14:50:10 +01005724 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5725 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5726 return 0;
5727 }
Paul Bakker831a7552011-05-18 13:32:51 +00005728
Gilles Peskine449bd832023-01-11 14:50:10 +01005729 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5730 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005731 }
5732
Gilles Peskine449bd832023-01-11 14:50:10 +01005733 if (ssl->in_msglen == 0 &&
5734 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Paul Bakker5121ce52009-01-03 21:22:43 +00005735 /*
5736 * OpenSSL sends empty messages to randomize the IV
5737 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005738 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5739 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5740 return 0;
5741 }
Paul Bakker831a7552011-05-18 13:32:51 +00005742
Gilles Peskine449bd832023-01-11 14:50:10 +01005743 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5744 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005745 }
5746 }
5747
Gilles Peskine449bd832023-01-11 14:50:10 +01005748 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
5749 ret = ssl_handle_hs_message_post_handshake(ssl);
5750 if (ret != 0) {
5751 MBEDTLS_SSL_DEBUG_RET(1, "ssl_handle_hs_message_post_handshake",
5752 ret);
5753 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00005754 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005755
Hanno Beckerf26cc722021-04-21 07:30:13 +01005756 /* At this point, we don't know whether the renegotiation triggered
5757 * by the post-handshake message has been completed or not. The cases
5758 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005759 * 1) The renegotiation is complete. In this case, no new record
5760 * has been read yet.
5761 * 2) The renegotiation is incomplete because the client received
5762 * an application data record while awaiting the ServerHello.
5763 * 3) The renegotiation is incomplete because the client received
5764 * a non-handshake, non-application data message while awaiting
5765 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005766 *
5767 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005768 * - For 1), the next iteration will read a new record and check
5769 * if it's application data.
5770 * - For 2), the loop condition isn't satisfied as application data
5771 * is present, hence continue is the same as break
5772 * - For 3), the loop condition is satisfied and read_record
5773 * will re-deliver the message that was held back by the client
5774 * when expecting the ServerHello.
5775 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005776
Hanno Becker90333da2017-10-10 11:27:13 +01005777 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005778 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005779#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005780 else if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5781 if (ssl->conf->renego_max_records >= 0) {
5782 if (++ssl->renego_records_seen > ssl->conf->renego_max_records) {
5783 MBEDTLS_SSL_DEBUG_MSG(1, ("renegotiation requested, "
5784 "but not honored by client"));
5785 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005786 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005787 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005788 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005789#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005790
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005791 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
Gilles Peskine449bd832023-01-11 14:50:10 +01005792 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5793 MBEDTLS_SSL_DEBUG_MSG(2, ("ignoring non-fatal non-closure alert"));
5794 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005795 }
5796
Gilles Peskine449bd832023-01-11 14:50:10 +01005797 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
5798 MBEDTLS_SSL_DEBUG_MSG(1, ("bad application data message"));
5799 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005800 }
5801
5802 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005803
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005804 /* We're going to return something now, cancel timer,
5805 * except if handshake (renegotiation) is in progress */
Gilles Peskine449bd832023-01-11 14:50:10 +01005806 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5807 mbedtls_ssl_set_timer(ssl, 0);
5808 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005809
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005810#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005811 /* If we requested renego but received AppData, resend HelloRequest.
5812 * Do it now, after setting in_offt, to avoid taking this branch
5813 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005814#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005815 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5816 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5817 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
5818 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
5819 ret);
5820 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005821 }
5822 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005823#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005824#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005825 }
5826
Gilles Peskine449bd832023-01-11 14:50:10 +01005827 n = (len < ssl->in_msglen)
Paul Bakker5121ce52009-01-03 21:22:43 +00005828 ? len : ssl->in_msglen;
5829
ashesman937d6d52022-02-17 11:08:27 +13005830 if (len != 0) {
Ashley Duncan358f94a2022-02-11 09:57:18 +13005831 memcpy(buf, ssl->in_offt, n);
5832 ssl->in_msglen -= n;
5833 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005834
gabor-mezei-arma3214132020-07-15 10:55:00 +02005835 /* Zeroising the plaintext buffer to erase unused application data
5836 from the memory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005837 mbedtls_platform_zeroize(ssl->in_offt, n);
gabor-mezei-arma3214132020-07-15 10:55:00 +02005838
Gilles Peskine449bd832023-01-11 14:50:10 +01005839 if (ssl->in_msglen == 0) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005840 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005841 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005842 ssl->keep_current_message = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01005843 } else {
Paul Bakker5121ce52009-01-03 21:22:43 +00005844 /* more data available */
5845 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005846 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005847
Gilles Peskine449bd832023-01-11 14:50:10 +01005848 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005849
Gilles Peskine449bd832023-01-11 14:50:10 +01005850 return (int) n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005851}
5852
5853/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005854 * Send application data to be encrypted by the SSL layer, taking care of max
5855 * fragment length and buffer size.
5856 *
5857 * According to RFC 5246 Section 6.2.1:
5858 *
5859 * Zero-length fragments of Application data MAY be sent as they are
5860 * potentially useful as a traffic analysis countermeasure.
5861 *
5862 * Therefore, it is possible that the input message length is 0 and the
5863 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005864 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005865MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005866static int ssl_write_real(mbedtls_ssl_context *ssl,
5867 const unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005868{
Gilles Peskine449bd832023-01-11 14:50:10 +01005869 int ret = mbedtls_ssl_get_max_out_record_payload(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005870 const size_t max_len = (size_t) ret;
5871
Gilles Peskine449bd832023-01-11 14:50:10 +01005872 if (ret < 0) {
5873 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_get_max_out_record_payload", ret);
5874 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005875 }
5876
Gilles Peskine449bd832023-01-11 14:50:10 +01005877 if (len > max_len) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005878#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005879 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5880 MBEDTLS_SSL_DEBUG_MSG(1, ("fragment larger than the (negotiated) "
5881 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5882 " > %" MBEDTLS_PRINTF_SIZET,
5883 len, max_len));
5884 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5885 } else
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005886#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005887 len = max_len;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005888 }
Paul Bakker887bd502011-06-08 13:10:54 +00005889
Gilles Peskine449bd832023-01-11 14:50:10 +01005890 if (ssl->out_left != 0) {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005891 /*
5892 * The user has previously tried to send the data and
5893 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5894 * written. In this case, we expect the high-level write function
5895 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5896 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005897 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5898 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
5899 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005900 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005901 } else {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005902 /*
5903 * The user is trying to send a message the first time, so we need to
5904 * copy the data into the internal buffers and setup the data structure
5905 * to keep track of partial writes
5906 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005907 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005908 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Dave Rodgmanf6840252023-02-24 15:41:34 +00005909 if (len > 0) {
5910 memcpy(ssl->out_msg, buf, len);
5911 }
Paul Bakker887bd502011-06-08 13:10:54 +00005912
Gilles Peskine449bd832023-01-11 14:50:10 +01005913 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5914 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5915 return ret;
Paul Bakker887bd502011-06-08 13:10:54 +00005916 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005917 }
5918
Gilles Peskine449bd832023-01-11 14:50:10 +01005919 return (int) len;
Paul Bakker5121ce52009-01-03 21:22:43 +00005920}
5921
5922/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005923 * Write application data (public-facing wrapper)
5924 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005925int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005926{
Janos Follath865b3eb2019-12-16 11:46:15 +00005927 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005928
Gilles Peskine449bd832023-01-11 14:50:10 +01005929 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005930
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 if (ssl == NULL || ssl->conf == NULL) {
5932 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5933 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005934
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005935#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005936 if ((ret = ssl_check_ctr_renegotiate(ssl)) != 0) {
5937 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5938 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005939 }
5940#endif
5941
Gilles Peskine449bd832023-01-11 14:50:10 +01005942 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5943 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
5944 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5945 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005946 }
5947 }
5948
Gilles Peskine449bd832023-01-11 14:50:10 +01005949 ret = ssl_write_real(ssl, buf, len);
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005950
Gilles Peskine449bd832023-01-11 14:50:10 +01005951 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005952
Gilles Peskine449bd832023-01-11 14:50:10 +01005953 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005954}
5955
5956/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005957 * Notify the peer that the connection is being closed
5958 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005959int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005960{
Janos Follath865b3eb2019-12-16 11:46:15 +00005961 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005962
Gilles Peskine449bd832023-01-11 14:50:10 +01005963 if (ssl == NULL || ssl->conf == NULL) {
5964 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5965 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005966
Gilles Peskine449bd832023-01-11 14:50:10 +01005967 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005968
Gilles Peskine449bd832023-01-11 14:50:10 +01005969 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5970 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5971 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5972 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY)) != 0) {
5973 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_send_alert_message", ret);
5974 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005975 }
5976 }
5977
Gilles Peskine449bd832023-01-11 14:50:10 +01005978 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005979
Gilles Peskine449bd832023-01-11 14:50:10 +01005980 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005981}
5982
Gilles Peskine449bd832023-01-11 14:50:10 +01005983void mbedtls_ssl_transform_free(mbedtls_ssl_transform *transform)
Paul Bakker48916f92012-09-16 19:57:18 +00005984{
Gilles Peskine449bd832023-01-11 14:50:10 +01005985 if (transform == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005986 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005987 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005988
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005989#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005990 psa_destroy_key(transform->psa_key_enc);
5991 psa_destroy_key(transform->psa_key_dec);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005992#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005993 mbedtls_cipher_free(&transform->cipher_ctx_enc);
5994 mbedtls_cipher_free(&transform->cipher_ctx_dec);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005995#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005996
Hanno Beckerfd86ca82020-11-30 08:54:23 +00005997#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01005998#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005999 psa_destroy_key(transform->psa_mac_enc);
6000 psa_destroy_key(transform->psa_mac_dec);
Neil Armstrongcf8841a2022-02-24 11:17:45 +01006001#else
Gilles Peskine449bd832023-01-11 14:50:10 +01006002 mbedtls_md_free(&transform->md_ctx_enc);
6003 mbedtls_md_free(&transform->md_ctx_dec);
Neil Armstrongcf8841a2022-02-24 11:17:45 +01006004#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd56ed242018-01-03 15:32:51 +00006005#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02006006
Gilles Peskine449bd832023-01-11 14:50:10 +01006007 mbedtls_platform_zeroize(transform, sizeof(mbedtls_ssl_transform));
Paul Bakker48916f92012-09-16 19:57:18 +00006008}
6009
Gilles Peskine449bd832023-01-11 14:50:10 +01006010void mbedtls_ssl_set_inbound_transform(mbedtls_ssl_context *ssl,
6011 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006012{
Jerry Yuc7875b52021-09-05 21:05:50 +08006013 ssl->transform_in = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006014 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuc7875b52021-09-05 21:05:50 +08006015}
6016
Gilles Peskine449bd832023-01-11 14:50:10 +01006017void mbedtls_ssl_set_outbound_transform(mbedtls_ssl_context *ssl,
6018 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006019{
6020 ssl->transform_out = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yuc7875b52021-09-05 21:05:50 +08006022}
6023
Hanno Becker0271f962018-08-16 13:23:47 +01006024#if defined(MBEDTLS_SSL_PROTO_DTLS)
6025
Gilles Peskine449bd832023-01-11 14:50:10 +01006026void mbedtls_ssl_buffering_free(mbedtls_ssl_context *ssl)
Hanno Becker0271f962018-08-16 13:23:47 +01006027{
6028 unsigned offset;
6029 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6030
Gilles Peskine449bd832023-01-11 14:50:10 +01006031 if (hs == NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01006032 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006033 }
Hanno Becker0271f962018-08-16 13:23:47 +01006034
Gilles Peskine449bd832023-01-11 14:50:10 +01006035 ssl_free_buffered_record(ssl);
Hanno Becker283f5ef2018-08-24 09:34:47 +01006036
Gilles Peskine449bd832023-01-11 14:50:10 +01006037 for (offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
6038 ssl_buffering_free_slot(ssl, offset);
6039 }
Hanno Beckere605b192018-08-21 15:59:07 +01006040}
6041
Gilles Peskine449bd832023-01-11 14:50:10 +01006042static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
6043 uint8_t slot)
Hanno Beckere605b192018-08-21 15:59:07 +01006044{
6045 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6046 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01006047
Gilles Peskine449bd832023-01-11 14:50:10 +01006048 if (slot >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Beckerb309b922018-08-23 13:18:05 +01006049 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006050 }
Hanno Beckerb309b922018-08-23 13:18:05 +01006051
Gilles Peskine449bd832023-01-11 14:50:10 +01006052 if (hs_buf->is_valid == 1) {
Hanno Beckere605b192018-08-21 15:59:07 +01006053 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006054 mbedtls_platform_zeroize(hs_buf->data, hs_buf->data_len);
6055 mbedtls_free(hs_buf->data);
6056 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Hanno Becker0271f962018-08-16 13:23:47 +01006057 }
6058}
6059
6060#endif /* MBEDTLS_SSL_PROTO_DTLS */
6061
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006062/*
6063 * Convert version numbers to/from wire format
6064 * and, for DTLS, to/from TLS equivalent.
6065 *
6066 * For TLS this is the identity.
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006067 * For DTLS, map as follows, then use 1's complement (v -> ~v):
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006068 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006069 * DTLS 1.0 is stored as TLS 1.1 internally
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006070 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006071void mbedtls_ssl_write_version(unsigned char version[2], int transport,
6072 mbedtls_ssl_protocol_version tls_version)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006073{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006074#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006075 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006076 tls_version =
Gilles Peskine449bd832023-01-11 14:50:10 +01006077 ~(tls_version - (tls_version == 0x0302 ? 0x0202 : 0x0201));
6078 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006079#else
6080 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006081#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 MBEDTLS_PUT_UINT16_BE(tls_version, version, 0);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006083}
6084
Gilles Peskine449bd832023-01-11 14:50:10 +01006085uint16_t mbedtls_ssl_read_version(const unsigned char version[2],
6086 int transport)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006087{
Gilles Peskine449bd832023-01-11 14:50:10 +01006088 uint16_t tls_version = MBEDTLS_GET_UINT16_BE(version, 0);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006089#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006090 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006091 tls_version =
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 ~(tls_version - (tls_version == 0xfeff ? 0x0202 : 0x0201));
6093 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006094#else
6095 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006096#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006097 return tls_version;
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006098}
6099
Jerry Yue7047812021-09-13 19:26:39 +08006100/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08006101 * Send pending fatal alert.
6102 * 0, No alert message.
6103 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
6104 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08006105 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006106int mbedtls_ssl_handle_pending_alert(mbedtls_ssl_context *ssl)
Jerry Yue7047812021-09-13 19:26:39 +08006107{
6108 int ret;
6109
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006110 /* No pending alert, return success*/
Gilles Peskine449bd832023-01-11 14:50:10 +01006111 if (ssl->send_alert == 0) {
6112 return 0;
6113 }
Jerry Yu394ece62021-09-14 22:17:21 +08006114
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 ret = mbedtls_ssl_send_alert_message(ssl,
6116 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6117 ssl->alert_type);
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006118
Jerry Yu3bf1f972021-09-22 21:37:18 +08006119 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
6120 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006121 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006122 if (ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006123 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08006124 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006125
Gilles Peskine449bd832023-01-11 14:50:10 +01006126 if (ret != 0) {
6127 return ret;
6128 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006129
Gilles Peskine449bd832023-01-11 14:50:10 +01006130 return ssl->alert_reason;
Jerry Yue7047812021-09-13 19:26:39 +08006131}
6132
Jerry Yu394ece62021-09-14 22:17:21 +08006133/*
6134 * Set pending fatal alert flag.
6135 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006136void mbedtls_ssl_pend_fatal_alert(mbedtls_ssl_context *ssl,
6137 unsigned char alert_type,
6138 int alert_reason)
Jerry Yu394ece62021-09-14 22:17:21 +08006139{
6140 ssl->send_alert = 1;
6141 ssl->alert_type = alert_type;
6142 ssl->alert_reason = alert_reason;
6143}
6144
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006145#endif /* MBEDTLS_SSL_TLS_C */