blob: 47a206dd441188d9fe8edba5735550930b003163 [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)
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020043#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050044#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)
Andrzej Kurek00644842023-05-30 05:45:00 -040052/* Define a local translating function to save code size by not using too many
53 * arguments in each translating place. */
54static int local_err_translation(psa_status_t status)
55{
56 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040057 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040058 psa_generic_status_to_mbedtls);
59}
60#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050061#endif
62
Dave Rodgman2801f7f2023-05-09 11:00:07 +010063#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
64
65#if defined(MBEDTLS_USE_PSA_CRYPTO)
66
67#if defined(PSA_WANT_ALG_SHA_384)
68#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_384)
69#elif defined(PSA_WANT_ALG_SHA_256)
70#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_256)
71#else /* See check_config.h */
72#define MAX_HASH_BLOCK_LENGTH PSA_HASH_BLOCK_LENGTH(PSA_ALG_SHA_1)
73#endif
74
75MBEDTLS_STATIC_TESTABLE
76int mbedtls_ct_hmac(mbedtls_svc_key_id_t key,
77 psa_algorithm_t mac_alg,
78 const unsigned char *add_data,
79 size_t add_data_len,
80 const unsigned char *data,
81 size_t data_len_secret,
82 size_t min_data_len,
83 size_t max_data_len,
84 unsigned char *output)
85{
86 /*
87 * This function breaks the HMAC abstraction and uses psa_hash_clone()
88 * extension in order to get constant-flow behaviour.
89 *
90 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
91 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
92 * patterns (see RFC 2104, sec. 2).
93 *
94 * We'll first compute ikey/okey, then inner_hash = HASH(ikey + msg) by
95 * hashing up to minlen, then cloning the context, and for each byte up
96 * to maxlen finishing up the hash computation, keeping only the
97 * correct result.
98 *
99 * Then we only need to compute HASH(okey + inner_hash) and we're done.
100 */
101 psa_algorithm_t hash_alg = PSA_ALG_HMAC_GET_HASH(mac_alg);
102 const size_t block_size = PSA_HASH_BLOCK_LENGTH(hash_alg);
103 unsigned char key_buf[MAX_HASH_BLOCK_LENGTH];
104 const size_t hash_size = PSA_HASH_LENGTH(hash_alg);
105 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
106 size_t hash_length;
107
108 unsigned char aux_out[PSA_HASH_MAX_SIZE];
109 psa_hash_operation_t aux_operation = PSA_HASH_OPERATION_INIT;
110 size_t offset;
111 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
112
113 size_t mac_key_length;
114 size_t i;
115
116#define PSA_CHK(func_call) \
117 do { \
118 status = (func_call); \
119 if (status != PSA_SUCCESS) \
120 goto cleanup; \
121 } while (0)
122
123 /* Export MAC key
124 * We assume key length is always exactly the output size
125 * which is never more than the block size, thus we use block_size
126 * as the key buffer size.
127 */
128 PSA_CHK(psa_export_key(key, key_buf, block_size, &mac_key_length));
129
130 /* Calculate ikey */
131 for (i = 0; i < mac_key_length; i++) {
132 key_buf[i] = (unsigned char) (key_buf[i] ^ 0x36);
133 }
134 for (; i < block_size; ++i) {
135 key_buf[i] = 0x36;
136 }
137
138 PSA_CHK(psa_hash_setup(&operation, hash_alg));
139
140 /* Now compute inner_hash = HASH(ikey + msg) */
141 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
142 PSA_CHK(psa_hash_update(&operation, add_data, add_data_len));
143 PSA_CHK(psa_hash_update(&operation, data, min_data_len));
144
145 /* Fill the hash buffer in advance with something that is
146 * not a valid hash (barring an attack on the hash and
147 * deliberately-crafted input), in case the caller doesn't
148 * check the return status properly. */
149 memset(output, '!', hash_size);
150
151 /* For each possible length, compute the hash up to that point */
152 for (offset = min_data_len; offset <= max_data_len; offset++) {
153 PSA_CHK(psa_hash_clone(&operation, &aux_operation));
154 PSA_CHK(psa_hash_finish(&aux_operation, aux_out,
155 PSA_HASH_MAX_SIZE, &hash_length));
156 /* Keep only the correct inner_hash in the output buffer */
Dave Rodgman48fb8a32023-08-10 14:01:51 +0100157 mbedtls_ct_memcpy_if(mbedtls_ct_uint_eq(offset, data_len_secret),
Dave Rodgmana81373f2023-05-17 12:36:01 +0100158 output, aux_out, NULL, hash_size);
Dave Rodgman2801f7f2023-05-09 11:00:07 +0100159
160 if (offset < max_data_len) {
161 PSA_CHK(psa_hash_update(&operation, data + offset, 1));
162 }
163 }
164
165 /* Abort current operation to prepare for final operation */
166 PSA_CHK(psa_hash_abort(&operation));
167
168 /* Calculate okey */
169 for (i = 0; i < mac_key_length; i++) {
170 key_buf[i] = (unsigned char) ((key_buf[i] ^ 0x36) ^ 0x5C);
171 }
172 for (; i < block_size; ++i) {
173 key_buf[i] = 0x5C;
174 }
175
176 /* Now compute HASH(okey + inner_hash) */
177 PSA_CHK(psa_hash_setup(&operation, hash_alg));
178 PSA_CHK(psa_hash_update(&operation, key_buf, block_size));
179 PSA_CHK(psa_hash_update(&operation, output, hash_size));
180 PSA_CHK(psa_hash_finish(&operation, output, hash_size, &hash_length));
181
182#undef PSA_CHK
183
184cleanup:
185 mbedtls_platform_zeroize(key_buf, MAX_HASH_BLOCK_LENGTH);
186 mbedtls_platform_zeroize(aux_out, PSA_HASH_MAX_SIZE);
187
188 psa_hash_abort(&operation);
189 psa_hash_abort(&aux_operation);
190 return PSA_TO_MBEDTLS_ERR(status);
191}
192
193#undef MAX_HASH_BLOCK_LENGTH
194
195#else
196MBEDTLS_STATIC_TESTABLE
197int mbedtls_ct_hmac(mbedtls_md_context_t *ctx,
198 const unsigned char *add_data,
199 size_t add_data_len,
200 const unsigned char *data,
201 size_t data_len_secret,
202 size_t min_data_len,
203 size_t max_data_len,
204 unsigned char *output)
205{
206 /*
207 * This function breaks the HMAC abstraction and uses the md_clone()
208 * extension to the MD API in order to get constant-flow behaviour.
209 *
210 * HMAC(msg) is defined as HASH(okey + HASH(ikey + msg)) where + means
211 * concatenation, and okey/ikey are the XOR of the key with some fixed bit
212 * patterns (see RFC 2104, sec. 2), which are stored in ctx->hmac_ctx.
213 *
214 * We'll first compute inner_hash = HASH(ikey + msg) by hashing up to
215 * minlen, then cloning the context, and for each byte up to maxlen
216 * finishing up the hash computation, keeping only the correct result.
217 *
218 * Then we only need to compute HASH(okey + inner_hash) and we're done.
219 */
220 const mbedtls_md_type_t md_alg = mbedtls_md_get_type(ctx->md_info);
221 /* TLS 1.2 only supports SHA-384, SHA-256, SHA-1, MD-5,
222 * all of which have the same block size except SHA-384. */
223 const size_t block_size = md_alg == MBEDTLS_MD_SHA384 ? 128 : 64;
224 const unsigned char * const ikey = ctx->hmac_ctx;
225 const unsigned char * const okey = ikey + block_size;
226 const size_t hash_size = mbedtls_md_get_size(ctx->md_info);
227
228 unsigned char aux_out[MBEDTLS_MD_MAX_SIZE];
229 mbedtls_md_context_t aux;
230 size_t offset;
231 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
232
233 mbedtls_md_init(&aux);
234
235#define MD_CHK(func_call) \
236 do { \
237 ret = (func_call); \
238 if (ret != 0) \
239 goto cleanup; \
240 } while (0)
241
242 MD_CHK(mbedtls_md_setup(&aux, ctx->md_info, 0));
243
244 /* After hmac_start() of hmac_reset(), ikey has already been hashed,
245 * so we can start directly with the message */
246 MD_CHK(mbedtls_md_update(ctx, add_data, add_data_len));
247 MD_CHK(mbedtls_md_update(ctx, data, min_data_len));
248
249 /* Fill the hash buffer in advance with something that is
250 * not a valid hash (barring an attack on the hash and
251 * deliberately-crafted input), in case the caller doesn't
252 * check the return status properly. */
253 memset(output, '!', hash_size);
254
255 /* For each possible length, compute the hash up to that point */
256 for (offset = min_data_len; offset <= max_data_len; offset++) {
257 MD_CHK(mbedtls_md_clone(&aux, ctx));
258 MD_CHK(mbedtls_md_finish(&aux, aux_out));
259 /* Keep only the correct inner_hash in the output buffer */
Dave Rodgmanb7825ce2023-08-10 11:58:18 +0100260 mbedtls_ct_memcpy_if(mbedtls_ct_uint_eq(offset, data_len_secret),
Dave Rodgmana81373f2023-05-17 12:36:01 +0100261 output, aux_out, NULL, hash_size);
Dave Rodgman2801f7f2023-05-09 11:00:07 +0100262
263 if (offset < max_data_len) {
264 MD_CHK(mbedtls_md_update(ctx, data + offset, 1));
265 }
266 }
267
268 /* The context needs to finish() before it starts() again */
269 MD_CHK(mbedtls_md_finish(ctx, aux_out));
270
271 /* Now compute HASH(okey + inner_hash) */
272 MD_CHK(mbedtls_md_starts(ctx));
273 MD_CHK(mbedtls_md_update(ctx, okey, block_size));
274 MD_CHK(mbedtls_md_update(ctx, output, hash_size));
275 MD_CHK(mbedtls_md_finish(ctx, output));
276
277 /* Done, get ready for next time */
278 MD_CHK(mbedtls_md_hmac_reset(ctx));
279
280#undef MD_CHK
281
282cleanup:
283 mbedtls_md_free(&aux);
284 return ret;
285}
286
287#endif /* MBEDTLS_USE_PSA_CRYPTO */
288
289#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
290
Gilles Peskine449bd832023-01-11 14:50:10 +0100291static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl);
Hanno Becker2a43f6f2018-08-10 11:12:52 +0100292
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200293/*
294 * Start a timer.
295 * Passing millisecs = 0 cancels a running timer.
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200296 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100297void mbedtls_ssl_set_timer(mbedtls_ssl_context *ssl, uint32_t millisecs)
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200298{
Gilles Peskine449bd832023-01-11 14:50:10 +0100299 if (ssl->f_set_timer == NULL) {
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +0200300 return;
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 }
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +0200302
Gilles Peskine449bd832023-01-11 14:50:10 +0100303 MBEDTLS_SSL_DEBUG_MSG(3, ("set_timer to %d ms", (int) millisecs));
304 ssl->f_set_timer(ssl->p_timer, millisecs / 4, millisecs);
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200305}
306
307/*
308 * Return -1 is timer is expired, 0 if it isn't.
309 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100310int mbedtls_ssl_check_timer(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200311{
Gilles Peskine449bd832023-01-11 14:50:10 +0100312 if (ssl->f_get_timer == NULL) {
313 return 0;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200314 }
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200315
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 if (ssl->f_get_timer(ssl->p_timer) == 2) {
317 MBEDTLS_SSL_DEBUG_MSG(3, ("timer expired"));
318 return -1;
319 }
320
321 return 0;
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200322}
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200323
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200324MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100325static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
326 unsigned char *buf,
327 size_t len,
328 mbedtls_record *rec);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200329
Gilles Peskine449bd832023-01-11 14:50:10 +0100330int mbedtls_ssl_check_record(mbedtls_ssl_context const *ssl,
331 unsigned char *buf,
332 size_t buflen)
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200333{
334 int ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100335 MBEDTLS_SSL_DEBUG_MSG(1, ("=> mbedtls_ssl_check_record"));
336 MBEDTLS_SSL_DEBUG_BUF(3, "record buffer", buf, buflen);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200337
338 /* We don't support record checking in TLS because
TRodziewicz2abf03c2021-06-25 14:40:09 +0200339 * there doesn't seem to be a usecase for it.
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200340 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100341 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_STREAM) {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200342 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
343 goto exit;
344 }
345#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100346 else {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200347 mbedtls_record rec;
348
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 ret = ssl_parse_record_header(ssl, buf, buflen, &rec);
350 if (ret != 0) {
351 MBEDTLS_SSL_DEBUG_RET(3, "ssl_parse_record_header", ret);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200352 goto exit;
353 }
354
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 if (ssl->transform_in != NULL) {
356 ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in, &rec);
357 if (ret != 0) {
358 MBEDTLS_SSL_DEBUG_RET(3, "mbedtls_ssl_decrypt_buf", ret);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200359 goto exit;
360 }
361 }
362 }
363#endif /* MBEDTLS_SSL_PROTO_DTLS */
364
365exit:
366 /* On success, we have decrypted the buffer in-place, so make
367 * sure we don't leak any plaintext data. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 mbedtls_platform_zeroize(buf, buflen);
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200369
370 /* For the purpose of this API, treat messages with unexpected CID
371 * as well as such from future epochs as unexpected. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID ||
373 ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200374 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
375 }
376
Gilles Peskine449bd832023-01-11 14:50:10 +0100377 MBEDTLS_SSL_DEBUG_MSG(1, ("<= mbedtls_ssl_check_record"));
378 return ret;
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200379}
380
Hanno Becker67bc7c32018-08-06 11:33:50 +0100381#define SSL_DONT_FORCE_FLUSH 0
382#define SSL_FORCE_FLUSH 1
383
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +0200384#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100385
Hanno Beckerd5847772018-08-28 10:09:23 +0100386/* Forward declarations for functions related to message buffering. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100387static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
388 uint8_t slot);
389static void ssl_free_buffered_record(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_load_buffered_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200392MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100393static int ssl_load_buffered_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200394MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100395static int ssl_buffer_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200396MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100397static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
398 mbedtls_record const *rec);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200399MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100400static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl);
Hanno Beckerd5847772018-08-28 10:09:23 +0100401
Gilles Peskine449bd832023-01-11 14:50:10 +0100402static size_t ssl_get_maximum_datagram_size(mbedtls_ssl_context const *ssl)
Hanno Becker2b1e3542018-08-06 11:19:13 +0100403{
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
Darryl Greenb33cc762019-11-28 14:29:44 +0000405#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
406 size_t out_buf_len = ssl->out_buf_len;
407#else
408 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
409#endif
Hanno Becker2b1e3542018-08-06 11:19:13 +0100410
Gilles Peskine449bd832023-01-11 14:50:10 +0100411 if (mtu != 0 && mtu < out_buf_len) {
412 return mtu;
413 }
Hanno Becker2b1e3542018-08-06 11:19:13 +0100414
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 return out_buf_len;
Hanno Becker2b1e3542018-08-06 11:19:13 +0100416}
417
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200418MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100419static int ssl_get_remaining_space_in_datagram(mbedtls_ssl_context const *ssl)
Hanno Becker67bc7c32018-08-06 11:33:50 +0100420{
Hanno Becker11682cc2018-08-22 14:41:02 +0100421 size_t const bytes_written = ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +0100422 size_t const mtu = ssl_get_maximum_datagram_size(ssl);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100423
424 /* Double-check that the write-index hasn't gone
425 * past what we can transmit in a single datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100426 if (bytes_written > mtu) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100427 /* Should never happen... */
Gilles Peskine449bd832023-01-11 14:50:10 +0100428 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100429 }
430
Gilles Peskine449bd832023-01-11 14:50:10 +0100431 return (int) (mtu - bytes_written);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100432}
433
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200434MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100435static int ssl_get_remaining_payload_in_datagram(mbedtls_ssl_context const *ssl)
Hanno Becker67bc7c32018-08-06 11:33:50 +0100436{
Janos Follath865b3eb2019-12-16 11:46:15 +0000437 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100438 size_t remaining, expansion;
Andrzej Kurek748face2018-10-11 07:20:19 -0400439 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100440
441#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +0100442 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Hanno Becker67bc7c32018-08-06 11:33:50 +0100443
Gilles Peskine449bd832023-01-11 14:50:10 +0100444 if (max_len > mfl) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100445 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +0100446 }
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100447
448 /* By the standard (RFC 6066 Sect. 4), the MFL extension
449 * only limits the maximum record payload size, so in theory
450 * we would be allowed to pack multiple records of payload size
451 * MFL into a single datagram. However, this would mean that there's
452 * no way to explicitly communicate MTU restrictions to the peer.
453 *
454 * The following reduction of max_len makes sure that we never
455 * write datagrams larger than MFL + Record Expansion Overhead.
456 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100457 if (max_len <= ssl->out_left) {
458 return 0;
459 }
Hanno Beckerf4b010e2018-08-24 10:47:29 +0100460
461 max_len -= ssl->out_left;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100462#endif
463
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 ret = ssl_get_remaining_space_in_datagram(ssl);
465 if (ret < 0) {
466 return ret;
467 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100468 remaining = (size_t) ret;
469
Gilles Peskine449bd832023-01-11 14:50:10 +0100470 ret = mbedtls_ssl_get_record_expansion(ssl);
471 if (ret < 0) {
472 return ret;
473 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100474 expansion = (size_t) ret;
475
Gilles Peskine449bd832023-01-11 14:50:10 +0100476 if (remaining <= expansion) {
477 return 0;
478 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100479
480 remaining -= expansion;
Gilles Peskine449bd832023-01-11 14:50:10 +0100481 if (remaining >= max_len) {
Hanno Becker67bc7c32018-08-06 11:33:50 +0100482 remaining = max_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 }
Hanno Becker67bc7c32018-08-06 11:33:50 +0100484
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 return (int) remaining;
Hanno Becker67bc7c32018-08-06 11:33:50 +0100486}
487
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200488/*
489 * Double the retransmit timeout value, within the allowed range,
490 * returning -1 if the maximum value has already been reached.
491 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200492MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100493static int ssl_double_retransmit_timeout(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200494{
495 uint32_t new_timeout;
496
Gilles Peskine449bd832023-01-11 14:50:10 +0100497 if (ssl->handshake->retransmit_timeout >= ssl->conf->hs_timeout_max) {
498 return -1;
499 }
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200500
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200501 /* Implement the final paragraph of RFC 6347 section 4.1.1.1
502 * in the following way: after the initial transmission and a first
503 * retransmission, back off to a temporary estimated MTU of 508 bytes.
504 * This value is guaranteed to be deliverable (if not guaranteed to be
505 * delivered) of any compliant IPv4 (and IPv6) network, and should work
506 * on most non-IP stacks too. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 if (ssl->handshake->retransmit_timeout != ssl->conf->hs_timeout_min) {
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200508 ssl->handshake->mtu = 508;
Gilles Peskine449bd832023-01-11 14:50:10 +0100509 MBEDTLS_SSL_DEBUG_MSG(2, ("mtu autoreduction to %d bytes", ssl->handshake->mtu));
Andrzej Kurek6290dae2018-10-05 08:06:01 -0400510 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +0200511
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200512 new_timeout = 2 * ssl->handshake->retransmit_timeout;
513
514 /* Avoid arithmetic overflow and range overflow */
Gilles Peskine449bd832023-01-11 14:50:10 +0100515 if (new_timeout < ssl->handshake->retransmit_timeout ||
516 new_timeout > ssl->conf->hs_timeout_max) {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200517 new_timeout = ssl->conf->hs_timeout_max;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200518 }
519
520 ssl->handshake->retransmit_timeout = new_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +0100521 MBEDTLS_SSL_DEBUG_MSG(3, ("update timeout value to %lu millisecs",
522 (unsigned long) ssl->handshake->retransmit_timeout));
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200523
Gilles Peskine449bd832023-01-11 14:50:10 +0100524 return 0;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200525}
526
Gilles Peskine449bd832023-01-11 14:50:10 +0100527static void ssl_reset_retransmit_timeout(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200528{
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200529 ssl->handshake->retransmit_timeout = ssl->conf->hs_timeout_min;
Gilles Peskine449bd832023-01-11 14:50:10 +0100530 MBEDTLS_SSL_DEBUG_MSG(3, ("update timeout value to %lu millisecs",
531 (unsigned long) ssl->handshake->retransmit_timeout));
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200532}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200533#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200534
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +0100535/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000536 * Encryption/decryption functions
Paul Bakkerf7abd422013-04-16 13:15:56 +0200537 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000538
Ronald Cron6f135e12021-12-08 16:57:54 +0100539#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker13996922020-05-28 16:15:19 +0100540
Gilles Peskine449bd832023-01-11 14:50:10 +0100541static size_t ssl_compute_padding_length(size_t len,
542 size_t granularity)
Hanno Becker13996922020-05-28 16:15:19 +0100543{
Gilles Peskine449bd832023-01-11 14:50:10 +0100544 return (granularity - (len + 1) % granularity) % granularity;
Hanno Becker13996922020-05-28 16:15:19 +0100545}
546
Hanno Becker581bc1b2020-05-04 12:20:03 +0100547/* This functions transforms a (D)TLS plaintext fragment and a record content
548 * type into an instance of the (D)TLSInnerPlaintext structure. This is used
549 * in DTLS 1.2 + CID and within TLS 1.3 to allow flexible padding and to protect
550 * a record's content type.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100551 *
552 * struct {
553 * opaque content[DTLSPlaintext.length];
554 * ContentType real_type;
555 * uint8 zeros[length_of_padding];
Hanno Becker581bc1b2020-05-04 12:20:03 +0100556 * } (D)TLSInnerPlaintext;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100557 *
558 * Input:
559 * - `content`: The beginning of the buffer holding the
560 * plaintext to be wrapped.
561 * - `*content_size`: The length of the plaintext in Bytes.
562 * - `max_len`: The number of Bytes available starting from
563 * `content`. This must be `>= *content_size`.
564 * - `rec_type`: The desired record content type.
565 *
566 * Output:
Hanno Becker581bc1b2020-05-04 12:20:03 +0100567 * - `content`: The beginning of the resulting (D)TLSInnerPlaintext structure.
568 * - `*content_size`: The length of the resulting (D)TLSInnerPlaintext structure.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100569 *
570 * Returns:
571 * - `0` on success.
572 * - A negative error code if `max_len` didn't offer enough space
573 * for the expansion.
574 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200575MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100576static int ssl_build_inner_plaintext(unsigned char *content,
577 size_t *content_size,
578 size_t remaining,
579 uint8_t rec_type,
580 size_t pad)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100581{
582 size_t len = *content_size;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100583
584 /* Write real content type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 if (remaining == 0) {
586 return -1;
587 }
588 content[len] = rec_type;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100589 len++;
590 remaining--;
591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 if (remaining < pad) {
593 return -1;
594 }
595 memset(content + len, 0, pad);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100596 len += pad;
597 remaining -= pad;
598
599 *content_size = len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100600 return 0;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100601}
602
Hanno Becker581bc1b2020-05-04 12:20:03 +0100603/* This function parses a (D)TLSInnerPlaintext structure.
604 * See ssl_build_inner_plaintext() for details. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200605MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100606static int ssl_parse_inner_plaintext(unsigned char const *content,
607 size_t *content_size,
608 uint8_t *rec_type)
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100609{
610 size_t remaining = *content_size;
611
612 /* Determine length of padding by skipping zeroes from the back. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100613 do {
614 if (remaining == 0) {
615 return -1;
616 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100617 remaining--;
Gilles Peskine449bd832023-01-11 14:50:10 +0100618 } while (content[remaining] == 0);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100619
620 *content_size = remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +0100621 *rec_type = content[remaining];
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100622
Gilles Peskine449bd832023-01-11 14:50:10 +0100623 return 0;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100624}
Ronald Cron6f135e12021-12-08 16:57:54 +0100625#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100626
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200627/* The size of the `add_data` structure depends on various
628 * factors, namely
629 *
630 * 1) CID functionality disabled
631 *
632 * additional_data =
633 * 8: seq_num +
634 * 1: type +
635 * 2: version +
636 * 2: length of inner plaintext +
637 *
638 * size = 13 bytes
639 *
640 * 2) CID functionality based on RFC 9146 enabled
641 *
642 * size = 8 + 1 + 1 + 1 + 2 + 2 + 6 + 2 + CID-length
643 * = 23 + CID-length
644 *
645 * 3) CID functionality based on legacy CID version
646 according to draft-ietf-tls-dtls-connection-id-05
647 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
648 *
649 * size = 13 + 1 + CID-length
650 *
651 * More information about the CID usage:
652 *
653 * Per Section 5.3 of draft-ietf-tls-dtls-connection-id-05 the
654 * size of the additional data structure is calculated as:
655 *
656 * additional_data =
657 * 8: seq_num +
658 * 1: tls12_cid +
659 * 2: DTLSCipherText.version +
660 * n: cid +
661 * 1: cid_length +
662 * 2: length_of_DTLSInnerPlaintext
663 *
664 * Per RFC 9146 the size of the add_data structure is calculated as:
665 *
666 * additional_data =
667 * 8: seq_num_placeholder +
668 * 1: tls12_cid +
669 * 1: cid_length +
670 * 1: tls12_cid +
671 * 2: DTLSCiphertext.version +
672 * 2: epoch +
673 * 6: sequence_number +
674 * n: cid +
675 * 2: length_of_DTLSInnerPlaintext
676 *
677 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100678static void ssl_extract_add_data_from_record(unsigned char *add_data,
679 size_t *add_data_len,
680 mbedtls_record *rec,
681 mbedtls_ssl_protocol_version
682 tls_version,
683 size_t taglen)
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000684{
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200685 /* Several types of ciphers have been defined for use with TLS and DTLS,
686 * and the MAC calculations for those ciphers differ slightly. Further
687 * variants were added when the CID functionality was added with RFC 9146.
688 * This implementations also considers the use of a legacy version of the
689 * CID specification published in draft-ietf-tls-dtls-connection-id-05,
690 * which is used in deployments.
691 *
692 * We will distinguish between the non-CID and the CID cases below.
693 *
694 * --- Non-CID cases ---
695 *
696 * Quoting RFC 5246 (TLS 1.2):
Hanno Beckercab87e62019-04-29 13:52:53 +0100697 *
698 * additional_data = seq_num + TLSCompressed.type +
699 * TLSCompressed.version + TLSCompressed.length;
700 *
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100701 * For TLS 1.3, the record sequence number is dropped from the AAD
702 * and encoded within the nonce of the AEAD operation instead.
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000703 * Moreover, the additional data involves the length of the TLS
704 * ciphertext, not the TLS plaintext as in earlier versions.
705 * Quoting RFC 8446 (TLS 1.3):
706 *
707 * additional_data = TLSCiphertext.opaque_type ||
708 * TLSCiphertext.legacy_record_version ||
709 * TLSCiphertext.length
710 *
711 * We pass the tag length to this function in order to compute the
712 * ciphertext length from the inner plaintext length rec->data_len via
713 *
714 * TLSCiphertext.length = TLSInnerPlaintext.length + taglen.
715 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200716 * --- CID cases ---
717 *
718 * RFC 9146 uses a common pattern when constructing the data
719 * passed into a MAC / AEAD cipher.
720 *
721 * Data concatenation for MACs used with block ciphers with
722 * Encrypt-then-MAC Processing (with CID):
723 *
724 * data = seq_num_placeholder +
725 * tls12_cid +
726 * cid_length +
727 * tls12_cid +
728 * DTLSCiphertext.version +
729 * epoch +
730 * sequence_number +
731 * cid +
732 * DTLSCiphertext.length +
733 * IV +
734 * ENC(content + padding + padding_length)
735 *
736 * Data concatenation for MACs used with block ciphers (with CID):
737 *
738 * data = seq_num_placeholder +
739 * tls12_cid +
740 * cid_length +
741 * tls12_cid +
742 * DTLSCiphertext.version +
743 * epoch +
744 * sequence_number +
745 * cid +
746 * length_of_DTLSInnerPlaintext +
747 * DTLSInnerPlaintext.content +
748 * DTLSInnerPlaintext.real_type +
749 * DTLSInnerPlaintext.zeros
750 *
751 * AEAD ciphers use the following additional data calculation (with CIDs):
752 *
753 * additional_data = seq_num_placeholder +
754 * tls12_cid +
755 * cid_length +
756 * tls12_cid +
757 * DTLSCiphertext.version +
758 * epoch +
759 * sequence_number +
760 * cid +
761 * length_of_DTLSInnerPlaintext
762 *
763 * Section 5.3 of draft-ietf-tls-dtls-connection-id-05 (for legacy CID use)
764 * defines the additional data calculation as follows:
765 *
766 * additional_data = seq_num +
767 * tls12_cid +
768 * DTLSCipherText.version +
769 * cid +
770 * cid_length +
771 * length_of_DTLSInnerPlaintext
Gilles Peskine449bd832023-01-11 14:50:10 +0100772 */
Hanno Beckercab87e62019-04-29 13:52:53 +0100773
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100774 unsigned char *cur = add_data;
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000775 size_t ad_len_field = rec->data_len;
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100776
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200777#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
778 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
779 const unsigned char seq_num_placeholder[] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
780#endif
781
Ronald Cron6f135e12021-12-08 16:57:54 +0100782#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000784 /* In TLS 1.3, the AAD contains the length of the TLSCiphertext,
785 * which differs from the length of the TLSInnerPlaintext
786 * by the length of the authentication tag. */
787 ad_len_field += taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +0100788 } else
Ronald Cron6f135e12021-12-08 16:57:54 +0100789#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100790 {
Glenn Strauss07c64162022-03-14 12:34:51 -0400791 ((void) tls_version);
Hanno Becker79e2d1b2021-03-22 11:42:19 +0000792 ((void) taglen);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200793
Manuel Pégourié-Gonnard61336842022-11-25 11:12:38 +0100794#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
796 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200797 // seq_num_placeholder
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 memcpy(cur, seq_num_placeholder, sizeof(seq_num_placeholder));
799 cur += sizeof(seq_num_placeholder);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200800
801 // tls12_cid type
802 *cur = rec->type;
803 cur++;
804
805 // cid_length
806 *cur = rec->cid_len;
807 cur++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100808 } else
Manuel Pégourié-Gonnard61336842022-11-25 11:12:38 +0100809#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200810 {
811 // epoch + sequence number
Gilles Peskine449bd832023-01-11 14:50:10 +0100812 memcpy(cur, rec->ctr, sizeof(rec->ctr));
813 cur += sizeof(rec->ctr);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200814 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100815 }
816
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200817 // type
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100818 *cur = rec->type;
819 cur++;
820
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200821 // version
Gilles Peskine449bd832023-01-11 14:50:10 +0100822 memcpy(cur, rec->ver, sizeof(rec->ver));
823 cur += sizeof(rec->ver);
Hanno Beckercab87e62019-04-29 13:52:53 +0100824
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200825#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
826 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 1
827
Gilles Peskine449bd832023-01-11 14:50:10 +0100828 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200829 // CID
830 memcpy(cur, rec->cid, rec->cid_len);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100831 cur += rec->cid_len;
832
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200833 // cid_length
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100834 *cur = rec->cid_len;
835 cur++;
836
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200837 // length of inner plaintext
838 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
839 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100840 } else
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200841#elif defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
842 MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
843
Gilles Peskine449bd832023-01-11 14:50:10 +0100844 if (rec->cid_len != 0) {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200845 // epoch + sequence number
846 memcpy(cur, rec->ctr, sizeof(rec->ctr));
847 cur += sizeof(rec->ctr);
848
849 // CID
Gilles Peskine449bd832023-01-11 14:50:10 +0100850 memcpy(cur, rec->cid, rec->cid_len);
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200851 cur += rec->cid_len;
852
853 // length of inner plaintext
Gilles Peskine449bd832023-01-11 14:50:10 +0100854 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100855 cur += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100856 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +0100857#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100858 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100859 MBEDTLS_PUT_UINT16_BE(ad_len_field, cur, 0);
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100860 cur += 2;
Hanno Becker95e4bbc2019-05-09 11:38:24 +0100861 }
Hanno Becker1cb6c2a2020-05-21 15:25:21 +0100862
863 *add_data_len = cur - add_data;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000864}
865
Hanno Becker67a37db2020-05-28 16:27:07 +0100866#if defined(MBEDTLS_GCM_C) || \
867 defined(MBEDTLS_CCM_C) || \
868 defined(MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200869MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker17263802020-05-28 07:05:48 +0100870static int ssl_transform_aead_dynamic_iv_is_explicit(
Gilles Peskine449bd832023-01-11 14:50:10 +0100871 mbedtls_ssl_transform const *transform)
Hanno Beckerdf8be222020-05-21 15:30:57 +0100872{
Gilles Peskine449bd832023-01-11 14:50:10 +0100873 return transform->ivlen != transform->fixed_ivlen;
Hanno Beckerdf8be222020-05-21 15:30:57 +0100874}
875
Hanno Becker17263802020-05-28 07:05:48 +0100876/* Compute IV := ( fixed_iv || 0 ) XOR ( 0 || dynamic_IV )
877 *
878 * Concretely, this occurs in two variants:
879 *
880 * a) Fixed and dynamic IV lengths add up to total IV length, giving
881 * IV = fixed_iv || dynamic_iv
882 *
Hanno Becker15952812020-06-04 13:31:46 +0100883 * This variant is used in TLS 1.2 when used with GCM or CCM.
884 *
Hanno Becker17263802020-05-28 07:05:48 +0100885 * b) Fixed IV lengths matches total IV length, giving
886 * IV = fixed_iv XOR ( 0 || dynamic_iv )
Hanno Becker15952812020-06-04 13:31:46 +0100887 *
888 * This variant occurs in TLS 1.3 and for TLS 1.2 when using ChaChaPoly.
889 *
890 * See also the documentation of mbedtls_ssl_transform.
Hanno Beckerf486e282020-06-04 13:33:08 +0100891 *
892 * This function has the precondition that
893 *
894 * dst_iv_len >= max( fixed_iv_len, dynamic_iv_len )
895 *
896 * which has to be ensured by the caller. If this precondition
897 * violated, the behavior of this function is undefined.
Hanno Becker17263802020-05-28 07:05:48 +0100898 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100899static void ssl_build_record_nonce(unsigned char *dst_iv,
900 size_t dst_iv_len,
901 unsigned char const *fixed_iv,
902 size_t fixed_iv_len,
903 unsigned char const *dynamic_iv,
904 size_t dynamic_iv_len)
Hanno Becker17263802020-05-28 07:05:48 +0100905{
Hanno Beckerdf8be222020-05-21 15:30:57 +0100906 /* Start with Fixed IV || 0 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100907 memset(dst_iv, 0, dst_iv_len);
908 memcpy(dst_iv, fixed_iv, fixed_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100909
Hanno Becker17263802020-05-28 07:05:48 +0100910 dst_iv += dst_iv_len - dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100911 mbedtls_xor(dst_iv, dst_iv, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +0100912}
Hanno Becker67a37db2020-05-28 16:27:07 +0100913#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Hanno Beckerdf8be222020-05-21 15:30:57 +0100914
Gilles Peskine449bd832023-01-11 14:50:10 +0100915int mbedtls_ssl_encrypt_buf(mbedtls_ssl_context *ssl,
916 mbedtls_ssl_transform *transform,
917 mbedtls_record *rec,
918 int (*f_rng)(void *, unsigned char *, size_t),
919 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +0000920{
Neil Armstrong136f8402022-03-30 10:58:01 +0200921 mbedtls_ssl_mode_t ssl_mode;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100922 int auth_done = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100923 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200924 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +0100925 * the description of ssl_extract_add_data_from_record().
926 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200927#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
928 unsigned char add_data[23 + MBEDTLS_SSL_CID_OUT_LEN_MAX];
929#else
930 unsigned char add_data[13];
931#endif
Hanno Beckercab87e62019-04-29 13:52:53 +0100932 size_t add_data_len;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000933 size_t post_avail;
934
935 /* The SSL context is only used for debugging purposes! */
Hanno Beckera18d1322018-01-03 14:27:32 +0000936#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +0200937 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000938 ((void) ssl);
939#endif
940
941 /* The PRNG is used for dynamic IV generation that's used
TRodziewicz0f82ec62021-05-12 17:49:18 +0200942 * for CBC transformations in TLS 1.2. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100943#if !(defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
944 defined(MBEDTLS_SSL_PROTO_TLS1_2))
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000945 ((void) f_rng);
946 ((void) p_rng);
947#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000948
Gilles Peskine449bd832023-01-11 14:50:10 +0100949 MBEDTLS_SSL_DEBUG_MSG(2, ("=> encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +0000950
Gilles Peskine449bd832023-01-11 14:50:10 +0100951 if (transform == NULL) {
952 MBEDTLS_SSL_DEBUG_MSG(1, ("no transform provided to encrypt_buf"));
953 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000954 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 if (rec == NULL
Hanno Becker43c24b82019-05-01 09:45:57 +0100956 || rec->buf == NULL
957 || rec->buf_len < rec->data_offset
958 || rec->buf_len - rec->data_offset < rec->data_len
Hanno Beckera0e20d02019-05-15 14:03:01 +0100959#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +0100960 || rec->cid_len != 0
961#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100962 ) {
963 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to encrypt_buf"));
964 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +0100965 }
966
Gilles Peskine449bd832023-01-11 14:50:10 +0100967 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Neil Armstrong136f8402022-03-30 10:58:01 +0200968
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000969 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +0100970 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
971 MBEDTLS_SSL_DEBUG_BUF(4, "before encrypt: output payload",
972 data, rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000973
Gilles Peskine449bd832023-01-11 14:50:10 +0100974 if (rec->data_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
975 MBEDTLS_SSL_DEBUG_MSG(1, ("Record content %" MBEDTLS_PRINTF_SIZET
976 " too large, maximum %" MBEDTLS_PRINTF_SIZET,
977 rec->data_len,
978 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
979 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000980 }
Manuel Pégourié-Gonnard60346be2014-11-21 11:38:37 +0100981
Hanno Becker92313402020-05-20 13:58:58 +0100982 /* The following two code paths implement the (D)TLSInnerPlaintext
983 * structure present in TLS 1.3 and DTLS 1.2 + CID.
984 *
985 * See ssl_build_inner_plaintext() for more information.
986 *
987 * Note that this changes `rec->data_len`, and hence
988 * `post_avail` needs to be recalculated afterwards.
989 *
990 * Note also that the two code paths cannot occur simultaneously
991 * since they apply to different versions of the protocol. There
992 * is hence no risk of double-addition of the inner plaintext.
993 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100994#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Becker13996922020-05-28 16:15:19 +0100996 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +0100997 ssl_compute_padding_length(rec->data_len,
998 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
999 if (ssl_build_inner_plaintext(data,
1000 &rec->data_len,
1001 post_avail,
1002 rec->type,
1003 padding) != 0) {
1004 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerccc13d02020-05-04 12:30:04 +01001005 }
1006
1007 rec->type = MBEDTLS_SSL_MSG_APPLICATION_DATA;
1008 }
Ronald Cron6f135e12021-12-08 16:57:54 +01001009#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01001010
Hanno Beckera0e20d02019-05-15 14:03:01 +01001011#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001012 /*
1013 * Add CID information
1014 */
1015 rec->cid_len = transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 memcpy(rec->cid, transform->out_cid, transform->out_cid_len);
1017 MBEDTLS_SSL_DEBUG_BUF(3, "CID", rec->cid, rec->cid_len);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001018
Gilles Peskine449bd832023-01-11 14:50:10 +01001019 if (rec->cid_len != 0) {
Hanno Becker13996922020-05-28 16:15:19 +01001020 size_t padding =
Gilles Peskine449bd832023-01-11 14:50:10 +01001021 ssl_compute_padding_length(rec->data_len,
1022 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001023 /*
Hanno Becker07dc97d2019-05-20 15:08:01 +01001024 * Wrap plaintext into DTLSInnerPlaintext structure.
Hanno Becker581bc1b2020-05-04 12:20:03 +01001025 * See ssl_build_inner_plaintext() for more information.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001026 *
Hanno Becker07dc97d2019-05-20 15:08:01 +01001027 * Note that this changes `rec->data_len`, and hence
1028 * `post_avail` needs to be recalculated afterwards.
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001029 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001030 if (ssl_build_inner_plaintext(data,
1031 &rec->data_len,
1032 post_avail,
1033 rec->type,
1034 padding) != 0) {
1035 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001036 }
1037
1038 rec->type = MBEDTLS_SSL_MSG_CID;
1039 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001040#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001041
Gilles Peskine449bd832023-01-11 14:50:10 +01001042 post_avail = rec->buf_len - (rec->data_len + rec->data_offset);
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01001043
Paul Bakker5121ce52009-01-03 21:22:43 +00001044 /*
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01001045 * Add MAC before if needed
Paul Bakker5121ce52009-01-03 21:22:43 +00001046 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001047#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001048 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
1049 ssl_mode == MBEDTLS_SSL_MODE_CBC) {
1050 if (post_avail < transform->maclen) {
1051 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1052 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001053 }
TRodziewicz0f82ec62021-05-12 17:49:18 +02001054#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001055 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001056 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Neil Armstrong26e6d672022-02-23 09:30:33 +01001057#if defined(MBEDTLS_USE_PSA_CRYPTO)
1058 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1059 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1060 size_t sign_mac_length = 0;
1061#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker992b6872017-11-09 18:57:39 +00001062
Gilles Peskine449bd832023-01-11 14:50:10 +01001063 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1064 transform->tls_version,
1065 transform->taglen);
Hanno Becker992b6872017-11-09 18:57:39 +00001066
Neil Armstrong26e6d672022-02-23 09:30:33 +01001067#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001068 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1069 transform->psa_mac_alg);
1070 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001071 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001072 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001073
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 status = psa_mac_update(&operation, add_data, add_data_len);
1075 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001076 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001077 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001078
Gilles Peskine449bd832023-01-11 14:50:10 +01001079 status = psa_mac_update(&operation, data, rec->data_len);
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
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1085 &sign_mac_length);
1086 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001087 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001088 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001089#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, add_data,
1091 add_data_len);
1092 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001093 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 }
1095 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, data, rec->data_len);
1096 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001097 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 }
1099 ret = mbedtls_md_hmac_finish(&transform->md_ctx_enc, mac);
1100 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001101 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 }
1103 ret = mbedtls_md_hmac_reset(&transform->md_ctx_enc);
1104 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001105 goto hmac_failed_etm_disabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001107#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001108
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 memcpy(data + rec->data_len, mac, transform->maclen);
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001110#endif
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001111
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 MBEDTLS_SSL_DEBUG_BUF(4, "computed mac", data + rec->data_len,
1113 transform->maclen);
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001114
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001115 rec->data_len += transform->maclen;
1116 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001117 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001118
Gilles Peskine449bd832023-01-11 14:50:10 +01001119hmac_failed_etm_disabled:
1120 mbedtls_platform_zeroize(mac, transform->maclen);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001121#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001122 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 status = psa_mac_abort(&operation);
1124 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001125 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 }
Neil Armstrong4313f552022-03-02 15:14:07 +01001127#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 if (ret != 0) {
1129 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_hmac_xxx", ret);
1130 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001131 }
Paul Bakker577e0062013-08-28 11:57:20 +02001132 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001133#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Paul Bakker5121ce52009-01-03 21:22:43 +00001134
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02001135 /*
1136 * Encrypt
1137 */
Hanno Beckerd086bf02021-03-22 13:01:27 +00001138#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001139 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
1140 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1141 "including %d bytes of padding",
1142 rec->data_len, 0));
Paul Bakker5121ce52009-01-03 21:22:43 +00001143
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001144 /* The only supported stream cipher is "NULL",
1145 * so there's nothing to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001146 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001147#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001148
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001149#if defined(MBEDTLS_GCM_C) || \
1150 defined(MBEDTLS_CCM_C) || \
1151 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001153 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001154 unsigned char *dynamic_iv;
1155 size_t dynamic_iv_len;
Hanno Becker17263802020-05-28 07:05:48 +01001156 int dynamic_iv_is_explicit =
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 ssl_transform_aead_dynamic_iv_is_explicit(transform);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001158#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001159 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001160#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001161 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001162
Hanno Beckerbd5ed1d2020-05-21 15:26:39 +01001163 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 if (post_avail < transform->taglen) {
1165 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1166 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001167 }
Paul Bakkerca4ab492012-04-18 14:23:57 +00001168
Paul Bakker68884e32013-01-07 18:20:04 +01001169 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001170 * Build nonce for AEAD encryption.
1171 *
1172 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1173 * part of the IV is prepended to the ciphertext and
1174 * can be chosen freely - in particular, it need not
1175 * agree with the record sequence number.
1176 * However, since ChaChaPoly as well as all AEAD modes
1177 * in TLS 1.3 use the record sequence number as the
1178 * dynamic part of the nonce, we uniformly use the
1179 * record sequence number here in all cases.
Paul Bakker68884e32013-01-07 18:20:04 +01001180 */
Hanno Beckerdf8be222020-05-21 15:30:57 +01001181 dynamic_iv = rec->ctr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 dynamic_iv_len = sizeof(rec->ctr);
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001183
Gilles Peskine449bd832023-01-11 14:50:10 +01001184 ssl_build_record_nonce(iv, sizeof(iv),
1185 transform->iv_enc,
1186 transform->fixed_ivlen,
1187 dynamic_iv,
1188 dynamic_iv_len);
Manuel Pégourié-Gonnardd056ce02014-10-29 22:29:20 +01001189
Hanno Becker1cb6c2a2020-05-21 15:25:21 +01001190 /*
1191 * Build additional data for AEAD encryption.
1192 * This depends on the TLS version.
1193 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1195 transform->tls_version,
1196 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001197
Gilles Peskine449bd832023-01-11 14:50:10 +01001198 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (internal)",
1199 iv, transform->ivlen);
1200 MBEDTLS_SSL_DEBUG_BUF(4, "IV used (transmitted)",
1201 dynamic_iv,
1202 dynamic_iv_is_explicit ? dynamic_iv_len : 0);
1203 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1204 add_data, add_data_len);
1205 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1206 "including 0 bytes of padding",
1207 rec->data_len));
Paul Bakkerca4ab492012-04-18 14:23:57 +00001208
Paul Bakker68884e32013-01-07 18:20:04 +01001209 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001210 * Encrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001211 */
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001212#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 status = psa_aead_encrypt(transform->psa_key_enc,
1214 transform->psa_alg,
1215 iv, transform->ivlen,
1216 add_data, add_data_len,
1217 data, rec->data_len,
1218 data, rec->buf_len - (data - rec->buf),
1219 &rec->data_len);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001220
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001222 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001223 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_encrypt_buf", ret);
1224 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001225 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001226#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001227 if ((ret = mbedtls_cipher_auth_encrypt_ext(&transform->cipher_ctx_enc,
1228 iv, transform->ivlen,
1229 add_data, add_data_len,
1230 data, rec->data_len, /* src */
1231 data, rec->buf_len - (data - rec->buf), /* dst */
1232 &rec->data_len,
1233 transform->taglen)) != 0) {
1234 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_auth_encrypt_ext", ret);
1235 return ret;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001236 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001237#endif /* MBEDTLS_USE_PSA_CRYPTO */
1238
Gilles Peskine449bd832023-01-11 14:50:10 +01001239 MBEDTLS_SSL_DEBUG_BUF(4, "after encrypt: tag",
1240 data + rec->data_len - transform->taglen,
1241 transform->taglen);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001242 /* Account for authentication tag. */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001243 post_avail -= transform->taglen;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001244
1245 /*
1246 * Prefix record content with dynamic IV in case it is explicit.
1247 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 if (dynamic_iv_is_explicit != 0) {
1249 if (rec->data_offset < dynamic_iv_len) {
1250 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1251 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001252 }
1253
Gilles Peskine449bd832023-01-11 14:50:10 +01001254 memcpy(data - dynamic_iv_len, dynamic_iv, dynamic_iv_len);
Hanno Beckerdf8be222020-05-21 15:30:57 +01001255 rec->data_offset -= dynamic_iv_len;
1256 rec->data_len += dynamic_iv_len;
1257 }
1258
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001259 auth_done++;
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 } else
Hanno Beckerc3f7b0b2020-05-28 16:27:16 +01001261#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001262#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001263 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1264 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00001265 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001266 size_t padlen, i;
1267 size_t olen;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001268#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001269 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001270 size_t part_len;
1271 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1272#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001273
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001274 /* Currently we're always using minimal padding
1275 * (up to 255 bytes would be allowed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001276 padlen = transform->ivlen - (rec->data_len + 1) % transform->ivlen;
1277 if (padlen == transform->ivlen) {
Paul Bakker5121ce52009-01-03 21:22:43 +00001278 padlen = 0;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001279 }
1280
Gilles Peskine449bd832023-01-11 14:50:10 +01001281 /* Check there's enough space in the buffer for the padding. */
1282 if (post_avail < padlen + 1) {
1283 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1284 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1285 }
1286
1287 for (i = 0; i <= padlen; i++) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001288 data[rec->data_len + i] = (unsigned char) padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001289 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001290
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001291 rec->data_len += padlen + 1;
1292 post_avail -= padlen + 1;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001293
TRodziewicz0f82ec62021-05-12 17:49:18 +02001294#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001295 /*
TRodziewicz2d8800e2021-05-13 19:14:19 +02001296 * Prepend per-record IV for block cipher in TLS v1.2 as per
Paul Bakker1ef83d62012-04-11 12:09:53 +00001297 * Method 1 (6.2.3.2. in RFC4346 and RFC5246)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001298 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001299 if (f_rng == NULL) {
1300 MBEDTLS_SSL_DEBUG_MSG(1, ("No PRNG provided to encrypt_record routine"));
1301 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001302 }
TRodziewicz345165c2021-07-06 13:42:11 +02001303
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 if (rec->data_offset < transform->ivlen) {
1305 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1306 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
TRodziewicz345165c2021-07-06 13:42:11 +02001307 }
1308
1309 /*
1310 * Generate IV
1311 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001312 ret = f_rng(p_rng, transform->iv_enc, transform->ivlen);
1313 if (ret != 0) {
1314 return ret;
1315 }
TRodziewicz345165c2021-07-06 13:42:11 +02001316
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 memcpy(data - transform->ivlen, transform->iv_enc, transform->ivlen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001318#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001319
Gilles Peskine449bd832023-01-11 14:50:10 +01001320 MBEDTLS_SSL_DEBUG_MSG(3, ("before encrypt: msglen = %" MBEDTLS_PRINTF_SIZET ", "
1321 "including %"
1322 MBEDTLS_PRINTF_SIZET
1323 " bytes of IV and %" MBEDTLS_PRINTF_SIZET " bytes of padding",
1324 rec->data_len, transform->ivlen,
1325 padlen + 1));
Paul Bakker5121ce52009-01-03 21:22:43 +00001326
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001327#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001328 status = psa_cipher_encrypt_setup(&cipher_op,
1329 transform->psa_key_enc, transform->psa_alg);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001330
Gilles Peskine449bd832023-01-11 14:50:10 +01001331 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001332 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_encrypt_setup", ret);
1334 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001335 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001336
Gilles Peskine449bd832023-01-11 14:50:10 +01001337 status = psa_cipher_set_iv(&cipher_op, transform->iv_enc, transform->ivlen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001338
Gilles Peskine449bd832023-01-11 14:50:10 +01001339 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001340 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001341 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1342 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001343
1344 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001345
Gilles Peskine449bd832023-01-11 14:50:10 +01001346 status = psa_cipher_update(&cipher_op,
1347 data, rec->data_len,
1348 data, rec->data_len, &olen);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001349
Gilles Peskine449bd832023-01-11 14:50:10 +01001350 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001351 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1353 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001354
1355 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001356
Gilles Peskine449bd832023-01-11 14:50:10 +01001357 status = psa_cipher_finish(&cipher_op,
1358 data + olen, rec->data_len - olen,
1359 &part_len);
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001360
Gilles Peskine449bd832023-01-11 14:50:10 +01001361 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001362 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001363 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1364 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001365
1366 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001367
1368 olen += part_len;
1369#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001370 if ((ret = mbedtls_cipher_crypt(&transform->cipher_ctx_enc,
1371 transform->iv_enc,
1372 transform->ivlen,
1373 data, rec->data_len,
1374 data, &olen)) != 0) {
1375 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_crypt", ret);
1376 return ret;
Paul Bakkercca5b812013-08-31 17:40:26 +02001377 }
Przemyslaw Stekielb37fae12022-01-13 14:28:44 +01001378#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001379
Gilles Peskine449bd832023-01-11 14:50:10 +01001380 if (rec->data_len != olen) {
1381 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1382 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001383 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001384
TRodziewicz0f82ec62021-05-12 17:49:18 +02001385 data -= transform->ivlen;
1386 rec->data_offset -= transform->ivlen;
1387 rec->data_len += transform->ivlen;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001388
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001389#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001390 if (auth_done == 0) {
Hanno Becker3d8c9072018-01-05 16:24:22 +00001391 unsigned char mac[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001392#if defined(MBEDTLS_USE_PSA_CRYPTO)
1393 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1394 size_t sign_mac_length = 0;
1395#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Becker3d8c9072018-01-05 16:24:22 +00001396
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001397 /* MAC(MAC_write_key, add_data, IV, ENC(content + padding + padding_length))
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001398 */
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001399
Gilles Peskine449bd832023-01-11 14:50:10 +01001400 if (post_avail < transform->maclen) {
1401 MBEDTLS_SSL_DEBUG_MSG(1, ("Buffer provided for encrypted record not large enough"));
1402 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001403 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001404
Gilles Peskine449bd832023-01-11 14:50:10 +01001405 ssl_extract_add_data_from_record(add_data, &add_data_len,
1406 rec, transform->tls_version,
1407 transform->taglen);
Hanno Becker1f10d762019-04-26 13:34:37 +01001408
Gilles Peskine449bd832023-01-11 14:50:10 +01001409 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
1410 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1411 add_data_len);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001412#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 status = psa_mac_sign_setup(&operation, transform->psa_mac_enc,
1414 transform->psa_mac_alg);
1415 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001416 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001417 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001418
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 status = psa_mac_update(&operation, add_data, add_data_len);
1420 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001421 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001422 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001423
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 status = psa_mac_update(&operation, data, rec->data_len);
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
Gilles Peskine449bd832023-01-11 14:50:10 +01001429 status = psa_mac_sign_finish(&operation, mac, MBEDTLS_SSL_MAC_ADD,
1430 &sign_mac_length);
1431 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001432 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001434#else
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001435
Gilles Peskine449bd832023-01-11 14:50:10 +01001436 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc, add_data,
1437 add_data_len);
1438 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001439 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001440 }
1441 ret = mbedtls_md_hmac_update(&transform->md_ctx_enc,
1442 data, rec->data_len);
1443 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001444 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 }
1446 ret = mbedtls_md_hmac_finish(&transform->md_ctx_enc, mac);
1447 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001448 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001449 }
1450 ret = mbedtls_md_hmac_reset(&transform->md_ctx_enc);
1451 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001452 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001454#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001455
Gilles Peskine449bd832023-01-11 14:50:10 +01001456 memcpy(data + rec->data_len, mac, transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001457
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001458 rec->data_len += transform->maclen;
1459 post_avail -= transform->maclen;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001460 auth_done++;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001461
Gilles Peskine449bd832023-01-11 14:50:10 +01001462hmac_failed_etm_enabled:
1463 mbedtls_platform_zeroize(mac, transform->maclen);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001464#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001465 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001466 status = psa_mac_abort(&operation);
1467 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001468 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001469 }
Neil Armstrong4313f552022-03-02 15:14:07 +01001470#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001471 if (ret != 0) {
1472 MBEDTLS_SSL_DEBUG_RET(1, "HMAC calculation failed", ret);
1473 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001474 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001475 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001476#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01001477 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001478#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC) */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001479 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001480 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1481 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001482 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001483
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001484 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01001485 if (auth_done != 1) {
1486 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1487 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001488 }
1489
Gilles Peskine449bd832023-01-11 14:50:10 +01001490 MBEDTLS_SSL_DEBUG_MSG(2, ("<= encrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00001491
Gilles Peskine449bd832023-01-11 14:50:10 +01001492 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001493}
1494
Gilles Peskine449bd832023-01-11 14:50:10 +01001495int mbedtls_ssl_decrypt_buf(mbedtls_ssl_context const *ssl,
1496 mbedtls_ssl_transform *transform,
1497 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00001498{
Przemek Stekiel4c499272022-09-27 13:55:37 +02001499#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) || defined(MBEDTLS_CIPHER_MODE_AEAD)
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001500 size_t olen;
Przemek Stekiel4c499272022-09-27 13:55:37 +02001501#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC || MBEDTLS_CIPHER_MODE_AEAD */
Neil Armstrong136f8402022-03-30 10:58:01 +02001502 mbedtls_ssl_mode_t ssl_mode;
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001503 int ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001504
Przemyslaw Stekielb97556e2022-02-01 14:52:19 +01001505 int auth_done = 0;
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001506#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001507 size_t padlen = 0;
1508 mbedtls_ct_condition_t correct = MBEDTLS_CT_TRUE;
Paul Bakker1e5369c2013-12-19 16:40:57 +01001509#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 unsigned char *data;
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001511 /* For an explanation of the additional data length see
Gilles Peskine449bd832023-01-11 14:50:10 +01001512 * the description of ssl_extract_add_data_from_record().
1513 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001514#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1515 unsigned char add_data[23 + MBEDTLS_SSL_CID_IN_LEN_MAX];
1516#else
1517 unsigned char add_data[13];
1518#endif
Hanno Beckercab87e62019-04-29 13:52:53 +01001519 size_t add_data_len;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001520
Hanno Beckera18d1322018-01-03 14:27:32 +00001521#if !defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnarda7505d12019-05-07 10:17:56 +02001522 ssl = NULL; /* make sure we don't use it except for debug */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001523 ((void) ssl);
1524#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001525
Gilles Peskine449bd832023-01-11 14:50:10 +01001526 MBEDTLS_SSL_DEBUG_MSG(2, ("=> decrypt buf"));
1527 if (rec == NULL ||
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001528 rec->buf == NULL ||
1529 rec->buf_len < rec->data_offset ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 rec->buf_len - rec->data_offset < rec->data_len) {
1531 MBEDTLS_SSL_DEBUG_MSG(1, ("bad record structure provided to decrypt_buf"));
1532 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001533 }
1534
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001535 data = rec->buf + rec->data_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01001536 ssl_mode = mbedtls_ssl_get_mode_from_transform(transform);
Paul Bakker5121ce52009-01-03 21:22:43 +00001537
Hanno Beckera0e20d02019-05-15 14:03:01 +01001538#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckercab87e62019-04-29 13:52:53 +01001539 /*
1540 * Match record's CID with incoming CID.
1541 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001542 if (rec->cid_len != transform->in_cid_len ||
1543 memcmp(rec->cid, transform->in_cid, rec->cid_len) != 0) {
1544 return MBEDTLS_ERR_SSL_UNEXPECTED_CID;
Hanno Becker938489a2019-05-08 13:02:22 +01001545 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01001546#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01001547
Hanno Beckerd086bf02021-03-22 13:01:27 +00001548#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM)
Gilles Peskine449bd832023-01-11 14:50:10 +01001549 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Przemyslaw Stekielc8a06fe2022-02-07 10:52:47 +01001550 /* The only supported stream cipher is "NULL",
1551 * so there's nothing to do here.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001552 } else
Hanno Beckerd086bf02021-03-22 13:01:27 +00001553#endif /* MBEDTLS_SSL_SOME_SUITES_USE_STREAM */
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001554#if defined(MBEDTLS_GCM_C) || \
1555 defined(MBEDTLS_CCM_C) || \
1556 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001557 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001558 unsigned char iv[12];
Hanno Beckerdf8be222020-05-21 15:30:57 +01001559 unsigned char *dynamic_iv;
1560 size_t dynamic_iv_len;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001561#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001562 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001563#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerca4ab492012-04-18 14:23:57 +00001564
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001565 /*
Hanno Beckerdf8be222020-05-21 15:30:57 +01001566 * Extract dynamic part of nonce for AEAD decryption.
1567 *
1568 * Note: In the case of CCM and GCM in TLS 1.2, the dynamic
1569 * part of the IV is prepended to the ciphertext and
1570 * can be chosen freely - in particular, it need not
1571 * agree with the record sequence number.
Manuel Pégourié-Gonnard2e58e8e2018-06-18 11:16:43 +02001572 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001573 dynamic_iv_len = sizeof(rec->ctr);
1574 if (ssl_transform_aead_dynamic_iv_is_explicit(transform) == 1) {
1575 if (rec->data_len < dynamic_iv_len) {
1576 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1577 " ) < explicit_iv_len (%" MBEDTLS_PRINTF_SIZET ") ",
1578 rec->data_len,
1579 dynamic_iv_len));
1580 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Beckerdf8be222020-05-21 15:30:57 +01001581 }
1582 dynamic_iv = data;
1583
1584 data += dynamic_iv_len;
1585 rec->data_offset += dynamic_iv_len;
1586 rec->data_len -= dynamic_iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001587 } else {
Hanno Becker17263802020-05-28 07:05:48 +01001588 dynamic_iv = rec->ctr;
1589 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001590
1591 /* Check that there's space for the authentication tag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 if (rec->data_len < transform->taglen) {
1593 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1594 ") < taglen (%" MBEDTLS_PRINTF_SIZET ") ",
1595 rec->data_len,
1596 transform->taglen));
1597 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard0bcc4e12014-06-17 10:54:17 +02001598 }
Hanno Beckerdf8be222020-05-21 15:30:57 +01001599 rec->data_len -= transform->taglen;
Paul Bakker68884e32013-01-07 18:20:04 +01001600
Hanno Beckerdf8be222020-05-21 15:30:57 +01001601 /*
1602 * Prepare nonce from dynamic and static parts.
1603 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001604 ssl_build_record_nonce(iv, sizeof(iv),
1605 transform->iv_dec,
1606 transform->fixed_ivlen,
1607 dynamic_iv,
1608 dynamic_iv_len);
Paul Bakker68884e32013-01-07 18:20:04 +01001609
Hanno Beckerdf8be222020-05-21 15:30:57 +01001610 /*
1611 * Build additional data for AEAD encryption.
1612 * This depends on the TLS version.
1613 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001614 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1615 transform->tls_version,
1616 transform->taglen);
1617 MBEDTLS_SSL_DEBUG_BUF(4, "additional data used for AEAD",
1618 add_data, add_data_len);
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001619
Hanno Beckerd96a6522019-07-10 13:55:25 +01001620 /* Because of the check above, we know that there are
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001621 * explicit_iv_len Bytes preceding data, and taglen
Hanno Beckerd96a6522019-07-10 13:55:25 +01001622 * bytes following data + data_len. This justifies
Hanno Becker20016652019-07-10 11:44:13 +01001623 * the debug message and the invocation of
TRodziewicz18efb732021-04-29 23:12:19 +02001624 * mbedtls_cipher_auth_decrypt_ext() below. */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001625
Gilles Peskine449bd832023-01-11 14:50:10 +01001626 MBEDTLS_SSL_DEBUG_BUF(4, "IV used", iv, transform->ivlen);
1627 MBEDTLS_SSL_DEBUG_BUF(4, "TAG used", data + rec->data_len,
1628 transform->taglen);
Paul Bakker68884e32013-01-07 18:20:04 +01001629
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001630 /*
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001631 * Decrypt and authenticate
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001632 */
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001633#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001634 status = psa_aead_decrypt(transform->psa_key_dec,
1635 transform->psa_alg,
1636 iv, transform->ivlen,
1637 add_data, add_data_len,
1638 data, rec->data_len + transform->taglen,
1639 data, rec->buf_len - (data - rec->buf),
1640 &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001641
Gilles Peskine449bd832023-01-11 14:50:10 +01001642 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001643 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001644 MBEDTLS_SSL_DEBUG_RET(1, "psa_aead_decrypt", ret);
1645 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001646 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001647#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001648 if ((ret = mbedtls_cipher_auth_decrypt_ext(&transform->cipher_ctx_dec,
1649 iv, transform->ivlen,
1650 add_data, add_data_len,
1651 data, rec->data_len + transform->taglen, /* src */
1652 data, rec->buf_len - (data - rec->buf), &olen, /* dst */
1653 transform->taglen)) != 0) {
1654 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_auth_decrypt_ext", ret);
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001655
Gilles Peskine449bd832023-01-11 14:50:10 +01001656 if (ret == MBEDTLS_ERR_CIPHER_AUTH_FAILED) {
1657 return MBEDTLS_ERR_SSL_INVALID_MAC;
1658 }
Manuel Pégourié-Gonnardde7bb442014-05-13 12:41:10 +02001659
Gilles Peskine449bd832023-01-11 14:50:10 +01001660 return ret;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001661 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001662#endif /* MBEDTLS_USE_PSA_CRYPTO */
1663
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001664 auth_done++;
Paul Bakkerca4ab492012-04-18 14:23:57 +00001665
Hanno Beckerd96a6522019-07-10 13:55:25 +01001666 /* Double-check that AEAD decryption doesn't change content length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001667 if (olen != rec->data_len) {
1668 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1669 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardd13a4092013-09-05 16:10:41 +02001670 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001671 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001672#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001673#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001674 if (ssl_mode == MBEDTLS_SSL_MODE_CBC ||
1675 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Paul Bakkere47b34b2013-02-27 14:48:00 +01001676 size_t minlen = 0;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001677#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemyslaw Stekield66387f2022-02-03 08:55:33 +01001678 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001679 size_t part_len;
1680 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1681#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001682
Paul Bakker5121ce52009-01-03 21:22:43 +00001683 /*
Paul Bakker45829992013-01-03 14:52:21 +01001684 * Check immediate ciphertext sanity
Paul Bakker5121ce52009-01-03 21:22:43 +00001685 */
TRodziewicz0f82ec62021-05-12 17:49:18 +02001686#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02001687 /* The ciphertext is prefixed with the CBC IV. */
1688 minlen += transform->ivlen;
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001689#endif
Paul Bakker45829992013-01-03 14:52:21 +01001690
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001691 /* Size considerations:
1692 *
1693 * - The CBC cipher text must not be empty and hence
1694 * at least of size transform->ivlen.
1695 *
1696 * Together with the potential IV-prefix, this explains
1697 * the first of the two checks below.
1698 *
1699 * - The record must contain a MAC, either in plain or
1700 * encrypted, depending on whether Encrypt-then-MAC
1701 * is used or not.
1702 * - If it is, the message contains the IV-prefix,
1703 * the CBC ciphertext, and the MAC.
1704 * - If it is not, the padded plaintext, and hence
1705 * the CBC ciphertext, has at least length maclen + 1
1706 * because there is at least the padding length byte.
1707 *
1708 * As the CBC ciphertext is not empty, both cases give the
1709 * lower bound minlen + maclen + 1 on the record size, which
1710 * we test for in the second check below.
1711 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 if (rec->data_len < minlen + transform->ivlen ||
1713 rec->data_len < minlen + transform->maclen + 1) {
1714 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1715 ") < max( ivlen(%" MBEDTLS_PRINTF_SIZET
1716 "), maclen (%" MBEDTLS_PRINTF_SIZET ") "
1717 "+ 1 ) ( + expl IV )",
1718 rec->data_len,
1719 transform->ivlen,
1720 transform->maclen));
1721 return MBEDTLS_ERR_SSL_INVALID_MAC;
Paul Bakker45829992013-01-03 14:52:21 +01001722 }
1723
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001724 /*
1725 * Authenticate before decrypt if enabled
1726 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001728 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001729#if defined(MBEDTLS_USE_PSA_CRYPTO)
1730 psa_mac_operation_t operation = PSA_MAC_OPERATION_INIT;
1731#else
Hanno Becker992b6872017-11-09 18:57:39 +00001732 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD];
Neil Armstrong26e6d672022-02-23 09:30:33 +01001733#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001734
Gilles Peskine449bd832023-01-11 14:50:10 +01001735 MBEDTLS_SSL_DEBUG_MSG(3, ("using encrypt then mac"));
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001736
Hanno Beckerd96a6522019-07-10 13:55:25 +01001737 /* Update data_len in tandem with add_data.
1738 *
1739 * The subtraction is safe because of the previous check
1740 * data_len >= minlen + maclen + 1.
1741 *
1742 * Afterwards, we know that data + data_len is followed by at
1743 * least maclen Bytes, which justifies the call to
Gabor Mezei90437e32021-10-20 11:59:27 +02001744 * mbedtls_ct_memcmp() below.
Hanno Beckerd96a6522019-07-10 13:55:25 +01001745 *
1746 * Further, we still know that data_len > minlen */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001747 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
1749 transform->tls_version,
1750 transform->taglen);
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001751
Hanno Beckerd96a6522019-07-10 13:55:25 +01001752 /* Calculate expected MAC. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001753 MBEDTLS_SSL_DEBUG_BUF(4, "MAC'd meta-data", add_data,
1754 add_data_len);
Neil Armstrong26e6d672022-02-23 09:30:33 +01001755#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 status = psa_mac_verify_setup(&operation, transform->psa_mac_dec,
1757 transform->psa_mac_alg);
1758 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001759 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001761
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 status = psa_mac_update(&operation, add_data, add_data_len);
1763 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001764 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001765 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001766
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 status = psa_mac_update(&operation, data, rec->data_len);
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
1772 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001773 status = psa_mac_verify_finish(&operation, data + rec->data_len,
1774 transform->maclen);
1775 if (status != PSA_SUCCESS) {
Neil Armstrong26e6d672022-02-23 09:30:33 +01001776 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001777 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001778#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001779 ret = mbedtls_md_hmac_update(&transform->md_ctx_dec, add_data,
1780 add_data_len);
1781 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001782 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001783 }
1784 ret = mbedtls_md_hmac_update(&transform->md_ctx_dec,
1785 data, rec->data_len);
1786 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001787 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001788 }
1789 ret = mbedtls_md_hmac_finish(&transform->md_ctx_dec, mac_expect);
1790 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001791 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001792 }
1793 ret = mbedtls_md_hmac_reset(&transform->md_ctx_dec);
1794 if (ret != 0) {
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001795 goto hmac_failed_etm_enabled;
Gilles Peskine449bd832023-01-11 14:50:10 +01001796 }
Manuel Pégourié-Gonnard08558e52014-11-04 14:40:21 +01001797
Gilles Peskine449bd832023-01-11 14:50:10 +01001798 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", data + rec->data_len,
1799 transform->maclen);
1800 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect,
1801 transform->maclen);
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001802
Hanno Beckerd96a6522019-07-10 13:55:25 +01001803 /* Compare expected MAC with MAC at the end of the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001804 if (mbedtls_ct_memcmp(data + rec->data_len, mac_expect,
1805 transform->maclen) != 0) {
1806 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001807 ret = MBEDTLS_ERR_SSL_INVALID_MAC;
1808 goto hmac_failed_etm_enabled;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001809 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001810#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01001811 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01001812
Gilles Peskine449bd832023-01-11 14:50:10 +01001813hmac_failed_etm_enabled:
Neil Armstrong26e6d672022-02-23 09:30:33 +01001814#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001815 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001816 status = psa_mac_abort(&operation);
1817 if (ret == 0 && status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001818 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001819 }
Neil Armstrong26e6d672022-02-23 09:30:33 +01001820#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001821 mbedtls_platform_zeroize(mac_expect, transform->maclen);
Neil Armstrong4313f552022-03-02 15:14:07 +01001822#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001823 if (ret != 0) {
1824 if (ret != MBEDTLS_ERR_SSL_INVALID_MAC) {
1825 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_hmac_xxx", ret);
1826 }
1827 return ret;
Gilles Peskineecf6beb2021-12-10 21:35:10 +01001828 }
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001829 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001830#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001831
1832 /*
1833 * Check length sanity
1834 */
Hanno Beckerd96a6522019-07-10 13:55:25 +01001835
1836 /* We know from above that data_len > minlen >= 0,
1837 * so the following check in particular implies that
1838 * data_len >= minlen + ivlen ( = minlen or 2 * minlen ). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001839 if (rec->data_len % transform->ivlen != 0) {
1840 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1841 ") %% ivlen (%" MBEDTLS_PRINTF_SIZET ") != 0",
1842 rec->data_len, transform->ivlen));
1843 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001844 }
1845
TRodziewicz0f82ec62021-05-12 17:49:18 +02001846#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001847 /*
TRodziewicz0f82ec62021-05-12 17:49:18 +02001848 * Initialize for prepended IV for block cipher in TLS v1.2
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001849 */
TRodziewicz345165c2021-07-06 13:42:11 +02001850 /* Safe because data_len >= minlen + ivlen = 2 * ivlen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 memcpy(transform->iv_dec, data, transform->ivlen);
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001852
TRodziewicz345165c2021-07-06 13:42:11 +02001853 data += transform->ivlen;
1854 rec->data_offset += transform->ivlen;
1855 rec->data_len -= transform->ivlen;
TRodziewicz0f82ec62021-05-12 17:49:18 +02001856#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker2e11f7d2010-07-25 14:24:53 +00001857
Hanno Beckerd96a6522019-07-10 13:55:25 +01001858 /* We still have data_len % ivlen == 0 and data_len >= ivlen here. */
1859
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001860#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 status = psa_cipher_decrypt_setup(&cipher_op,
1862 transform->psa_key_dec, transform->psa_alg);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001863
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001865 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001866 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_decrypt_setup", ret);
1867 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001868 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001869
Gilles Peskine449bd832023-01-11 14:50:10 +01001870 status = psa_cipher_set_iv(&cipher_op, transform->iv_dec, transform->ivlen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001871
Gilles Peskine449bd832023-01-11 14:50:10 +01001872 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001873 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001874 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_set_iv", ret);
1875 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001876 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001877
Gilles Peskine449bd832023-01-11 14:50:10 +01001878 status = psa_cipher_update(&cipher_op,
1879 data, rec->data_len,
1880 data, rec->data_len, &olen);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001881
Gilles Peskine449bd832023-01-11 14:50:10 +01001882 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001883 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001884 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_update", ret);
1885 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001886 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001887
Gilles Peskine449bd832023-01-11 14:50:10 +01001888 status = psa_cipher_finish(&cipher_op,
1889 data + olen, rec->data_len - olen,
1890 &part_len);
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001891
Gilles Peskine449bd832023-01-11 14:50:10 +01001892 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001893 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001894 MBEDTLS_SSL_DEBUG_RET(1, "psa_cipher_finish", ret);
1895 return ret;
Przemyslaw Stekiel6b2eedd2022-02-03 09:54:34 +01001896 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001897
1898 olen += part_len;
1899#else
1900
Gilles Peskine449bd832023-01-11 14:50:10 +01001901 if ((ret = mbedtls_cipher_crypt(&transform->cipher_ctx_dec,
1902 transform->iv_dec, transform->ivlen,
1903 data, rec->data_len, data, &olen)) != 0) {
1904 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_crypt", ret);
1905 return ret;
Paul Bakkercca5b812013-08-31 17:40:26 +02001906 }
Przemyslaw Stekiel2e9711f2022-01-13 14:50:15 +01001907#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001908
Hanno Beckerd96a6522019-07-10 13:55:25 +01001909 /* Double-check that length hasn't changed during decryption. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001910 if (rec->data_len != olen) {
1911 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1912 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Paul Bakkercca5b812013-08-31 17:40:26 +02001913 }
Paul Bakkerda02a7f2013-08-31 17:25:14 +02001914
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001915 /* Safe since data_len >= minlen + maclen + 1, so after having
1916 * subtracted at most minlen and maclen up to this point,
Hanno Beckerd96a6522019-07-10 13:55:25 +01001917 * data_len > 0 (because of data_len % ivlen == 0, it's actually
1918 * >= ivlen ). */
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001919 padlen = data[rec->data_len - 1];
Paul Bakker45829992013-01-03 14:52:21 +01001920
Gilles Peskine449bd832023-01-11 14:50:10 +01001921 if (auth_done == 1) {
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001922 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001923 rec->data_len,
1924 padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001925 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001926 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Gilles Peskine449bd832023-01-11 14:50:10 +01001927 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001928#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01001929 if (rec->data_len < transform->maclen + padlen + 1) {
1930 MBEDTLS_SSL_DEBUG_MSG(1, ("msglen (%" MBEDTLS_PRINTF_SIZET
1931 ") < maclen (%" MBEDTLS_PRINTF_SIZET
1932 ") + padlen (%" MBEDTLS_PRINTF_SIZET ")",
1933 rec->data_len,
1934 transform->maclen,
1935 padlen + 1));
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001936 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001937#endif
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001938 const mbedtls_ct_condition_t ge = mbedtls_ct_uint_ge(
Gilles Peskine449bd832023-01-11 14:50:10 +01001939 rec->data_len,
1940 transform->maclen + padlen + 1);
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001941 correct = mbedtls_ct_bool_and(ge, correct);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001942 padlen = mbedtls_ct_size_if_else_0(ge, padlen);
Paul Bakker45829992013-01-03 14:52:21 +01001943 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001944
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001945 padlen++;
1946
1947 /* Regardless of the validity of the padding,
1948 * we have data_len >= padlen here. */
1949
TRodziewicz0f82ec62021-05-12 17:49:18 +02001950#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001951 /* The padding check involves a series of up to 256
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 * consecutive memory reads at the end of the record
1953 * plaintext buffer. In order to hide the length and
1954 * validity of the padding, always perform exactly
1955 * `min(256,plaintext_len)` reads (but take into account
1956 * only the last `padlen` bytes for the padding check). */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001957 size_t pad_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001958 volatile unsigned char * const check = data;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001959
1960 /* Index of first padding byte; it has been ensured above
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 * that the subtraction is safe. */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001962 size_t const padding_idx = rec->data_len - padlen;
1963 size_t const num_checks = rec->data_len <= 256 ? rec->data_len : 256;
1964 size_t const start_idx = rec->data_len - num_checks;
1965 size_t idx;
1966
Gilles Peskine449bd832023-01-11 14:50:10 +01001967 for (idx = start_idx; idx < rec->data_len; idx++) {
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001968 /* pad_count += (idx >= padding_idx) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001969 * (check[idx] == padlen - 1);
1970 */
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001971 const mbedtls_ct_condition_t a = mbedtls_ct_uint_ge(idx, padding_idx);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001972 size_t increment = mbedtls_ct_size_if_else_0(a, 1);
Dave Rodgmanb7825ce2023-08-10 11:58:18 +01001973 const mbedtls_ct_condition_t b = mbedtls_ct_uint_eq(check[idx], padlen - 1);
Dave Rodgman98ddc012023-08-10 12:11:31 +01001974 increment = mbedtls_ct_size_if_else_0(b, increment);
Dave Rodgmana81373f2023-05-17 12:36:01 +01001975 pad_count += increment;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001976 }
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001977 correct = mbedtls_ct_bool_and(mbedtls_ct_uint_eq(pad_count, padlen), correct);
Paul Bakkere47b34b2013-02-27 14:48:00 +01001978
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001979#if defined(MBEDTLS_SSL_DEBUG_ALL)
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001980 if (padlen > 0 && correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 MBEDTLS_SSL_DEBUG_MSG(1, ("bad padding byte detected"));
1982 }
Paul Bakkerd66f0702013-01-31 16:57:45 +01001983#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01001984 padlen = mbedtls_ct_size_if_else_0(correct, padlen);
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001985
TRodziewicz0f82ec62021-05-12 17:49:18 +02001986#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01001987
Hanno Becker2e24c3b2017-12-27 21:28:58 +00001988 /* If the padding was found to be invalid, padlen == 0
1989 * and the subtraction is safe. If the padding was found valid,
1990 * padlen hasn't been changed and the previous assertion
1991 * data_len >= padlen still holds. */
1992 rec->data_len -= padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 } else
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +02001994#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC */
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001995 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1997 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +02001998 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001999
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02002000#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002001 MBEDTLS_SSL_DEBUG_BUF(4, "raw buffer after decryption",
2002 data, rec->data_len);
Manuel Pégourié-Gonnard6a25cfa2018-07-10 11:15:36 +02002003#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002004
2005 /*
Manuel Pégourié-Gonnard313d7962014-10-29 12:07:57 +01002006 * Authenticate if not done yet.
2007 * Compute the MAC regardless of the padding result (RFC4346, CBCTIME).
Paul Bakker5121ce52009-01-03 21:22:43 +00002008 */
Hanno Beckerfd86ca82020-11-30 08:54:23 +00002009#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002010 if (auth_done == 0) {
Paul Elliott5260ce22022-05-09 18:15:54 +01002011 unsigned char mac_expect[MBEDTLS_SSL_MAC_ADD] = { 0 };
2012 unsigned char mac_peer[MBEDTLS_SSL_MAC_ADD] = { 0 };
Paul Bakker1e5369c2013-12-19 16:40:57 +01002013
Hanno Becker2e24c3b2017-12-27 21:28:58 +00002014 /* If the initial value of padlen was such that
2015 * data_len < maclen + padlen + 1, then padlen
2016 * got reset to 1, and the initial check
2017 * data_len >= minlen + maclen + 1
2018 * guarantees that at this point we still
2019 * have at least data_len >= maclen.
2020 *
2021 * If the initial value of padlen was such that
2022 * data_len >= maclen + padlen + 1, then we have
2023 * subtracted either padlen + 1 (if the padding was correct)
2024 * or 0 (if the padding was incorrect) since then,
2025 * hence data_len >= maclen in any case.
2026 */
2027 rec->data_len -= transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01002028 ssl_extract_add_data_from_record(add_data, &add_data_len, rec,
2029 transform->tls_version,
2030 transform->taglen);
Paul Bakker5121ce52009-01-03 21:22:43 +00002031
TRodziewicz0f82ec62021-05-12 17:49:18 +02002032#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002033 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01002034 * The next two sizes are the minimum and maximum values of
2035 * data_len over all padlen values.
2036 *
2037 * They're independent of padlen, since we previously did
2038 * data_len -= padlen.
2039 *
2040 * Note that max_len + maclen is never more than the buffer
2041 * length, as we previously did in_msglen -= maclen too.
2042 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002043 const size_t max_len = rec->data_len + padlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01002044 const size_t min_len = (max_len > 256) ? max_len - 256 : 0;
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002045
Neil Armstronge8589962022-02-25 15:14:29 +01002046#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 ret = mbedtls_ct_hmac(transform->psa_mac_dec,
2048 transform->psa_mac_alg,
2049 add_data, add_data_len,
2050 data, rec->data_len, min_len, max_len,
2051 mac_expect);
Neil Armstronge8589962022-02-25 15:14:29 +01002052#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002053 ret = mbedtls_ct_hmac(&transform->md_ctx_dec,
2054 add_data, add_data_len,
2055 data, rec->data_len, min_len, max_len,
2056 mac_expect);
Neil Armstronge8589962022-02-25 15:14:29 +01002057#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 if (ret != 0) {
2059 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ct_hmac", ret);
Gilles Peskined5ba50e2021-12-10 21:33:21 +01002060 goto hmac_failed_etm_disabled;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002061 }
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002062
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 mbedtls_ct_memcpy_offset(mac_peer, data,
2064 rec->data_len,
2065 min_len, max_len,
2066 transform->maclen);
TRodziewicz0f82ec62021-05-12 17:49:18 +02002067#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002068
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02002069#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 MBEDTLS_SSL_DEBUG_BUF(4, "expected mac", mac_expect, transform->maclen);
2071 MBEDTLS_SSL_DEBUG_BUF(4, "message mac", mac_peer, transform->maclen);
Manuel Pégourié-Gonnard7b420302018-06-28 10:38:35 +02002072#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002073
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 if (mbedtls_ct_memcmp(mac_peer, mac_expect,
2075 transform->maclen) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002076#if defined(MBEDTLS_SSL_DEBUG_ALL)
Gilles Peskine449bd832023-01-11 14:50:10 +01002077 MBEDTLS_SSL_DEBUG_MSG(1, ("message mac does not match"));
Paul Bakkere47b34b2013-02-27 14:48:00 +01002078#endif
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01002079 correct = MBEDTLS_CT_FALSE;
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002080 }
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002081 auth_done++;
Gilles Peskined5ba50e2021-12-10 21:33:21 +01002082
Gilles Peskine449bd832023-01-11 14:50:10 +01002083hmac_failed_etm_disabled:
2084 mbedtls_platform_zeroize(mac_peer, transform->maclen);
2085 mbedtls_platform_zeroize(mac_expect, transform->maclen);
2086 if (ret != 0) {
2087 return ret;
2088 }
Manuel Pégourié-Gonnard71096242013-10-25 19:31:25 +02002089 }
Hanno Beckerdd3ab132018-10-17 14:43:14 +01002090
2091 /*
2092 * Finally check the correct flag
2093 */
Dave Rodgman7d52f2a2023-09-12 16:29:39 +01002094 if (correct == MBEDTLS_CT_FALSE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 return MBEDTLS_ERR_SSL_INVALID_MAC;
2096 }
Hanno Beckerfd86ca82020-11-30 08:54:23 +00002097#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002098
2099 /* Make extra sure authentication was performed, exactly once */
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 if (auth_done != 1) {
2101 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2102 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard352143f2015-01-13 10:59:51 +01002103 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002104
Ronald Cron6f135e12021-12-08 16:57:54 +01002105#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 if (transform->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Hanno Beckerccc13d02020-05-04 12:30:04 +01002107 /* Remove inner padding and infer true content type. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
2109 &rec->type);
Hanno Beckerccc13d02020-05-04 12:30:04 +01002110
Gilles Peskine449bd832023-01-11 14:50:10 +01002111 if (ret != 0) {
2112 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2113 }
Hanno Beckerccc13d02020-05-04 12:30:04 +01002114 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002115#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerccc13d02020-05-04 12:30:04 +01002116
Hanno Beckera0e20d02019-05-15 14:03:01 +01002117#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 if (rec->cid_len != 0) {
2119 ret = ssl_parse_inner_plaintext(data, &rec->data_len,
2120 &rec->type);
2121 if (ret != 0) {
2122 return MBEDTLS_ERR_SSL_INVALID_RECORD;
2123 }
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01002124 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01002125#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker8b3eb5a2019-04-29 17:31:37 +01002126
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 MBEDTLS_SSL_DEBUG_MSG(2, ("<= decrypt buf"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002128
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002130}
2131
Manuel Pégourié-Gonnard0098e7d2014-10-28 13:08:59 +01002132#undef MAC_NONE
2133#undef MAC_PLAINTEXT
2134#undef MAC_CIPHERTEXT
2135
Paul Bakker5121ce52009-01-03 21:22:43 +00002136/*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002137 * Fill the input message buffer by appending data to it.
2138 * The amount of data already fetched is in ssl->in_left.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002139 *
2140 * If we return 0, is it guaranteed that (at least) nb_want bytes are
2141 * available (from this read and/or a previous one). Otherwise, an error code
2142 * is returned (possibly EOF or WANT_READ).
2143 *
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002144 * With stream transport (TLS) on success ssl->in_left == nb_want, but
2145 * with datagram transport (DTLS) on success ssl->in_left >= nb_want,
2146 * since we always read a whole datagram at once.
2147 *
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02002148 * For DTLS, it is up to the caller to set ssl->next_record_offset when
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002149 * they're done reading a record.
Paul Bakker5121ce52009-01-03 21:22:43 +00002150 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002151int mbedtls_ssl_fetch_input(mbedtls_ssl_context *ssl, size_t nb_want)
Paul Bakker5121ce52009-01-03 21:22:43 +00002152{
Janos Follath865b3eb2019-12-16 11:46:15 +00002153 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00002154 size_t len;
Darryl Greenb33cc762019-11-28 14:29:44 +00002155#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2156 size_t in_buf_len = ssl->in_buf_len;
2157#else
2158 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
2159#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00002160
Gilles Peskine449bd832023-01-11 14:50:10 +01002161 MBEDTLS_SSL_DEBUG_MSG(2, ("=> fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002162
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 if (ssl->f_recv == NULL && ssl->f_recv_timeout == NULL) {
2164 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2165 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002166 }
2167
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 if (nb_want > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
2169 MBEDTLS_SSL_DEBUG_MSG(1, ("requesting more data than fits"));
2170 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Paul Bakker1a1fbba2014-04-30 14:38:05 +02002171 }
2172
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002173#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002175 uint32_t timeout;
2176
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002177 /*
2178 * The point is, we need to always read a full datagram at once, so we
2179 * sometimes read more then requested, and handle the additional data.
2180 * It could be the rest of the current record (while fetching the
2181 * header) and/or some other records in the same datagram.
2182 */
2183
2184 /*
2185 * Move to the next record in the already read datagram if applicable
2186 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002187 if (ssl->next_record_offset != 0) {
2188 if (ssl->in_left < ssl->next_record_offset) {
2189 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2190 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002191 }
2192
2193 ssl->in_left -= ssl->next_record_offset;
2194
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 if (ssl->in_left != 0) {
2196 MBEDTLS_SSL_DEBUG_MSG(2, ("next record in same datagram, offset: %"
2197 MBEDTLS_PRINTF_SIZET,
2198 ssl->next_record_offset));
2199 memmove(ssl->in_hdr,
2200 ssl->in_hdr + ssl->next_record_offset,
2201 ssl->in_left);
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002202 }
2203
2204 ssl->next_record_offset = 0;
2205 }
2206
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2208 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2209 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002210
2211 /*
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002212 * Done if we already have enough data.
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002213 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 if (nb_want <= ssl->in_left) {
2215 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
2216 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02002217 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002218
2219 /*
Antonin Décimo36e89b52019-01-23 15:24:37 +01002220 * A record can't be split across datagrams. If we need to read but
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002221 * are not at the beginning of a new record, the caller did something
2222 * wrong.
2223 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002224 if (ssl->in_left != 0) {
2225 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2226 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002227 }
2228
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002229 /*
2230 * Don't even try to read if time's out already.
2231 * This avoids by-passing the timer when repeatedly receiving messages
2232 * that will end up being dropped.
2233 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 if (mbedtls_ssl_check_timer(ssl) != 0) {
2235 MBEDTLS_SSL_DEBUG_MSG(2, ("timer has expired"));
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002236 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002237 } else {
2238 len = in_buf_len - (ssl->in_hdr - ssl->in_buf);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002239
Gilles Peskine449bd832023-01-11 14:50:10 +01002240 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002241 timeout = ssl->handshake->retransmit_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 } else {
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02002243 timeout = ssl->conf->read_timeout;
Gilles Peskine449bd832023-01-11 14:50:10 +01002244 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002245
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 MBEDTLS_SSL_DEBUG_MSG(3, ("f_recv_timeout: %lu ms", (unsigned long) timeout));
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002247
Gilles Peskine449bd832023-01-11 14:50:10 +01002248 if (ssl->f_recv_timeout != NULL) {
2249 ret = ssl->f_recv_timeout(ssl->p_bio, ssl->in_hdr, len,
2250 timeout);
2251 } else {
2252 ret = ssl->f_recv(ssl->p_bio, ssl->in_hdr, len);
2253 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002254
Gilles Peskine449bd832023-01-11 14:50:10 +01002255 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002256
Gilles Peskine449bd832023-01-11 14:50:10 +01002257 if (ret == 0) {
2258 return MBEDTLS_ERR_SSL_CONN_EOF;
2259 }
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002260 }
2261
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 if (ret == MBEDTLS_ERR_SSL_TIMEOUT) {
2263 MBEDTLS_SSL_DEBUG_MSG(2, ("timeout"));
2264 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002265
Gilles Peskine449bd832023-01-11 14:50:10 +01002266 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
2267 if (ssl_double_retransmit_timeout(ssl) != 0) {
2268 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake timeout"));
2269 return MBEDTLS_ERR_SSL_TIMEOUT;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002270 }
2271
Gilles Peskine449bd832023-01-11 14:50:10 +01002272 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
2273 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
2274 return ret;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02002275 }
2276
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +02002278 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002279#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002280 else if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
2281 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
2282 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
2283 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
2284 ret);
2285 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002286 }
2287
Gilles Peskine449bd832023-01-11 14:50:10 +01002288 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02002289 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002290#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02002291 }
2292
Gilles Peskine449bd832023-01-11 14:50:10 +01002293 if (ret < 0) {
2294 return ret;
2295 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002296
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002297 ssl->in_left = ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01002298 } else
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002299#endif
2300 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2302 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2303 ssl->in_left, nb_want));
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02002304
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 while (ssl->in_left < nb_want) {
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002306 len = nb_want - ssl->in_left;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002307
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 if (mbedtls_ssl_check_timer(ssl) != 0) {
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02002309 ret = MBEDTLS_ERR_SSL_TIMEOUT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 } else {
2311 if (ssl->f_recv_timeout != NULL) {
2312 ret = ssl->f_recv_timeout(ssl->p_bio,
2313 ssl->in_hdr + ssl->in_left, len,
2314 ssl->conf->read_timeout);
2315 } else {
2316 ret = ssl->f_recv(ssl->p_bio,
2317 ssl->in_hdr + ssl->in_left, len);
Manuel Pégourié-Gonnard07617332015-06-24 23:00:03 +02002318 }
2319 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002320
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 MBEDTLS_SSL_DEBUG_MSG(2, ("in_left: %" MBEDTLS_PRINTF_SIZET
2322 ", nb_want: %" MBEDTLS_PRINTF_SIZET,
2323 ssl->in_left, nb_want));
2324 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_recv(_timeout)", ret);
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002325
Gilles Peskine449bd832023-01-11 14:50:10 +01002326 if (ret == 0) {
2327 return MBEDTLS_ERR_SSL_CONN_EOF;
2328 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002329
Gilles Peskine449bd832023-01-11 14:50:10 +01002330 if (ret < 0) {
2331 return ret;
2332 }
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002333
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002334 if ((size_t) ret > len) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002335 MBEDTLS_SSL_DEBUG_MSG(1,
2336 ("f_recv returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2337 " were requested",
2338 ret, len));
2339 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16035bd15cb2018-02-28 04:30:59 -08002340 }
2341
Manuel Pégourié-Gonnardfe98ace2014-03-24 13:13:01 +01002342 ssl->in_left += ret;
2343 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002344 }
2345
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 MBEDTLS_SSL_DEBUG_MSG(2, ("<= fetch input"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002347
Gilles Peskine449bd832023-01-11 14:50:10 +01002348 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002349}
2350
2351/*
2352 * Flush any data not yet written
2353 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002354int mbedtls_ssl_flush_output(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002355{
Janos Follath865b3eb2019-12-16 11:46:15 +00002356 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker04484622018-08-06 09:49:38 +01002357 unsigned char *buf;
Paul Bakker5121ce52009-01-03 21:22:43 +00002358
Gilles Peskine449bd832023-01-11 14:50:10 +01002359 MBEDTLS_SSL_DEBUG_MSG(2, ("=> flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002360
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 if (ssl->f_send == NULL) {
2362 MBEDTLS_SSL_DEBUG_MSG(1, ("Bad usage of mbedtls_ssl_set_bio() "));
2363 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02002364 }
2365
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002366 /* Avoid incrementing counter if data is flushed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002367 if (ssl->out_left == 0) {
2368 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
2369 return 0;
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002370 }
2371
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 while (ssl->out_left > 0) {
2373 MBEDTLS_SSL_DEBUG_MSG(2, ("message length: %" MBEDTLS_PRINTF_SIZET
2374 ", out_left: %" MBEDTLS_PRINTF_SIZET,
2375 mbedtls_ssl_out_hdr_len(ssl) + ssl->out_msglen, ssl->out_left));
Paul Bakker5121ce52009-01-03 21:22:43 +00002376
Hanno Becker2b1e3542018-08-06 11:19:13 +01002377 buf = ssl->out_hdr - ssl->out_left;
Gilles Peskine449bd832023-01-11 14:50:10 +01002378 ret = ssl->f_send(ssl->p_bio, buf, ssl->out_left);
Paul Bakker186751d2012-05-08 13:16:14 +00002379
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", ret);
Paul Bakker5121ce52009-01-03 21:22:43 +00002381
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 if (ret <= 0) {
2383 return ret;
2384 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002385
Dave Rodgman4a5c9ee2023-02-10 16:03:44 +00002386 if ((size_t) ret > ssl->out_left) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 MBEDTLS_SSL_DEBUG_MSG(1,
2388 ("f_send returned %d bytes but only %" MBEDTLS_PRINTF_SIZET
2389 " bytes were sent",
2390 ret, ssl->out_left));
2391 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
mohammad16034bbaeb42018-02-22 04:29:04 -08002392 }
2393
Paul Bakker5121ce52009-01-03 21:22:43 +00002394 ssl->out_left -= ret;
2395 }
2396
Hanno Becker2b1e3542018-08-06 11:19:13 +01002397#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002398 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002399 ssl->out_hdr = ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 } else
Hanno Becker2b1e3542018-08-06 11:19:13 +01002401#endif
2402 {
2403 ssl->out_hdr = ssl->out_buf + 8;
2404 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01002406
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 MBEDTLS_SSL_DEBUG_MSG(2, ("<= flush output"));
Paul Bakker5121ce52009-01-03 21:22:43 +00002408
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002410}
2411
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002412/*
2413 * Functions to handle the DTLS retransmission state machine
2414 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002415#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002416/*
2417 * Append current handshake message to current outgoing flight
2418 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002419MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002420static int ssl_flight_append(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002421{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002422 mbedtls_ssl_flight_item *msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002423 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_flight_append"));
2424 MBEDTLS_SSL_DEBUG_BUF(4, "message appended to flight",
2425 ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002426
2427 /* Allocate space for current message */
Gilles Peskine449bd832023-01-11 14:50:10 +01002428 if ((msg = mbedtls_calloc(1, sizeof(mbedtls_ssl_flight_item))) == NULL) {
2429 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2430 sizeof(mbedtls_ssl_flight_item)));
2431 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002432 }
2433
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 if ((msg->p = mbedtls_calloc(1, ssl->out_msglen)) == NULL) {
2435 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc %" MBEDTLS_PRINTF_SIZET " bytes failed",
2436 ssl->out_msglen));
2437 mbedtls_free(msg);
2438 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002439 }
2440
2441 /* Copy current handshake message with headers */
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 memcpy(msg->p, ssl->out_msg, ssl->out_msglen);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002443 msg->len = ssl->out_msglen;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002444 msg->type = ssl->out_msgtype;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002445 msg->next = NULL;
2446
2447 /* Append to the current flight */
Gilles Peskine449bd832023-01-11 14:50:10 +01002448 if (ssl->handshake->flight == NULL) {
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002449 ssl->handshake->flight = msg;
Gilles Peskine449bd832023-01-11 14:50:10 +01002450 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002451 mbedtls_ssl_flight_item *cur = ssl->handshake->flight;
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 while (cur->next != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002453 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01002454 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002455 cur->next = msg;
2456 }
2457
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_flight_append"));
2459 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002460}
2461
2462/*
2463 * Free the current flight of handshake messages
2464 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002465void mbedtls_ssl_flight_free(mbedtls_ssl_flight_item *flight)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002466{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002467 mbedtls_ssl_flight_item *cur = flight;
2468 mbedtls_ssl_flight_item *next;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002469
Gilles Peskine449bd832023-01-11 14:50:10 +01002470 while (cur != NULL) {
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002471 next = cur->next;
2472
Gilles Peskine449bd832023-01-11 14:50:10 +01002473 mbedtls_free(cur->p);
2474 mbedtls_free(cur);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002475
2476 cur = next;
2477 }
2478}
2479
2480/*
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002481 * Swap transform_out and out_ctr with the alternative ones
2482 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002483MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002484static int ssl_swap_epochs(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002485{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002486 mbedtls_ssl_transform *tmp_transform;
Jerry Yuae0b2e22021-10-08 15:21:19 +08002487 unsigned char tmp_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN];
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002488
Gilles Peskine449bd832023-01-11 14:50:10 +01002489 if (ssl->transform_out == ssl->handshake->alt_transform_out) {
2490 MBEDTLS_SSL_DEBUG_MSG(3, ("skip swap epochs"));
2491 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002492 }
2493
Gilles Peskine449bd832023-01-11 14:50:10 +01002494 MBEDTLS_SSL_DEBUG_MSG(3, ("swap epochs"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002495
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002496 /* Swap transforms */
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002497 tmp_transform = ssl->transform_out;
2498 ssl->transform_out = ssl->handshake->alt_transform_out;
2499 ssl->handshake->alt_transform_out = tmp_transform;
2500
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002501 /* Swap epoch + sequence_number */
Gilles Peskine449bd832023-01-11 14:50:10 +01002502 memcpy(tmp_out_ctr, ssl->cur_out_ctr, sizeof(tmp_out_ctr));
2503 memcpy(ssl->cur_out_ctr, ssl->handshake->alt_out_ctr,
2504 sizeof(ssl->cur_out_ctr));
2505 memcpy(ssl->handshake->alt_out_ctr, tmp_out_ctr,
2506 sizeof(ssl->handshake->alt_out_ctr));
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002507
2508 /* Adjust to the newly activated transform */
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002510
Gilles Peskine449bd832023-01-11 14:50:10 +01002511 return 0;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002512}
2513
2514/*
2515 * Retransmit the current flight of messages.
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002516 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002517int mbedtls_ssl_resend(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002518{
2519 int ret = 0;
2520
Gilles Peskine449bd832023-01-11 14:50:10 +01002521 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002522
Gilles Peskine449bd832023-01-11 14:50:10 +01002523 ret = mbedtls_ssl_flight_transmit(ssl);
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002524
Gilles Peskine449bd832023-01-11 14:50:10 +01002525 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_resend"));
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002526
Gilles Peskine449bd832023-01-11 14:50:10 +01002527 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002528}
2529
2530/*
2531 * Transmit or retransmit the current flight of messages.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002532 *
2533 * Need to remember the current message in case flush_output returns
2534 * WANT_WRITE, causing us to exit this function and come back later.
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002535 * This function must be called until state is no longer SENDING.
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002536 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002537int mbedtls_ssl_flight_transmit(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002538{
Janos Follath865b3eb2019-12-16 11:46:15 +00002539 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002540 MBEDTLS_SSL_DEBUG_MSG(2, ("=> mbedtls_ssl_flight_transmit"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002541
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 if (ssl->handshake->retransmit_state != MBEDTLS_SSL_RETRANS_SENDING) {
2543 MBEDTLS_SSL_DEBUG_MSG(2, ("initialise flight transmission"));
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002544
2545 ssl->handshake->cur_msg = ssl->handshake->flight;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002546 ssl->handshake->cur_msg_p = ssl->handshake->flight->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002547 ret = ssl_swap_epochs(ssl);
2548 if (ret != 0) {
2549 return ret;
2550 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002551
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002552 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_SENDING;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002553 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002554
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 while (ssl->handshake->cur_msg != NULL) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01002556 size_t max_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002557 const mbedtls_ssl_flight_item * const cur = ssl->handshake->cur_msg;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002558
Hanno Beckere1dcb032018-08-17 16:47:58 +01002559 int const is_finished =
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 (cur->type == MBEDTLS_SSL_MSG_HANDSHAKE &&
2561 cur->p[0] == MBEDTLS_SSL_HS_FINISHED);
Hanno Beckere1dcb032018-08-17 16:47:58 +01002562
Ronald Cron00d012f22022-03-08 15:57:12 +01002563 int const force_flush = ssl->disable_datagram_packing == 1 ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 SSL_FORCE_FLUSH : SSL_DONT_FORCE_FLUSH;
Hanno Becker04da1892018-08-14 13:22:10 +01002565
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002566 /* Swap epochs before sending Finished: we can't do it after
2567 * sending ChangeCipherSpec, in case write returns WANT_READ.
2568 * Must be done before copying, may change out_msg pointer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 if (is_finished && ssl->handshake->cur_msg_p == (cur->p + 12)) {
2570 MBEDTLS_SSL_DEBUG_MSG(2, ("swap epochs to send finished message"));
2571 ret = ssl_swap_epochs(ssl);
2572 if (ret != 0) {
2573 return ret;
2574 }
Manuel Pégourié-Gonnardc715aed2014-09-19 21:39:13 +02002575 }
2576
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 ret = ssl_get_remaining_payload_in_datagram(ssl);
2578 if (ret < 0) {
2579 return ret;
2580 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002581 max_frag_len = (size_t) ret;
2582
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002583 /* CCS is copied as is, while HS messages may need fragmentation */
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 if (cur->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2585 if (max_frag_len == 0) {
2586 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2587 return ret;
2588 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002589
2590 continue;
2591 }
2592
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 memcpy(ssl->out_msg, cur->p, cur->len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002594 ssl->out_msglen = cur->len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002595 ssl->out_msgtype = cur->type;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002596
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002597 /* Update position inside current message */
2598 ssl->handshake->cur_msg_p += cur->len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002600 const unsigned char * const p = ssl->handshake->cur_msg_p;
2601 const size_t hs_len = cur->len - 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002602 const size_t frag_off = p - (cur->p + 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002603 const size_t rem_len = hs_len - frag_off;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002604 size_t cur_hs_frag_len, max_hs_frag_len;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002605
Gilles Peskine449bd832023-01-11 14:50:10 +01002606 if ((max_frag_len < 12) || (max_frag_len == 12 && hs_len != 0)) {
2607 if (is_finished) {
2608 ret = ssl_swap_epochs(ssl);
2609 if (ret != 0) {
2610 return ret;
2611 }
Manuel Pégourié-Gonnarde07bc202020-02-26 09:53:42 +01002612 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002613
Gilles Peskine449bd832023-01-11 14:50:10 +01002614 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2615 return ret;
2616 }
Hanno Becker67bc7c32018-08-06 11:33:50 +01002617
2618 continue;
2619 }
2620 max_hs_frag_len = max_frag_len - 12;
2621
2622 cur_hs_frag_len = rem_len > max_hs_frag_len ?
Gilles Peskine449bd832023-01-11 14:50:10 +01002623 max_hs_frag_len : rem_len;
Hanno Becker67bc7c32018-08-06 11:33:50 +01002624
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 if (frag_off == 0 && cur_hs_frag_len != hs_len) {
2626 MBEDTLS_SSL_DEBUG_MSG(2, ("fragmenting handshake message (%u > %u)",
2627 (unsigned) cur_hs_frag_len,
2628 (unsigned) max_hs_frag_len));
Manuel Pégourié-Gonnard19c62f92018-08-16 10:50:39 +02002629 }
Manuel Pégourié-Gonnardb747c6c2018-08-12 13:28:53 +02002630
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002631 /* Messages are stored with handshake headers as if not fragmented,
2632 * copy beginning of headers then fill fragmentation fields.
2633 * Handshake headers: type(1) len(3) seq(2) f_off(3) f_len(3) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002634 memcpy(ssl->out_msg, cur->p, 6);
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002635
Gilles Peskine449bd832023-01-11 14:50:10 +01002636 ssl->out_msg[6] = MBEDTLS_BYTE_2(frag_off);
2637 ssl->out_msg[7] = MBEDTLS_BYTE_1(frag_off);
2638 ssl->out_msg[8] = MBEDTLS_BYTE_0(frag_off);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002639
Gilles Peskine449bd832023-01-11 14:50:10 +01002640 ssl->out_msg[9] = MBEDTLS_BYTE_2(cur_hs_frag_len);
2641 ssl->out_msg[10] = MBEDTLS_BYTE_1(cur_hs_frag_len);
2642 ssl->out_msg[11] = MBEDTLS_BYTE_0(cur_hs_frag_len);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002643
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 MBEDTLS_SSL_DEBUG_BUF(3, "handshake header", ssl->out_msg, 12);
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002645
Hanno Becker3f7b9732018-08-28 09:53:25 +01002646 /* Copy the handshake message content and set records fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002647 memcpy(ssl->out_msg + 12, p, cur_hs_frag_len);
Hanno Becker67bc7c32018-08-06 11:33:50 +01002648 ssl->out_msglen = cur_hs_frag_len + 12;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002649 ssl->out_msgtype = cur->type;
2650
2651 /* Update position inside current message */
Hanno Becker67bc7c32018-08-06 11:33:50 +01002652 ssl->handshake->cur_msg_p += cur_hs_frag_len;
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002653 }
2654
2655 /* If done with the current message move to the next one if any */
Gilles Peskine449bd832023-01-11 14:50:10 +01002656 if (ssl->handshake->cur_msg_p >= cur->p + cur->len) {
2657 if (cur->next != NULL) {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002658 ssl->handshake->cur_msg = cur->next;
2659 ssl->handshake->cur_msg_p = cur->next->p + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01002660 } else {
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +02002661 ssl->handshake->cur_msg = NULL;
2662 ssl->handshake->cur_msg_p = NULL;
2663 }
2664 }
2665
2666 /* Actually send the message out */
Gilles Peskine449bd832023-01-11 14:50:10 +01002667 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2668 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
2669 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002670 }
2671 }
2672
Gilles Peskine449bd832023-01-11 14:50:10 +01002673 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
2674 return ret;
Manuel Pégourié-Gonnard4e2f2452014-10-02 16:51:56 +02002675 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002676
Gilles Peskine449bd832023-01-11 14:50:10 +01002677 /* Update state and set timer */
2678 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
2679 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
2680 } else {
2681 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
2682 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
2683 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002684
Gilles Peskine449bd832023-01-11 14:50:10 +01002685 MBEDTLS_SSL_DEBUG_MSG(2, ("<= mbedtls_ssl_flight_transmit"));
2686
2687 return 0;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002688}
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002689
2690/*
2691 * To be called when the last message of an incoming flight is received.
2692 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002693void mbedtls_ssl_recv_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002694{
2695 /* We won't need to resend that one any more */
Gilles Peskine449bd832023-01-11 14:50:10 +01002696 mbedtls_ssl_flight_free(ssl->handshake->flight);
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002697 ssl->handshake->flight = NULL;
2698 ssl->handshake->cur_msg = NULL;
2699
2700 /* The next incoming flight will start with this msg_seq */
2701 ssl->handshake->in_flight_start_seq = ssl->handshake->in_msg_seq;
2702
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002703 /* We don't want to remember CCS's across flight boundaries. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01002704 ssl->handshake->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01002705
Hanno Becker0271f962018-08-16 13:23:47 +01002706 /* Clear future message buffering structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002707 mbedtls_ssl_buffering_free(ssl);
Hanno Becker0271f962018-08-16 13:23:47 +01002708
Manuel Pégourié-Gonnard6c1fa3a2014-10-01 16:58:16 +02002709 /* Cancel timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002711
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2713 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002714 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002715 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002716 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002717 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02002718}
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002719
2720/*
2721 * To be called when the last message of an outgoing flight is send.
2722 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002723void mbedtls_ssl_send_flight_completed(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002724{
Gilles Peskine449bd832023-01-11 14:50:10 +01002725 ssl_reset_retransmit_timeout(ssl);
2726 mbedtls_ssl_set_timer(ssl, ssl->handshake->retransmit_timeout);
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002727
Gilles Peskine449bd832023-01-11 14:50:10 +01002728 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2729 ssl->in_msg[0] == MBEDTLS_SSL_HS_FINISHED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002730 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_FINISHED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002731 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002732 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01002733 }
Manuel Pégourié-Gonnard7de3c9e2014-09-29 15:29:48 +02002734}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002735#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002736
Paul Bakker5121ce52009-01-03 21:22:43 +00002737/*
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002738 * Handshake layer functions
Paul Bakker5121ce52009-01-03 21:22:43 +00002739 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002740int mbedtls_ssl_start_handshake_msg(mbedtls_ssl_context *ssl, unsigned hs_type,
2741 unsigned char **buf, size_t *buf_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002742{
2743 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002744 * Reserve 4 bytes for handshake header. ( Section 4,RFC 8446 )
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002745 * ...
2746 * HandshakeType msg_type;
2747 * uint24 length;
2748 * ...
2749 */
2750 *buf = ssl->out_msg + 4;
2751 *buf_len = MBEDTLS_SSL_OUT_CONTENT_LEN - 4;
2752
2753 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
2754 ssl->out_msg[0] = hs_type;
2755
Gilles Peskine449bd832023-01-11 14:50:10 +01002756 return 0;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002757}
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002758
2759/*
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002760 * Write (DTLS: or queue) current handshake (including CCS) message.
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002761 *
2762 * - fill in handshake headers
2763 * - update handshake checksum
2764 * - DTLS: save message for resending
2765 * - then pass to the record layer
2766 *
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002767 * DTLS: except for HelloRequest, messages are only queued, and will only be
2768 * actually sent when calling flight_transmit() or resend().
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002769 *
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002770 * Inputs:
2771 * - ssl->out_msglen: 4 + actual handshake message len
2772 * (4 is the size of handshake headers for TLS)
2773 * - ssl->out_msg[0]: the handshake type (ClientHello, ServerHello, etc)
2774 * - ssl->out_msg + 4: the handshake message body
2775 *
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02002776 * Outputs, ie state before passing to flight_append() or write_record():
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002777 * - ssl->out_msglen: the length of the record contents
2778 * (including handshake headers but excluding record headers)
2779 * - ssl->out_msg: the record contents (handshake headers + content)
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002780 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002781int mbedtls_ssl_write_handshake_msg_ext(mbedtls_ssl_context *ssl,
2782 int update_checksum,
2783 int force_flush)
Paul Bakker5121ce52009-01-03 21:22:43 +00002784{
Janos Follath865b3eb2019-12-16 11:46:15 +00002785 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002786 const size_t hs_len = ssl->out_msglen - 4;
2787 const unsigned char hs_type = ssl->out_msg[0];
Paul Bakker5121ce52009-01-03 21:22:43 +00002788
Gilles Peskine449bd832023-01-11 14:50:10 +01002789 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002790
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002791 /*
2792 * Sanity checks
2793 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 if (ssl->out_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE &&
2795 ssl->out_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
2796 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2797 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002798 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002799
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002800 /* Whenever we send anything different from a
2801 * HelloRequest we should be in a handshake - double check. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002802 if (!(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2803 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST) &&
2804 ssl->handshake == NULL) {
2805 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2806 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002807 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002808
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002809#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002810 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002811 ssl->handshake != NULL &&
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
2813 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
2814 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002815 }
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002816#endif
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002817
Hanno Beckerb50a2532018-08-06 11:52:54 +01002818 /* Double-check that we did not exceed the bounds
2819 * of the outgoing record buffer.
2820 * This should never fail as the various message
2821 * writing functions must obey the bounds of the
2822 * outgoing record buffer, but better be safe.
2823 *
2824 * Note: We deliberately do not check for the MTU or MFL here.
2825 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002826 if (ssl->out_msglen > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2827 MBEDTLS_SSL_DEBUG_MSG(1, ("Record too large: "
2828 "size %" MBEDTLS_PRINTF_SIZET
2829 ", maximum %" MBEDTLS_PRINTF_SIZET,
2830 ssl->out_msglen,
2831 (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
2832 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerb50a2532018-08-06 11:52:54 +01002833 }
2834
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002835 /*
2836 * Fill handshake headers
2837 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 if (ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
2839 ssl->out_msg[1] = MBEDTLS_BYTE_2(hs_len);
2840 ssl->out_msg[2] = MBEDTLS_BYTE_1(hs_len);
2841 ssl->out_msg[3] = MBEDTLS_BYTE_0(hs_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00002842
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002843 /*
2844 * DTLS has additional fields in the Handshake layer,
2845 * between the length field and the actual payload:
2846 * uint16 message_seq;
2847 * uint24 fragment_offset;
2848 * uint24 fragment_length;
2849 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002850#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002852 /* Make room for the additional DTLS fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01002853 if (MBEDTLS_SSL_OUT_CONTENT_LEN - ssl->out_msglen < 8) {
2854 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS handshake message too large: "
2855 "size %" MBEDTLS_PRINTF_SIZET ", maximum %"
2856 MBEDTLS_PRINTF_SIZET,
2857 hs_len,
2858 (size_t) (MBEDTLS_SSL_OUT_CONTENT_LEN - 12)));
2859 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker9648f8b2017-09-18 10:55:54 +01002860 }
2861
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 memmove(ssl->out_msg + 12, ssl->out_msg + 4, hs_len);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002863 ssl->out_msglen += 8;
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002864
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002865 /* Write message_seq and update it, except for HelloRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01002866 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST) {
2867 MBEDTLS_PUT_UINT16_BE(ssl->handshake->out_msg_seq, ssl->out_msg, 4);
2868 ++(ssl->handshake->out_msg_seq);
2869 } else {
Manuel Pégourié-Gonnardc392b242014-08-19 17:53:11 +02002870 ssl->out_msg[4] = 0;
2871 ssl->out_msg[5] = 0;
2872 }
Manuel Pégourié-Gonnarde89bcf02014-02-18 18:50:02 +01002873
Manuel Pégourié-Gonnard9c3a8ca2017-09-13 09:54:27 +02002874 /* Handshake hashes are computed without fragmentation,
2875 * so set frag_offset = 0 and frag_len = hs_len for now */
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 memset(ssl->out_msg + 6, 0x00, 3);
2877 memcpy(ssl->out_msg + 9, ssl->out_msg + 1, 3);
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002878 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002879#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardce441b32014-02-18 17:40:52 +01002880
Hanno Becker0207e532018-08-28 10:28:28 +01002881 /* Update running hashes of handshake messages seen */
Gilles Peskine449bd832023-01-11 14:50:10 +01002882 if (hs_type != MBEDTLS_SSL_HS_HELLO_REQUEST && update_checksum != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002883 ret = ssl->handshake->update_checksum(ssl, ssl->out_msg,
2884 ssl->out_msglen);
2885 if (ret != 0) {
2886 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
2887 return ret;
2888 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002889 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002890 }
2891
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002892 /* Either send now, or just save to be sent (and resent) later */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002893#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002894 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
2895 !(ssl->out_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
2896 hs_type == MBEDTLS_SSL_HS_HELLO_REQUEST)) {
2897 if ((ret = ssl_flight_append(ssl)) != 0) {
2898 MBEDTLS_SSL_DEBUG_RET(1, "ssl_flight_append", ret);
2899 return ret;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002900 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002901 } else
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002902#endif
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002903 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 if ((ret = mbedtls_ssl_write_record(ssl, force_flush)) != 0) {
2905 MBEDTLS_SSL_DEBUG_RET(1, "ssl_write_record", ret);
2906 return ret;
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02002907 }
2908 }
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002909
Gilles Peskine449bd832023-01-11 14:50:10 +01002910 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write handshake message"));
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002911
Gilles Peskine449bd832023-01-11 14:50:10 +01002912 return 0;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002913}
2914
Gilles Peskine449bd832023-01-11 14:50:10 +01002915int mbedtls_ssl_finish_handshake_msg(mbedtls_ssl_context *ssl,
2916 size_t buf_len, size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002917{
2918 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2919 size_t msg_with_header_len;
2920 ((void) buf_len);
2921
2922 /* Add reserved 4 bytes for handshake header */
2923 msg_with_header_len = msg_len + 4;
2924 ssl->out_msglen = msg_with_header_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002925 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_write_handshake_msg_ext(ssl, 0, 0));
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002926
2927cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002928 return ret;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002929}
2930
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002931/*
2932 * Record layer functions
2933 */
2934
2935/*
2936 * Write current record.
2937 *
2938 * Uses:
2939 * - ssl->out_msgtype: type of the message (AppData, Handshake, Alert, CCS)
2940 * - ssl->out_msglen: length of the record content (excl headers)
2941 * - ssl->out_msg: record content
2942 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002943int mbedtls_ssl_write_record(mbedtls_ssl_context *ssl, int force_flush)
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002944{
2945 int ret, done = 0;
2946 size_t len = ssl->out_msglen;
Ronald Cron00d012f22022-03-08 15:57:12 +01002947 int flush = force_flush;
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02002948
Gilles Peskine449bd832023-01-11 14:50:10 +01002949 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write record"));
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +02002950
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 if (!done) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01002952 unsigned i;
2953 size_t protected_record_size;
Darryl Greenb33cc762019-11-28 14:29:44 +00002954#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
2955 size_t out_buf_len = ssl->out_buf_len;
2956#else
2957 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
2958#endif
Hanno Becker6430faf2019-05-08 11:57:13 +01002959 /* Skip writing the record content type to after the encryption,
2960 * as it may change when using the CID extension. */
Glenn Strauss60bfe602022-03-14 19:04:24 -04002961 mbedtls_ssl_protocol_version tls_ver = ssl->tls_version;
Ronald Cron6f135e12021-12-08 16:57:54 +01002962#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu1ca80f72021-11-08 10:30:54 +08002963 /* TLS 1.3 still uses the TLS 1.2 version identifier
2964 * for backwards compatibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002965 if (tls_ver == MBEDTLS_SSL_VERSION_TLS1_3) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002966 tls_ver = MBEDTLS_SSL_VERSION_TLS1_2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 }
Ronald Cron6f135e12021-12-08 16:57:54 +01002968#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002969 mbedtls_ssl_write_version(ssl->out_hdr + 1, ssl->conf->transport,
2970 tls_ver);
Hanno Becker6430faf2019-05-08 11:57:13 +01002971
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 memcpy(ssl->out_ctr, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
2973 MBEDTLS_PUT_UINT16_BE(len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00002974
Gilles Peskine449bd832023-01-11 14:50:10 +01002975 if (ssl->transform_out != NULL) {
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002976 mbedtls_record rec;
2977
2978 rec.buf = ssl->out_iv;
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 rec.buf_len = out_buf_len - (ssl->out_iv - ssl->out_buf);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002980 rec.data_len = ssl->out_msglen;
2981 rec.data_offset = ssl->out_msg - rec.buf;
2982
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 memcpy(&rec.ctr[0], ssl->out_ctr, sizeof(rec.ctr));
2984 mbedtls_ssl_write_version(rec.ver, ssl->conf->transport, tls_ver);
Hanno Becker9eddaeb2017-12-27 21:37:21 +00002985 rec.type = ssl->out_msgtype;
2986
Hanno Beckera0e20d02019-05-15 14:03:01 +01002987#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker43c24b82019-05-01 09:45:57 +01002988 /* The CID is set by mbedtls_ssl_encrypt_buf(). */
Hanno Beckercab87e62019-04-29 13:52:53 +01002989 rec.cid_len = 0;
Hanno Beckera0e20d02019-05-15 14:03:01 +01002990#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckercab87e62019-04-29 13:52:53 +01002991
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 if ((ret = mbedtls_ssl_encrypt_buf(ssl, ssl->transform_out, &rec,
2993 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
2994 MBEDTLS_SSL_DEBUG_RET(1, "ssl_encrypt_buf", ret);
2995 return ret;
Paul Bakker05ef8352012-05-08 09:17:57 +00002996 }
2997
Gilles Peskine449bd832023-01-11 14:50:10 +01002998 if (rec.data_offset != 0) {
2999 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
3000 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00003001 }
3002
Hanno Becker6430faf2019-05-08 11:57:13 +01003003 /* Update the record content type and CID. */
3004 ssl->out_msgtype = rec.type;
Gilles Peskine449bd832023-01-11 14:50:10 +01003005#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3006 memcpy(ssl->out_cid, rec.cid, rec.cid_len);
Hanno Beckera0e20d02019-05-15 14:03:01 +01003007#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker78f839d2019-03-14 12:56:23 +00003008 ssl->out_msglen = len = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003009 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->out_len, 0);
Paul Bakker05ef8352012-05-08 09:17:57 +00003010 }
3011
Gilles Peskine449bd832023-01-11 14:50:10 +01003012 protected_record_size = len + mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003013
3014#if defined(MBEDTLS_SSL_PROTO_DTLS)
3015 /* In case of DTLS, double-check that we don't exceed
3016 * the remaining space in the datagram. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003017 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3018 ret = ssl_get_remaining_space_in_datagram(ssl);
3019 if (ret < 0) {
3020 return ret;
3021 }
Hanno Becker2b1e3542018-08-06 11:19:13 +01003022
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 if (protected_record_size > (size_t) ret) {
Hanno Becker2b1e3542018-08-06 11:19:13 +01003024 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01003025 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker2b1e3542018-08-06 11:19:13 +01003026 }
3027 }
3028#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker05ef8352012-05-08 09:17:57 +00003029
Hanno Becker6430faf2019-05-08 11:57:13 +01003030 /* Now write the potentially updated record content type. */
3031 ssl->out_hdr[0] = (unsigned char) ssl->out_msgtype;
3032
Gilles Peskine449bd832023-01-11 14:50:10 +01003033 MBEDTLS_SSL_DEBUG_MSG(3, ("output record: msgtype = %u, "
3034 "version = [%u:%u], msglen = %" MBEDTLS_PRINTF_SIZET,
3035 ssl->out_hdr[0], ssl->out_hdr[1],
3036 ssl->out_hdr[2], len));
Paul Bakker05ef8352012-05-08 09:17:57 +00003037
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3039 ssl->out_hdr, protected_record_size);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003040
3041 ssl->out_left += protected_record_size;
3042 ssl->out_hdr += protected_record_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01003043 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_out);
Hanno Becker2b1e3542018-08-06 11:19:13 +01003044
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 for (i = 8; i > mbedtls_ssl_ep_len(ssl); i--) {
3046 if (++ssl->cur_out_ctr[i - 1] != 0) {
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02003047 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01003048 }
3049 }
Gabor Mezei05ebf3b2022-06-28 11:55:35 +02003050
Gabor Mezei96ae9262022-06-28 11:45:18 +02003051 /* The loop goes to its end if the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01003052 if (i == mbedtls_ssl_ep_len(ssl)) {
3053 MBEDTLS_SSL_DEBUG_MSG(1, ("outgoing message counter would wrap"));
3054 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker04484622018-08-06 09:49:38 +01003055 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003056 }
3057
Hanno Becker67bc7c32018-08-06 11:33:50 +01003058#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003059 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3060 flush == SSL_DONT_FORCE_FLUSH) {
Hanno Becker1f5a15d2018-08-21 13:31:31 +01003061 size_t remaining;
Gilles Peskine449bd832023-01-11 14:50:10 +01003062 ret = ssl_get_remaining_payload_in_datagram(ssl);
3063 if (ret < 0) {
3064 MBEDTLS_SSL_DEBUG_RET(1, "ssl_get_remaining_payload_in_datagram",
3065 ret);
3066 return ret;
Hanno Becker1f5a15d2018-08-21 13:31:31 +01003067 }
3068
3069 remaining = (size_t) ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003070 if (remaining == 0) {
Hanno Becker67bc7c32018-08-06 11:33:50 +01003071 flush = SSL_FORCE_FLUSH;
Gilles Peskine449bd832023-01-11 14:50:10 +01003072 } else {
3073 MBEDTLS_SSL_DEBUG_MSG(2,
3074 ("Still %u bytes available in current datagram",
3075 (unsigned) remaining));
Hanno Becker67bc7c32018-08-06 11:33:50 +01003076 }
3077 }
3078#endif /* MBEDTLS_SSL_PROTO_DTLS */
3079
Gilles Peskine449bd832023-01-11 14:50:10 +01003080 if ((flush == SSL_FORCE_FLUSH) &&
3081 (ret = mbedtls_ssl_flush_output(ssl)) != 0) {
3082 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
3083 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00003084 }
3085
Gilles Peskine449bd832023-01-11 14:50:10 +01003086 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write record"));
Paul Bakker5121ce52009-01-03 21:22:43 +00003087
Gilles Peskine449bd832023-01-11 14:50:10 +01003088 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003089}
3090
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003091#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere25e3b72018-08-16 09:30:53 +01003092
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003093MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003094static int ssl_hs_is_proper_fragment(mbedtls_ssl_context *ssl)
Hanno Beckere25e3b72018-08-16 09:30:53 +01003095{
Gilles Peskine449bd832023-01-11 14:50:10 +01003096 if (ssl->in_msglen < ssl->in_hslen ||
3097 memcmp(ssl->in_msg + 6, "\0\0\0", 3) != 0 ||
3098 memcmp(ssl->in_msg + 9, ssl->in_msg + 1, 3) != 0) {
3099 return 1;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003100 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003101 return 0;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003102}
Hanno Becker44650b72018-08-16 12:51:11 +01003103
Gilles Peskine449bd832023-01-11 14:50:10 +01003104static uint32_t ssl_get_hs_frag_len(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[9] << 16) |
3107 (ssl->in_msg[10] << 8) |
3108 ssl->in_msg[11];
Hanno Becker44650b72018-08-16 12:51:11 +01003109}
3110
Gilles Peskine449bd832023-01-11 14:50:10 +01003111static uint32_t ssl_get_hs_frag_off(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003112{
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 return (ssl->in_msg[6] << 16) |
3114 (ssl->in_msg[7] << 8) |
3115 ssl->in_msg[8];
Hanno Becker44650b72018-08-16 12:51:11 +01003116}
3117
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003118MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003119static int ssl_check_hs_header(mbedtls_ssl_context const *ssl)
Hanno Becker44650b72018-08-16 12:51:11 +01003120{
3121 uint32_t msg_len, frag_off, frag_len;
3122
Gilles Peskine449bd832023-01-11 14:50:10 +01003123 msg_len = ssl_get_hs_total_len(ssl);
3124 frag_off = ssl_get_hs_frag_off(ssl);
3125 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker44650b72018-08-16 12:51:11 +01003126
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 if (frag_off > msg_len) {
3128 return -1;
3129 }
Hanno Becker44650b72018-08-16 12:51:11 +01003130
Gilles Peskine449bd832023-01-11 14:50:10 +01003131 if (frag_len > msg_len - frag_off) {
3132 return -1;
3133 }
Hanno Becker44650b72018-08-16 12:51:11 +01003134
Gilles Peskine449bd832023-01-11 14:50:10 +01003135 if (frag_len + 12 > ssl->in_msglen) {
3136 return -1;
3137 }
Hanno Becker44650b72018-08-16 12:51:11 +01003138
Gilles Peskine449bd832023-01-11 14:50:10 +01003139 return 0;
Hanno Becker44650b72018-08-16 12:51:11 +01003140}
3141
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003142/*
3143 * Mark bits in bitmask (used for DTLS HS reassembly)
3144 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003145static void ssl_bitmask_set(unsigned char *mask, size_t offset, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003146{
3147 unsigned int start_bits, end_bits;
3148
Gilles Peskine449bd832023-01-11 14:50:10 +01003149 start_bits = 8 - (offset % 8);
3150 if (start_bits != 8) {
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003151 size_t first_byte_idx = offset / 8;
3152
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003153 /* Special case */
Gilles Peskine449bd832023-01-11 14:50:10 +01003154 if (len <= start_bits) {
3155 for (; len != 0; len--) {
3156 mask[first_byte_idx] |= 1 << (start_bits - len);
3157 }
Manuel Pégourié-Gonnardac030522014-09-02 14:23:40 +02003158
3159 /* Avoid potential issues with offset or len becoming invalid */
3160 return;
3161 }
3162
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003163 offset += start_bits; /* Now offset % 8 == 0 */
3164 len -= start_bits;
3165
Gilles Peskine449bd832023-01-11 14:50:10 +01003166 for (; start_bits != 0; start_bits--) {
3167 mask[first_byte_idx] |= 1 << (start_bits - 1);
3168 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003169 }
3170
3171 end_bits = len % 8;
Gilles Peskine449bd832023-01-11 14:50:10 +01003172 if (end_bits != 0) {
3173 size_t last_byte_idx = (offset + len) / 8;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003174
3175 len -= end_bits; /* Now len % 8 == 0 */
3176
Gilles Peskine449bd832023-01-11 14:50:10 +01003177 for (; end_bits != 0; end_bits--) {
3178 mask[last_byte_idx] |= 1 << (8 - end_bits);
3179 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003180 }
3181
Gilles Peskine449bd832023-01-11 14:50:10 +01003182 memset(mask + offset / 8, 0xFF, len / 8);
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003183}
3184
3185/*
3186 * Check that bitmask is full
3187 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003188MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003189static int ssl_bitmask_check(unsigned char *mask, size_t len)
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003190{
3191 size_t i;
3192
Gilles Peskine449bd832023-01-11 14:50:10 +01003193 for (i = 0; i < len / 8; i++) {
3194 if (mask[i] != 0xFF) {
3195 return -1;
3196 }
3197 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003198
Gilles Peskine449bd832023-01-11 14:50:10 +01003199 for (i = 0; i < len % 8; i++) {
3200 if ((mask[len / 8] & (1 << (7 - i))) == 0) {
3201 return -1;
3202 }
3203 }
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003204
Gilles Peskine449bd832023-01-11 14:50:10 +01003205 return 0;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003206}
3207
Hanno Becker56e205e2018-08-16 09:06:12 +01003208/* msg_len does not include the handshake header */
Gilles Peskine449bd832023-01-11 14:50:10 +01003209static size_t ssl_get_reassembly_buffer_size(size_t msg_len,
3210 unsigned add_bitmap)
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003211{
Hanno Becker56e205e2018-08-16 09:06:12 +01003212 size_t alloc_len;
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003213
Hanno Becker56e205e2018-08-16 09:06:12 +01003214 alloc_len = 12; /* Handshake header */
3215 alloc_len += msg_len; /* Content buffer */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003216
Gilles Peskine449bd832023-01-11 14:50:10 +01003217 if (add_bitmap) {
3218 alloc_len += msg_len / 8 + (msg_len % 8 != 0); /* Bitmap */
Manuel Pégourié-Gonnard502bf302014-08-20 13:12:58 +02003219
Gilles Peskine449bd832023-01-11 14:50:10 +01003220 }
3221 return alloc_len;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003222}
Hanno Becker56e205e2018-08-16 09:06:12 +01003223
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003224#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003225
Gilles Peskine449bd832023-01-11 14:50:10 +01003226static uint32_t ssl_get_hs_total_len(mbedtls_ssl_context const *ssl)
Hanno Becker12555c62018-08-16 12:47:53 +01003227{
Gilles Peskine449bd832023-01-11 14:50:10 +01003228 return (ssl->in_msg[1] << 16) |
3229 (ssl->in_msg[2] << 8) |
3230 ssl->in_msg[3];
Hanno Becker12555c62018-08-16 12:47:53 +01003231}
Hanno Beckere25e3b72018-08-16 09:30:53 +01003232
Gilles Peskine449bd832023-01-11 14:50:10 +01003233int mbedtls_ssl_prepare_handshake_record(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003234{
Gilles Peskine449bd832023-01-11 14:50:10 +01003235 if (ssl->in_msglen < mbedtls_ssl_hs_hdr_len(ssl)) {
3236 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake message too short: %" MBEDTLS_PRINTF_SIZET,
3237 ssl->in_msglen));
3238 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02003239 }
3240
Gilles Peskine449bd832023-01-11 14:50:10 +01003241 ssl->in_hslen = mbedtls_ssl_hs_hdr_len(ssl) + ssl_get_hs_total_len(ssl);
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003242
Gilles Peskine449bd832023-01-11 14:50:10 +01003243 MBEDTLS_SSL_DEBUG_MSG(3, ("handshake message: msglen ="
3244 " %" MBEDTLS_PRINTF_SIZET ", type = %u, hslen = %"
3245 MBEDTLS_PRINTF_SIZET,
3246 ssl->in_msglen, ssl->in_msg[0], ssl->in_hslen));
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003247
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003248#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003249 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Janos Follath865b3eb2019-12-16 11:46:15 +00003250 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01003251 unsigned int recv_msg_seq = (ssl->in_msg[4] << 8) | ssl->in_msg[5];
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003252
Gilles Peskine449bd832023-01-11 14:50:10 +01003253 if (ssl_check_hs_header(ssl) != 0) {
3254 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid handshake header"));
3255 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker44650b72018-08-16 12:51:11 +01003256 }
3257
Gilles Peskine449bd832023-01-11 14:50:10 +01003258 if (ssl->handshake != NULL &&
3259 ((mbedtls_ssl_is_handshake_over(ssl) == 0 &&
3260 recv_msg_seq != ssl->handshake->in_msg_seq) ||
3261 (mbedtls_ssl_is_handshake_over(ssl) == 1 &&
3262 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO))) {
3263 if (recv_msg_seq > ssl->handshake->in_msg_seq) {
3264 MBEDTLS_SSL_DEBUG_MSG(2,
3265 (
3266 "received future handshake message of sequence number %u (next %u)",
3267 recv_msg_seq,
3268 ssl->handshake->in_msg_seq));
3269 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Becker9e1ec222018-08-15 15:54:43 +01003270 }
3271
Manuel Pégourié-Gonnardfc572dd2014-10-09 17:56:57 +02003272 /* Retransmit only on last message from previous flight, to avoid
3273 * too many retransmissions.
3274 * Besides, No sane server ever retransmits HelloVerifyRequest */
Gilles Peskine449bd832023-01-11 14:50:10 +01003275 if (recv_msg_seq == ssl->handshake->in_flight_start_seq - 1 &&
3276 ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST) {
3277 MBEDTLS_SSL_DEBUG_MSG(2, ("received message from last flight, "
3278 "message_seq = %u, start_of_flight = %u",
3279 recv_msg_seq,
3280 ssl->handshake->in_flight_start_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003281
Gilles Peskine449bd832023-01-11 14:50:10 +01003282 if ((ret = mbedtls_ssl_resend(ssl)) != 0) {
3283 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend", ret);
3284 return ret;
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003285 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003286 } else {
3287 MBEDTLS_SSL_DEBUG_MSG(2, ("dropping out-of-sequence message: "
3288 "message_seq = %u, expected = %u",
3289 recv_msg_seq,
3290 ssl->handshake->in_msg_seq));
Manuel Pégourié-Gonnard6a2bdfa2014-09-19 21:18:23 +02003291 }
3292
Gilles Peskine449bd832023-01-11 14:50:10 +01003293 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003294 }
3295 /* Wait until message completion to increment in_msg_seq */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003296
Hanno Becker6d97ef52018-08-16 13:09:04 +01003297 /* Message reassembly is handled alongside buffering of future
3298 * messages; the commonality is that both handshake fragments and
Hanno Becker83ab41c2018-08-28 17:19:38 +01003299 * future messages cannot be forwarded immediately to the
Hanno Becker6d97ef52018-08-16 13:09:04 +01003300 * handshake logic layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003301 if (ssl_hs_is_proper_fragment(ssl) == 1) {
3302 MBEDTLS_SSL_DEBUG_MSG(2, ("found fragmented DTLS handshake message"));
3303 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003304 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003305 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003306#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnarded79a4b2014-08-20 10:43:01 +02003307 /* With TLS we don't handle fragmentation (for now) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003308 if (ssl->in_msglen < ssl->in_hslen) {
3309 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS handshake fragmentation not supported"));
3310 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003311 }
3312
Gilles Peskine449bd832023-01-11 14:50:10 +01003313 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01003314}
3315
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003316int mbedtls_ssl_update_handshake_status(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01003317{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003318 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker0271f962018-08-16 13:23:47 +01003319 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Simon Butcher99000142016-10-13 17:21:01 +01003320
Gilles Peskine449bd832023-01-11 14:50:10 +01003321 if (mbedtls_ssl_is_handshake_over(ssl) == 0 && hs != NULL) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003322 ret = ssl->handshake->update_checksum(ssl, ssl->in_msg, ssl->in_hslen);
3323 if (ret != 0) {
3324 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
3325 return ret;
3326 }
Manuel Pégourié-Gonnard14bf7062015-06-23 14:07:13 +02003327 }
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003328
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003329 /* Handshake message is complete, increment counter */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003330#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003331 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
3332 ssl->handshake != NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01003333 unsigned offset;
3334 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Beckere25e3b72018-08-16 09:30:53 +01003335
Hanno Becker0271f962018-08-16 13:23:47 +01003336 /* Increment handshake sequence number */
3337 hs->in_msg_seq++;
3338
3339 /*
3340 * Clear up handshake buffering and reassembly structure.
3341 */
3342
3343 /* Free first entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003344 ssl_buffering_free_slot(ssl, 0);
Hanno Becker0271f962018-08-16 13:23:47 +01003345
3346 /* Shift all other entries */
Gilles Peskine449bd832023-01-11 14:50:10 +01003347 for (offset = 0, hs_buf = &hs->buffering.hs[0];
Hanno Beckere605b192018-08-21 15:59:07 +01003348 offset + 1 < MBEDTLS_SSL_MAX_BUFFERED_HS;
Gilles Peskine449bd832023-01-11 14:50:10 +01003349 offset++, hs_buf++) {
Hanno Becker0271f962018-08-16 13:23:47 +01003350 *hs_buf = *(hs_buf + 1);
3351 }
3352
3353 /* Create a fresh last entry */
Gilles Peskine449bd832023-01-11 14:50:10 +01003354 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02003355 }
3356#endif
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01003357 return 0;
Manuel Pégourié-Gonnarda59543a2014-02-18 11:33:49 +01003358}
3359
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003360/*
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003361 * DTLS anti-replay: RFC 6347 4.1.2.6
3362 *
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003363 * in_window is a field of bits numbered from 0 (lsb) to 63 (msb).
3364 * Bit n is set iff record number in_window_top - n has been seen.
3365 *
3366 * Usually, in_window_top is the last record number seen and the lsb of
3367 * in_window is set. The only exception is the initial state (record number 0
3368 * not seen yet).
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003369 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003370#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01003371void mbedtls_ssl_dtls_replay_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003372{
3373 ssl->in_window_top = 0;
3374 ssl->in_window = 0;
3375}
3376
Gilles Peskine449bd832023-01-11 14:50:10 +01003377static inline uint64_t ssl_load_six_bytes(unsigned char *buf)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003378{
Gilles Peskine449bd832023-01-11 14:50:10 +01003379 return ((uint64_t) buf[0] << 40) |
3380 ((uint64_t) buf[1] << 32) |
3381 ((uint64_t) buf[2] << 24) |
3382 ((uint64_t) buf[3] << 16) |
3383 ((uint64_t) buf[4] << 8) |
3384 ((uint64_t) buf[5]);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003385}
3386
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003387MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003388static int mbedtls_ssl_dtls_record_replay_check(mbedtls_ssl_context *ssl, uint8_t *record_in_ctr)
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003389{
Janos Follath865b3eb2019-12-16 11:46:15 +00003390 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003391 unsigned char *original_in_ctr;
3392
3393 // save original in_ctr
3394 original_in_ctr = ssl->in_ctr;
3395
3396 // use counter from record
3397 ssl->in_ctr = record_in_ctr;
3398
Gilles Peskine449bd832023-01-11 14:50:10 +01003399 ret = mbedtls_ssl_dtls_replay_check((mbedtls_ssl_context const *) ssl);
Arto Kinnunen7f8089b2019-10-29 11:13:33 +02003400
3401 // restore the counter
3402 ssl->in_ctr = original_in_ctr;
3403
3404 return ret;
3405}
3406
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003407/*
3408 * Return 0 if sequence number is acceptable, -1 otherwise
3409 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003410int mbedtls_ssl_dtls_replay_check(mbedtls_ssl_context const *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003411{
Gilles Peskine449bd832023-01-11 14:50:10 +01003412 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003413 uint64_t bit;
3414
Gilles Peskine449bd832023-01-11 14:50:10 +01003415 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
3416 return 0;
3417 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003418
Gilles Peskine449bd832023-01-11 14:50:10 +01003419 if (rec_seqnum > ssl->in_window_top) {
3420 return 0;
3421 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003422
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003423 bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003424
Gilles Peskine449bd832023-01-11 14:50:10 +01003425 if (bit >= 64) {
3426 return -1;
3427 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003428
Gilles Peskine449bd832023-01-11 14:50:10 +01003429 if ((ssl->in_window & ((uint64_t) 1 << bit)) != 0) {
3430 return -1;
3431 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003432
Gilles Peskine449bd832023-01-11 14:50:10 +01003433 return 0;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003434}
3435
3436/*
3437 * Update replay window on new validated record
3438 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003439void mbedtls_ssl_dtls_replay_update(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003440{
Gilles Peskine449bd832023-01-11 14:50:10 +01003441 uint64_t rec_seqnum = ssl_load_six_bytes(ssl->in_ctr + 2);
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003442
Gilles Peskine449bd832023-01-11 14:50:10 +01003443 if (ssl->conf->anti_replay == MBEDTLS_SSL_ANTI_REPLAY_DISABLED) {
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003444 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01003445 }
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003446
Gilles Peskine449bd832023-01-11 14:50:10 +01003447 if (rec_seqnum > ssl->in_window_top) {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003448 /* Update window_top and the contents of the window */
3449 uint64_t shift = rec_seqnum - ssl->in_window_top;
3450
Gilles Peskine449bd832023-01-11 14:50:10 +01003451 if (shift >= 64) {
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003452 ssl->in_window = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003453 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003454 ssl->in_window <<= shift;
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003455 ssl->in_window |= 1;
3456 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003457
3458 ssl->in_window_top = rec_seqnum;
Gilles Peskine449bd832023-01-11 14:50:10 +01003459 } else {
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003460 /* Mark that number as seen in the current window */
Manuel Pégourié-Gonnard4956fd72014-09-24 11:13:44 +02003461 uint64_t bit = ssl->in_window_top - rec_seqnum;
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003462
Gilles Peskine449bd832023-01-11 14:50:10 +01003463 if (bit < 64) { /* Always true, but be extra sure */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003464 ssl->in_window |= (uint64_t) 1 << bit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003465 }
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003466 }
3467}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003468#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003469
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003470#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003471/*
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003472 * Check if a datagram looks like a ClientHello with a valid cookie,
3473 * and if it doesn't, generate a HelloVerifyRequest message.
Simon Butcher0789aed2015-09-11 17:15:17 +01003474 * Both input and output include full DTLS headers.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003475 *
3476 * - if cookie is valid, return 0
3477 * - if ClientHello looks superficially valid but cookie is not,
3478 * fill obuf and set olen, then
3479 * return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED
3480 * - otherwise return a specific error code
3481 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003482MBEDTLS_CHECK_RETURN_CRITICAL
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003483MBEDTLS_STATIC_TESTABLE
3484int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003485 mbedtls_ssl_context *ssl,
3486 const unsigned char *cli_id, size_t cli_id_len,
3487 const unsigned char *in, size_t in_len,
3488 unsigned char *obuf, size_t buf_len, size_t *olen)
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003489{
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003490 size_t sid_len, cookie_len, epoch, fragment_offset;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003491 unsigned char *p;
3492
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003493 /*
3494 * Structure of ClientHello with record and handshake headers,
3495 * and expected values. We don't need to check a lot, more checks will be
3496 * done when actually parsing the ClientHello - skipping those checks
3497 * avoids code duplication and does not make cookie forging any easier.
3498 *
3499 * 0-0 ContentType type; copied, must be handshake
3500 * 1-2 ProtocolVersion version; copied
3501 * 3-4 uint16 epoch; copied, must be 0
3502 * 5-10 uint48 sequence_number; copied
3503 * 11-12 uint16 length; (ignored)
3504 *
3505 * 13-13 HandshakeType msg_type; (ignored)
3506 * 14-16 uint24 length; (ignored)
3507 * 17-18 uint16 message_seq; copied
3508 * 19-21 uint24 fragment_offset; copied, must be 0
3509 * 22-24 uint24 fragment_length; (ignored)
3510 *
3511 * 25-26 ProtocolVersion client_version; (ignored)
3512 * 27-58 Random random; (ignored)
3513 * 59-xx SessionID session_id; 1 byte len + sid_len content
3514 * 60+ opaque cookie<0..2^8-1>; 1 byte len + content
3515 * ...
3516 *
3517 * Minimum length is 61 bytes.
3518 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003519 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: in_len=%u",
3520 (unsigned) in_len));
3521 MBEDTLS_SSL_DEBUG_BUF(4, "cli_id", cli_id, cli_id_len);
3522 if (in_len < 61) {
3523 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: record too short"));
3524 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003525 }
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003526
Gilles Peskine449bd832023-01-11 14:50:10 +01003527 epoch = MBEDTLS_GET_UINT16_BE(in, 3);
3528 fragment_offset = MBEDTLS_GET_UINT24_BE(in, 19);
Andrzej Kurekcbe14ec2022-06-15 07:17:28 -04003529
Gilles Peskine449bd832023-01-11 14:50:10 +01003530 if (in[0] != MBEDTLS_SSL_MSG_HANDSHAKE || epoch != 0 ||
3531 fragment_offset != 0) {
3532 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: not a good ClientHello"));
3533 MBEDTLS_SSL_DEBUG_MSG(4, (" type=%u epoch=%u fragment_offset=%u",
3534 in[0], (unsigned) epoch,
3535 (unsigned) fragment_offset));
3536 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003537 }
3538
3539 sid_len = in[59];
Gilles Peskine449bd832023-01-11 14:50:10 +01003540 if (59 + 1 + sid_len + 1 > in_len) {
3541 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: sid_len=%u > %u",
3542 (unsigned) sid_len,
3543 (unsigned) in_len - 61));
3544 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003545 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003546 MBEDTLS_SSL_DEBUG_BUF(4, "sid received from network",
3547 in + 60, sid_len);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003548
3549 cookie_len = in[60 + sid_len];
Gilles Peskine449bd832023-01-11 14:50:10 +01003550 if (59 + 1 + sid_len + 1 + cookie_len > in_len) {
3551 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: cookie_len=%u > %u",
3552 (unsigned) cookie_len,
3553 (unsigned) (in_len - sid_len - 61)));
3554 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003555 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003556
Gilles Peskine449bd832023-01-11 14:50:10 +01003557 MBEDTLS_SSL_DEBUG_BUF(4, "cookie received from network",
3558 in + sid_len + 61, cookie_len);
3559 if (ssl->conf->f_cookie_check(ssl->conf->p_cookie,
3560 in + sid_len + 61, cookie_len,
3561 cli_id, cli_id_len) == 0) {
3562 MBEDTLS_SSL_DEBUG_MSG(4, ("check cookie: valid"));
3563 return 0;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003564 }
3565
3566 /*
3567 * If we get here, we've got an invalid cookie, let's prepare HVR.
3568 *
3569 * 0-0 ContentType type; copied
3570 * 1-2 ProtocolVersion version; copied
3571 * 3-4 uint16 epoch; copied
3572 * 5-10 uint48 sequence_number; copied
3573 * 11-12 uint16 length; olen - 13
3574 *
3575 * 13-13 HandshakeType msg_type; hello_verify_request
3576 * 14-16 uint24 length; olen - 25
3577 * 17-18 uint16 message_seq; copied
3578 * 19-21 uint24 fragment_offset; copied
3579 * 22-24 uint24 fragment_length; olen - 25
3580 *
3581 * 25-26 ProtocolVersion server_version; 0xfe 0xff
3582 * 27-27 opaque cookie<0..2^8-1>; cookie_len = olen - 27, cookie
3583 *
3584 * Minimum length is 28.
3585 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003586 if (buf_len < 28) {
3587 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3588 }
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003589
3590 /* Copy most fields and adapt others */
Gilles Peskine449bd832023-01-11 14:50:10 +01003591 memcpy(obuf, in, 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003592 obuf[13] = MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST;
3593 obuf[25] = 0xfe;
3594 obuf[26] = 0xff;
3595
3596 /* Generate and write actual cookie */
3597 p = obuf + 28;
Gilles Peskine449bd832023-01-11 14:50:10 +01003598 if (ssl->conf->f_cookie_write(ssl->conf->p_cookie,
3599 &p, obuf + buf_len,
3600 cli_id, cli_id_len) != 0) {
3601 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003602 }
3603
3604 *olen = p - obuf;
3605
3606 /* Go back and fill length fields */
Gilles Peskine449bd832023-01-11 14:50:10 +01003607 obuf[27] = (unsigned char) (*olen - 28);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003608
Gilles Peskine449bd832023-01-11 14:50:10 +01003609 obuf[14] = obuf[22] = MBEDTLS_BYTE_2(*olen - 25);
3610 obuf[15] = obuf[23] = MBEDTLS_BYTE_1(*olen - 25);
3611 obuf[16] = obuf[24] = MBEDTLS_BYTE_0(*olen - 25);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003612
Gilles Peskine449bd832023-01-11 14:50:10 +01003613 MBEDTLS_PUT_UINT16_BE(*olen - 13, obuf, 11);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003614
Gilles Peskine449bd832023-01-11 14:50:10 +01003615 return MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003616}
3617
3618/*
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003619 * Handle possible client reconnect with the same UDP quadruplet
3620 * (RFC 6347 Section 4.2.8).
3621 *
3622 * Called by ssl_parse_record_header() in case we receive an epoch 0 record
3623 * that looks like a ClientHello.
3624 *
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003625 * - if the input looks like a ClientHello without cookies,
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003626 * send back HelloVerifyRequest, then return 0
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003627 * - if the input looks like a ClientHello with a valid cookie,
3628 * reset the session of the current context, and
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +02003629 * return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003630 * - if anything goes wrong, return a specific error code
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003631 *
Manuel Pégourié-Gonnard824655c2020-03-11 12:51:42 +01003632 * This function is called (through ssl_check_client_reconnect()) when an
3633 * unexpected record is found in ssl_get_next_record(), which will discard the
3634 * record if we return 0, and bubble up the return value otherwise (this
3635 * includes the case of MBEDTLS_ERR_SSL_CLIENT_RECONNECT and of unexpected
3636 * errors, and is the right thing to do in both cases).
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003637 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003638MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003639static int ssl_handle_possible_reconnect(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003640{
Janos Follath865b3eb2019-12-16 11:46:15 +00003641 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003642 size_t len;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003643
Gilles Peskine449bd832023-01-11 14:50:10 +01003644 if (ssl->conf->f_cookie_write == NULL ||
3645 ssl->conf->f_cookie_check == NULL) {
Hanno Becker2fddd372019-07-10 14:37:41 +01003646 /* If we can't use cookies to verify reachability of the peer,
3647 * drop the record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003648 MBEDTLS_SSL_DEBUG_MSG(1, ("no cookie callbacks, "
3649 "can't check reconnect validity"));
3650 return 0;
Hanno Becker2fddd372019-07-10 14:37:41 +01003651 }
3652
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04003653 ret = mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01003654 ssl,
3655 ssl->cli_id, ssl->cli_id_len,
3656 ssl->in_buf, ssl->in_left,
3657 ssl->out_buf, MBEDTLS_SSL_OUT_CONTENT_LEN, &len);
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003658
Gilles Peskine449bd832023-01-11 14:50:10 +01003659 MBEDTLS_SSL_DEBUG_RET(2, "mbedtls_ssl_check_dtls_clihlo_cookie", ret);
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003660
Gilles Peskine449bd832023-01-11 14:50:10 +01003661 if (ret == MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED) {
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003662 int send_ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01003663 MBEDTLS_SSL_DEBUG_MSG(1, ("sending HelloVerifyRequest"));
3664 MBEDTLS_SSL_DEBUG_BUF(4, "output record sent to network",
3665 ssl->out_buf, len);
Brian J Murray1903fb32016-11-06 04:45:15 -08003666 /* Don't check write errors as we can't do anything here.
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003667 * If the error is permanent we'll catch it later,
3668 * if it's not, then hopefully it'll work next time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003669 send_ret = ssl->f_send(ssl->p_bio, ssl->out_buf, len);
3670 MBEDTLS_SSL_DEBUG_RET(2, "ssl->f_send", send_ret);
Manuel Pégourié-Gonnard243d70f2020-03-31 12:07:47 +02003671 (void) send_ret;
3672
Gilles Peskine449bd832023-01-11 14:50:10 +01003673 return 0;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003674 }
3675
Gilles Peskine449bd832023-01-11 14:50:10 +01003676 if (ret == 0) {
3677 MBEDTLS_SSL_DEBUG_MSG(1, ("cookie is valid, resetting context"));
3678 if ((ret = mbedtls_ssl_session_reset_int(ssl, 1)) != 0) {
3679 MBEDTLS_SSL_DEBUG_RET(1, "reset", ret);
3680 return ret;
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02003681 }
3682
Gilles Peskine449bd832023-01-11 14:50:10 +01003683 return MBEDTLS_ERR_SSL_CLIENT_RECONNECT;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003684 }
3685
Gilles Peskine449bd832023-01-11 14:50:10 +01003686 return ret;
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003687}
Manuel Pégourié-Gonnardddfe5d22015-09-09 12:46:16 +02003688#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard11331fc2015-09-08 10:30:55 +02003689
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003690MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003691static int ssl_check_record_type(uint8_t record_type)
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003692{
Gilles Peskine449bd832023-01-11 14:50:10 +01003693 if (record_type != MBEDTLS_SSL_MSG_HANDSHAKE &&
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003694 record_type != MBEDTLS_SSL_MSG_ALERT &&
3695 record_type != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003696 record_type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
3697 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003698 }
3699
Gilles Peskine449bd832023-01-11 14:50:10 +01003700 return 0;
Hanno Beckerf661c9c2019-05-03 13:25:54 +01003701}
3702
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02003703/*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003704 * ContentType type;
3705 * ProtocolVersion version;
3706 * uint16 epoch; // DTLS only
3707 * uint48 sequence_number; // DTLS only
3708 * uint16 length;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003709 *
3710 * Return 0 if header looks sane (and, for DTLS, the record is expected)
Simon Butcher207990d2015-12-16 01:51:30 +00003711 * MBEDTLS_ERR_SSL_INVALID_RECORD if the header looks bad,
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003712 * MBEDTLS_ERR_SSL_UNEXPECTED_RECORD (DTLS only) if sane but unexpected.
3713 *
3714 * With DTLS, mbedtls_ssl_read_record() will:
Simon Butcher207990d2015-12-16 01:51:30 +00003715 * 1. proceed with the record if this function returns 0
3716 * 2. drop only the current record if this function returns UNEXPECTED_RECORD
3717 * 3. return CLIENT_RECONNECT if this function return that value
3718 * 4. drop the whole datagram if this function returns anything else.
3719 * Point 2 is needed when the peer is resending, and we have already received
3720 * the first record from a datagram but are still waiting for the others.
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003721 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003722MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003723static int ssl_parse_record_header(mbedtls_ssl_context const *ssl,
3724 unsigned char *buf,
3725 size_t len,
3726 mbedtls_record *rec)
Paul Bakker5121ce52009-01-03 21:22:43 +00003727{
Glenn Strausse3af4cb2022-03-15 03:23:42 -04003728 mbedtls_ssl_protocol_version tls_version;
Paul Bakker5121ce52009-01-03 21:22:43 +00003729
Hanno Beckere5e7e782019-07-11 12:29:35 +01003730 size_t const rec_hdr_type_offset = 0;
3731 size_t const rec_hdr_type_len = 1;
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02003732
Hanno Beckere5e7e782019-07-11 12:29:35 +01003733 size_t const rec_hdr_version_offset = rec_hdr_type_offset +
3734 rec_hdr_type_len;
3735 size_t const rec_hdr_version_len = 2;
Paul Bakker5121ce52009-01-03 21:22:43 +00003736
Hanno Beckere5e7e782019-07-11 12:29:35 +01003737 size_t const rec_hdr_ctr_len = 8;
3738#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckerf5466252019-07-25 10:13:02 +01003739 uint32_t rec_epoch;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003740 size_t const rec_hdr_ctr_offset = rec_hdr_version_offset +
3741 rec_hdr_version_len;
3742
Hanno Beckera0e20d02019-05-15 14:03:01 +01003743#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7e782019-07-11 12:29:35 +01003744 size_t const rec_hdr_cid_offset = rec_hdr_ctr_offset +
3745 rec_hdr_ctr_len;
Hanno Beckerf5466252019-07-25 10:13:02 +01003746 size_t rec_hdr_cid_len = 0;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003747#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
3748#endif /* MBEDTLS_SSL_PROTO_DTLS */
3749
3750 size_t rec_hdr_len_offset; /* To be determined */
3751 size_t const rec_hdr_len_len = 2;
3752
3753 /*
3754 * Check minimum lengths for record header.
3755 */
3756
3757#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003758 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003759 rec_hdr_len_offset = rec_hdr_ctr_offset + rec_hdr_ctr_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003760 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003761#endif /* MBEDTLS_SSL_PROTO_DTLS */
3762 {
3763 rec_hdr_len_offset = rec_hdr_version_offset + rec_hdr_version_len;
3764 }
3765
Gilles Peskine449bd832023-01-11 14:50:10 +01003766 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3767 MBEDTLS_SSL_DEBUG_MSG(1,
3768 (
3769 "datagram of length %u too small to hold DTLS record header of length %u",
3770 (unsigned) len,
3771 (unsigned) (rec_hdr_len_len + rec_hdr_len_len)));
3772 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003773 }
3774
3775 /*
3776 * Parse and validate record content type
3777 */
3778
Gilles Peskine449bd832023-01-11 14:50:10 +01003779 rec->type = buf[rec_hdr_type_offset];
Hanno Beckere5e7e782019-07-11 12:29:35 +01003780
3781 /* Check record content type */
3782#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
3783 rec->cid_len = 0;
3784
Gilles Peskine449bd832023-01-11 14:50:10 +01003785 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere5e7e782019-07-11 12:29:35 +01003786 ssl->conf->cid_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003787 rec->type == MBEDTLS_SSL_MSG_CID) {
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003788 /* Shift pointers to account for record header including CID
3789 * struct {
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02003790 * ContentType outer_type = tls12_cid;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003791 * ProtocolVersion version;
3792 * uint16 epoch;
3793 * uint48 sequence_number;
Hanno Becker8e55b0f2019-05-23 17:03:19 +01003794 * opaque cid[cid_length]; // Additional field compared to
3795 * // default DTLS record format
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003796 * uint16 length;
3797 * opaque enc_content[DTLSCiphertext.length];
3798 * } DTLSCiphertext;
3799 */
3800
3801 /* So far, we only support static CID lengths
3802 * fixed in the configuration. */
Hanno Beckere5e7e782019-07-11 12:29:35 +01003803 rec_hdr_cid_len = ssl->conf->cid_len;
3804 rec_hdr_len_offset += rec_hdr_cid_len;
Hanno Beckere538d822019-07-10 14:50:10 +01003805
Gilles Peskine449bd832023-01-11 14:50:10 +01003806 if (len < rec_hdr_len_offset + rec_hdr_len_len) {
3807 MBEDTLS_SSL_DEBUG_MSG(1,
3808 (
3809 "datagram of length %u too small to hold DTLS record header including CID, length %u",
3810 (unsigned) len,
3811 (unsigned) (rec_hdr_len_offset + rec_hdr_len_len)));
3812 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere538d822019-07-10 14:50:10 +01003813 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003814
Manuel Pégourié-Gonnard7e821b52019-08-02 10:17:15 +02003815 /* configured CID len is guaranteed at most 255, see
3816 * MBEDTLS_SSL_CID_OUT_LEN_MAX in check_config.h */
3817 rec->cid_len = (uint8_t) rec_hdr_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003818 memcpy(rec->cid, buf + rec_hdr_cid_offset, rec_hdr_cid_len);
3819 } else
Hanno Beckera0e20d02019-05-15 14:03:01 +01003820#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003821 {
Gilles Peskine449bd832023-01-11 14:50:10 +01003822 if (ssl_check_record_type(rec->type)) {
3823 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type %u",
3824 (unsigned) rec->type));
3825 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere5e7e782019-07-11 12:29:35 +01003826 }
Manuel Pégourié-Gonnardedcbe542014-08-11 19:27:24 +02003827 }
3828
Hanno Beckere5e7e782019-07-11 12:29:35 +01003829 /*
3830 * Parse and validate record version
3831 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003832 rec->ver[0] = buf[rec_hdr_version_offset + 0];
3833 rec->ver[1] = buf[rec_hdr_version_offset + 1];
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01003834 tls_version = (mbedtls_ssl_protocol_version) mbedtls_ssl_read_version(
3835 buf + rec_hdr_version_offset,
3836 ssl->conf->transport);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003837
Gilles Peskine449bd832023-01-11 14:50:10 +01003838 if (tls_version > ssl->conf->max_tls_version) {
3839 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS version mismatch: got %u, expected max %u",
3840 (unsigned) tls_version,
3841 (unsigned) ssl->conf->max_tls_version));
Gilles Peskine364fd8b2022-02-15 23:53:36 +01003842
Gilles Peskine449bd832023-01-11 14:50:10 +01003843 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Paul Bakker5121ce52009-01-03 21:22:43 +00003844 }
Hanno Beckere5e7e782019-07-11 12:29:35 +01003845 /*
3846 * Parse/Copy record sequence number.
3847 */
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003848
Hanno Beckere5e7e782019-07-11 12:29:35 +01003849#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003850 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckere5e7e782019-07-11 12:29:35 +01003851 /* Copy explicit record sequence number from input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003852 memcpy(&rec->ctr[0], buf + rec_hdr_ctr_offset,
3853 rec_hdr_ctr_len);
3854 } else
Hanno Beckere5e7e782019-07-11 12:29:35 +01003855#endif /* MBEDTLS_SSL_PROTO_DTLS */
3856 {
3857 /* Copy implicit record sequence number from SSL context structure. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003858 memcpy(&rec->ctr[0], ssl->in_ctr, rec_hdr_ctr_len);
Hanno Beckere5e7e782019-07-11 12:29:35 +01003859 }
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003860
Hanno Beckere5e7e782019-07-11 12:29:35 +01003861 /*
3862 * Parse record length.
3863 */
3864
Hanno Beckere5e7e782019-07-11 12:29:35 +01003865 rec->data_offset = rec_hdr_len_offset + rec_hdr_len_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01003866 rec->data_len = ((size_t) buf[rec_hdr_len_offset + 0] << 8) |
3867 ((size_t) buf[rec_hdr_len_offset + 1] << 0);
3868 MBEDTLS_SSL_DEBUG_BUF(4, "input record header", buf, rec->data_offset);
Paul Bakker1a1fbba2014-04-30 14:38:05 +02003869
Gilles Peskine449bd832023-01-11 14:50:10 +01003870 MBEDTLS_SSL_DEBUG_MSG(3, ("input record: msgtype = %u, "
3871 "version = [0x%x], msglen = %" MBEDTLS_PRINTF_SIZET,
3872 rec->type, (unsigned) tls_version, rec->data_len));
Hanno Beckere5e7e782019-07-11 12:29:35 +01003873
3874 rec->buf = buf;
3875 rec->buf_len = rec->data_offset + rec->data_len;
Hanno Beckerca59c2b2019-05-08 12:03:28 +01003876
Gilles Peskine449bd832023-01-11 14:50:10 +01003877 if (rec->data_len == 0) {
3878 return MBEDTLS_ERR_SSL_INVALID_RECORD;
3879 }
Paul Bakker5121ce52009-01-03 21:22:43 +00003880
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003881 /*
Hanno Becker52c6dc62017-05-26 16:07:36 +01003882 * DTLS-related tests.
3883 * Check epoch before checking length constraint because
3884 * the latter varies with the epoch. E.g., if a ChangeCipherSpec
3885 * message gets duplicated before the corresponding Finished message,
3886 * the second ChangeCipherSpec should be discarded because it belongs
3887 * to an old epoch, but not because its length is shorter than
3888 * the minimum record length for packets using the new record transform.
3889 * Note that these two kinds of failures are handled differently,
3890 * as an unexpected record is silently skipped but an invalid
3891 * record leads to the entire datagram being dropped.
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003892 */
3893#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003894 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3895 rec_epoch = (rec->ctr[0] << 8) | rec->ctr[1];
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003896
Hanno Becker955a5c92019-07-10 17:12:07 +01003897 /* Check that the datagram is large enough to contain a record
3898 * of the advertised length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003899 if (len < rec->data_offset + rec->data_len) {
3900 MBEDTLS_SSL_DEBUG_MSG(1,
3901 (
3902 "Datagram of length %u too small to contain record of advertised length %u.",
3903 (unsigned) len,
3904 (unsigned) (rec->data_offset + rec->data_len)));
3905 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker955a5c92019-07-10 17:12:07 +01003906 }
Hanno Becker37cfe732019-07-10 17:20:01 +01003907
Hanno Becker37cfe732019-07-10 17:20:01 +01003908 /* Records from other, non-matching epochs are silently discarded.
3909 * (The case of same-port Client reconnects must be considered in
3910 * the caller). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003911 if (rec_epoch != ssl->in_epoch) {
3912 MBEDTLS_SSL_DEBUG_MSG(1, ("record from another epoch: "
3913 "expected %u, received %lu",
3914 ssl->in_epoch, (unsigned long) rec_epoch));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003915
Hanno Becker552f7472019-07-19 10:59:12 +01003916 /* Records from the next epoch are considered for buffering
3917 * (concretely: early Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01003918 if (rec_epoch == (unsigned) ssl->in_epoch + 1) {
3919 MBEDTLS_SSL_DEBUG_MSG(2, ("Consider record for buffering"));
3920 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003921 }
Hanno Becker5f066e72018-08-16 14:56:31 +01003922
Gilles Peskine449bd832023-01-11 14:50:10 +01003923 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003924 }
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003925#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker37cfe732019-07-10 17:20:01 +01003926 /* For records from the correct epoch, check whether their
3927 * sequence number has been seen before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003928 else if (mbedtls_ssl_dtls_record_replay_check((mbedtls_ssl_context *) ssl,
3929 &rec->ctr[0]) != 0) {
3930 MBEDTLS_SSL_DEBUG_MSG(1, ("replayed record"));
3931 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01003932 }
3933#endif
3934 }
3935#endif /* MBEDTLS_SSL_PROTO_DTLS */
3936
Gilles Peskine449bd832023-01-11 14:50:10 +01003937 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003938}
Paul Bakker5121ce52009-01-03 21:22:43 +00003939
Paul Bakker5121ce52009-01-03 21:22:43 +00003940
Hanno Becker2fddd372019-07-10 14:37:41 +01003941#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003942MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003943static int ssl_check_client_reconnect(mbedtls_ssl_context *ssl)
Hanno Becker2fddd372019-07-10 14:37:41 +01003944{
Gilles Peskine449bd832023-01-11 14:50:10 +01003945 unsigned int rec_epoch = (ssl->in_ctr[0] << 8) | ssl->in_ctr[1];
Hanno Becker2fddd372019-07-10 14:37:41 +01003946
3947 /*
3948 * Check for an epoch 0 ClientHello. We can't use in_msg here to
3949 * access the first byte of record content (handshake type), as we
3950 * have an active transform (possibly iv_len != 0), so use the
3951 * fact that the record header len is 13 instead.
3952 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003953 if (rec_epoch == 0 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003954 ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003955 mbedtls_ssl_is_handshake_over(ssl) == 1 &&
Hanno Becker2fddd372019-07-10 14:37:41 +01003956 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
3957 ssl->in_left > 13 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01003958 ssl->in_buf[13] == MBEDTLS_SSL_HS_CLIENT_HELLO) {
3959 MBEDTLS_SSL_DEBUG_MSG(1, ("possible client reconnect "
3960 "from the same port"));
3961 return ssl_handle_possible_reconnect(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003962 }
3963
Gilles Peskine449bd832023-01-11 14:50:10 +01003964 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00003965}
Hanno Becker2fddd372019-07-10 14:37:41 +01003966#endif /* MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE && MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003967
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003968/*
Manuel Pégourié-Gonnardc40b6852020-01-03 12:18:49 +01003969 * If applicable, decrypt record content
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003970 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003971MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003972static int ssl_prepare_record_content(mbedtls_ssl_context *ssl,
3973 mbedtls_record *rec)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02003974{
3975 int ret, done = 0;
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02003976
Gilles Peskine449bd832023-01-11 14:50:10 +01003977 MBEDTLS_SSL_DEBUG_BUF(4, "input record from network",
3978 rec->buf, rec->buf_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00003979
Ronald Cron7e38cba2021-11-24 12:43:39 +01003980 /*
3981 * In TLS 1.3, always treat ChangeCipherSpec records
3982 * as unencrypted. The only thing we do with them is
3983 * check the length and content and ignore them.
3984 */
Ronald Cron6f135e12021-12-08 16:57:54 +01003985#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003986 if (ssl->transform_in != NULL &&
3987 ssl->transform_in->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
3988 if (rec->type == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01003989 done = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003990 }
Ronald Cron7e38cba2021-11-24 12:43:39 +01003991 }
Ronald Cron6f135e12021-12-08 16:57:54 +01003992#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Cron7e38cba2021-11-24 12:43:39 +01003993
Gilles Peskine449bd832023-01-11 14:50:10 +01003994 if (!done && ssl->transform_in != NULL) {
Hanno Becker58ef0bf2019-07-12 09:35:58 +01003995 unsigned char const old_msg_type = rec->type;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00003996
Gilles Peskine449bd832023-01-11 14:50:10 +01003997 if ((ret = mbedtls_ssl_decrypt_buf(ssl, ssl->transform_in,
3998 rec)) != 0) {
3999 MBEDTLS_SSL_DEBUG_RET(1, "ssl_decrypt_buf", ret);
Hanno Becker8367ccc2019-05-14 11:30:10 +01004000
Hanno Beckera0e20d02019-05-15 14:03:01 +01004001#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01004002 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_CID &&
Hanno Becker8367ccc2019-05-14 11:30:10 +01004003 ssl->conf->ignore_unexpected_cid
Gilles Peskine449bd832023-01-11 14:50:10 +01004004 == MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
4005 MBEDTLS_SSL_DEBUG_MSG(3, ("ignoring unexpected CID"));
Hanno Becker16ded982019-05-08 13:02:55 +01004006 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Hanno Becker8367ccc2019-05-14 11:30:10 +01004007 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01004008#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker16ded982019-05-08 13:02:55 +01004009
Gilles Peskine449bd832023-01-11 14:50:10 +01004010 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004011 }
4012
Gilles Peskine449bd832023-01-11 14:50:10 +01004013 if (old_msg_type != rec->type) {
4014 MBEDTLS_SSL_DEBUG_MSG(4, ("record type after decrypt (before %d): %d",
4015 old_msg_type, rec->type));
Hanno Becker6430faf2019-05-08 11:57:13 +01004016 }
4017
Gilles Peskine449bd832023-01-11 14:50:10 +01004018 MBEDTLS_SSL_DEBUG_BUF(4, "input payload after decrypt",
4019 rec->buf + rec->data_offset, rec->data_len);
Hanno Becker1c0c37f2018-08-07 14:29:29 +01004020
Hanno Beckera0e20d02019-05-15 14:03:01 +01004021#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6430faf2019-05-08 11:57:13 +01004022 /* We have already checked the record content type
4023 * in ssl_parse_record_header(), failing or silently
4024 * dropping the record in the case of an unknown type.
4025 *
4026 * Since with the use of CIDs, the record content type
4027 * might change during decryption, re-check the record
4028 * content type, but treat a failure as fatal this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004029 if (ssl_check_record_type(rec->type)) {
4030 MBEDTLS_SSL_DEBUG_MSG(1, ("unknown record type"));
4031 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker6430faf2019-05-08 11:57:13 +01004032 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01004033#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6430faf2019-05-08 11:57:13 +01004034
Gilles Peskine449bd832023-01-11 14:50:10 +01004035 if (rec->data_len == 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004036#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004037 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2
4038 && rec->type != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004039 /* TLS v1.2 explicitly disallows zero-length messages which are not application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004040 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid zero-length message type: %d", ssl->in_msgtype));
4041 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004042 }
4043#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4044
4045 ssl->nb_zero++;
4046
4047 /*
4048 * Three or more empty messages may be a DoS attack
4049 * (excessive CPU consumption).
4050 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004051 if (ssl->nb_zero > 3) {
4052 MBEDTLS_SSL_DEBUG_MSG(1, ("received four consecutive empty "
4053 "messages, possible DoS attack"));
Hanno Becker6e7700d2019-05-08 10:38:32 +01004054 /* Treat the records as if they were not properly authenticated,
4055 * thereby failing the connection if we see more than allowed
4056 * by the configured bad MAC threshold. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004057 return MBEDTLS_ERR_SSL_INVALID_MAC;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004058 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004059 } else {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004060 ssl->nb_zero = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004061 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004062
4063#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004064 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004065 ; /* in_ctr read from peer, not maintained internally */
Gilles Peskine449bd832023-01-11 14:50:10 +01004066 } else
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004067#endif
4068 {
4069 unsigned i;
Gilles Peskine449bd832023-01-11 14:50:10 +01004070 for (i = MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
4071 i > mbedtls_ssl_ep_len(ssl); i--) {
4072 if (++ssl->in_ctr[i - 1] != 0) {
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004073 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004074 }
Jerry Yuae0b2e22021-10-08 15:21:19 +08004075 }
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004076
4077 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01004078 if (i == mbedtls_ssl_ep_len(ssl)) {
4079 MBEDTLS_SSL_DEBUG_MSG(1, ("incoming message counter would wrap"));
4080 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Hanno Becker2e24c3b2017-12-27 21:28:58 +00004081 }
4082 }
4083
Paul Bakker5121ce52009-01-03 21:22:43 +00004084 }
4085
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004086#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004087 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4088 mbedtls_ssl_dtls_replay_update(ssl);
Manuel Pégourié-Gonnardb47368a2014-09-24 13:29:58 +02004089 }
4090#endif
4091
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004092 /* Check actual (decrypted) record content length against
4093 * configured maximum. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004094 if (rec->data_len > MBEDTLS_SSL_IN_CONTENT_LEN) {
4095 MBEDTLS_SSL_DEBUG_MSG(1, ("bad message length"));
4096 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckerd96e10b2019-07-09 17:30:02 +01004097 }
4098
Gilles Peskine449bd832023-01-11 14:50:10 +01004099 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004100}
4101
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004102/*
4103 * Read a record.
4104 *
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02004105 * Silently ignore non-fatal alert (and for DTLS, invalid records as well,
4106 * RFC 6347 4.1.2.7) and continue reading until a valid record is found.
4107 *
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004108 */
Hanno Becker1097b342018-08-15 14:09:41 +01004109
4110/* Helper functions for mbedtls_ssl_read_record(). */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004111MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004112static int ssl_consume_current_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004113MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004114static int ssl_get_next_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004115MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004116static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl);
Hanno Becker4162b112018-08-15 14:05:04 +01004117
Gilles Peskine449bd832023-01-11 14:50:10 +01004118int mbedtls_ssl_read_record(mbedtls_ssl_context *ssl,
4119 unsigned update_hs_digest)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004120{
Janos Follath865b3eb2019-12-16 11:46:15 +00004121 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004122
Gilles Peskine449bd832023-01-11 14:50:10 +01004123 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read record"));
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004124
Gilles Peskine449bd832023-01-11 14:50:10 +01004125 if (ssl->keep_current_message == 0) {
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004126 do {
Simon Butcher99000142016-10-13 17:21:01 +01004127
Gilles Peskine449bd832023-01-11 14:50:10 +01004128 ret = ssl_consume_current_message(ssl);
4129 if (ret != 0) {
4130 return ret;
4131 }
Hanno Becker26994592018-08-15 14:14:59 +01004132
Gilles Peskine449bd832023-01-11 14:50:10 +01004133 if (ssl_record_is_in_progress(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004134 int dtls_have_buffered = 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004135#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Beckere74d5562018-08-15 14:26:08 +01004136
Hanno Becker40f50842018-08-15 14:48:01 +01004137 /* We only check for buffered messages if the
4138 * current datagram is fully consumed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4140 ssl_next_record_is_in_datagram(ssl) == 0) {
4141 if (ssl_load_buffered_message(ssl) == 0) {
David Horstmann10be1342022-10-06 18:31:25 +01004142 dtls_have_buffered = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004143 }
Hanno Becker40f50842018-08-15 14:48:01 +01004144 }
4145
Hanno Becker40f50842018-08-15 14:48:01 +01004146#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004147 if (dtls_have_buffered == 0) {
4148 ret = ssl_get_next_record(ssl);
4149 if (ret == MBEDTLS_ERR_SSL_CONTINUE_PROCESSING) {
Hanno Becker40f50842018-08-15 14:48:01 +01004150 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01004151 }
Hanno Becker40f50842018-08-15 14:48:01 +01004152
Gilles Peskine449bd832023-01-11 14:50:10 +01004153 if (ret != 0) {
4154 MBEDTLS_SSL_DEBUG_RET(1, ("ssl_get_next_record"), ret);
4155 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004156 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004157 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004158 }
4159
Gilles Peskine449bd832023-01-11 14:50:10 +01004160 ret = mbedtls_ssl_handle_message_type(ssl);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004161
Hanno Becker40f50842018-08-15 14:48:01 +01004162#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004163 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
Hanno Becker40f50842018-08-15 14:48:01 +01004164 /* Buffer future message */
Gilles Peskine449bd832023-01-11 14:50:10 +01004165 ret = ssl_buffer_message(ssl);
4166 if (ret != 0) {
4167 return ret;
4168 }
Hanno Becker40f50842018-08-15 14:48:01 +01004169
4170 ret = MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4171 }
4172#endif /* MBEDTLS_SSL_PROTO_DTLS */
4173
Gilles Peskine449bd832023-01-11 14:50:10 +01004174 } while (MBEDTLS_ERR_SSL_NON_FATAL == ret ||
4175 MBEDTLS_ERR_SSL_CONTINUE_PROCESSING == ret);
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004176
Gilles Peskine449bd832023-01-11 14:50:10 +01004177 if (0 != ret) {
4178 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_handle_message_type"), ret);
4179 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004180 }
4181
Gilles Peskine449bd832023-01-11 14:50:10 +01004182 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
4183 update_hs_digest == 1) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01004184 ret = mbedtls_ssl_update_handshake_status(ssl);
4185 if (0 != ret) {
4186 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_update_handshake_status"), ret);
4187 return ret;
4188 }
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004189 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004190 } else {
4191 MBEDTLS_SSL_DEBUG_MSG(2, ("reuse previously read message"));
Hanno Beckeraf0665d2017-05-24 09:16:26 +01004192 ssl->keep_current_message = 0;
Simon Butcher99000142016-10-13 17:21:01 +01004193 }
4194
Gilles Peskine449bd832023-01-11 14:50:10 +01004195 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read record"));
Simon Butcher99000142016-10-13 17:21:01 +01004196
Gilles Peskine449bd832023-01-11 14:50:10 +01004197 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004198}
4199
Hanno Becker40f50842018-08-15 14:48:01 +01004200#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004201MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004202static int ssl_next_record_is_in_datagram(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004203{
Gilles Peskine449bd832023-01-11 14:50:10 +01004204 if (ssl->in_left > ssl->next_record_offset) {
4205 return 1;
4206 }
Simon Butcher99000142016-10-13 17:21:01 +01004207
Gilles Peskine449bd832023-01-11 14:50:10 +01004208 return 0;
Hanno Becker40f50842018-08-15 14:48:01 +01004209}
4210
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004211MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004212static int ssl_load_buffered_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004213{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004214 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004215 mbedtls_ssl_hs_buffer *hs_buf;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004216 int ret = 0;
4217
Gilles Peskine449bd832023-01-11 14:50:10 +01004218 if (hs == NULL) {
4219 return -1;
4220 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004221
Gilles Peskine449bd832023-01-11 14:50:10 +01004222 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_message"));
Hanno Beckere00ae372018-08-20 09:39:42 +01004223
Gilles Peskine449bd832023-01-11 14:50:10 +01004224 if (ssl->state == MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC ||
4225 ssl->state == MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004226 /* Check if we have seen a ChangeCipherSpec before.
4227 * If yes, synthesize a CCS record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004228 if (!hs->buffering.seen_ccs) {
4229 MBEDTLS_SSL_DEBUG_MSG(2, ("CCS not seen in the current flight"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004230 ret = -1;
Hanno Becker0d4b3762018-08-20 09:36:59 +01004231 goto exit;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004232 }
4233
Gilles Peskine449bd832023-01-11 14:50:10 +01004234 MBEDTLS_SSL_DEBUG_MSG(2, ("Injecting buffered CCS message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004235 ssl->in_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
4236 ssl->in_msglen = 1;
4237 ssl->in_msg[0] = 1;
4238
4239 /* As long as they are equal, the exact value doesn't matter. */
4240 ssl->in_left = 0;
4241 ssl->next_record_offset = 0;
4242
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004243 hs->buffering.seen_ccs = 0;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004244 goto exit;
4245 }
Hanno Becker37f95322018-08-16 13:55:32 +01004246
Hanno Beckerb8f50142018-08-28 10:01:34 +01004247#if defined(MBEDTLS_DEBUG_C)
Hanno Becker37f95322018-08-16 13:55:32 +01004248 /* Debug only */
4249 {
4250 unsigned offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004251 for (offset = 1; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
Hanno Becker37f95322018-08-16 13:55:32 +01004252 hs_buf = &hs->buffering.hs[offset];
Gilles Peskine449bd832023-01-11 14:50:10 +01004253 if (hs_buf->is_valid == 1) {
4254 MBEDTLS_SSL_DEBUG_MSG(2, ("Future message with sequence number %u %s buffered.",
4255 hs->in_msg_seq + offset,
4256 hs_buf->is_complete ? "fully" : "partially"));
Hanno Becker37f95322018-08-16 13:55:32 +01004257 }
4258 }
4259 }
Hanno Beckerb8f50142018-08-28 10:01:34 +01004260#endif /* MBEDTLS_DEBUG_C */
Hanno Becker37f95322018-08-16 13:55:32 +01004261
4262 /* Check if we have buffered and/or fully reassembled the
4263 * next handshake message. */
4264 hs_buf = &hs->buffering.hs[0];
Gilles Peskine449bd832023-01-11 14:50:10 +01004265 if ((hs_buf->is_valid == 1) && (hs_buf->is_complete == 1)) {
Hanno Becker37f95322018-08-16 13:55:32 +01004266 /* Synthesize a record containing the buffered HS message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004267 size_t msg_len = (hs_buf->data[1] << 16) |
4268 (hs_buf->data[2] << 8) |
4269 hs_buf->data[3];
Hanno Becker37f95322018-08-16 13:55:32 +01004270
4271 /* Double-check that we haven't accidentally buffered
4272 * a message that doesn't fit into the input buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004273 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
4274 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4275 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004276 }
4277
Gilles Peskine449bd832023-01-11 14:50:10 +01004278 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message has been buffered - load"));
4279 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered handshake message (incl. header)",
4280 hs_buf->data, msg_len + 12);
Hanno Becker37f95322018-08-16 13:55:32 +01004281
4282 ssl->in_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4283 ssl->in_hslen = msg_len + 12;
4284 ssl->in_msglen = msg_len + 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01004285 memcpy(ssl->in_msg, hs_buf->data, ssl->in_hslen);
Hanno Becker37f95322018-08-16 13:55:32 +01004286
4287 ret = 0;
4288 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004289 } else {
4290 MBEDTLS_SSL_DEBUG_MSG(2, ("Next handshake message %u not or only partially bufffered",
4291 hs->in_msg_seq));
Hanno Becker37f95322018-08-16 13:55:32 +01004292 }
4293
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004294 ret = -1;
4295
4296exit:
4297
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_message"));
4299 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004300}
4301
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004302MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004303static int ssl_buffer_make_space(mbedtls_ssl_context *ssl,
4304 size_t desired)
Hanno Beckera02b0b42018-08-21 17:20:27 +01004305{
4306 int offset;
4307 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 MBEDTLS_SSL_DEBUG_MSG(2, ("Attempt to free buffered messages to have %u bytes available",
4309 (unsigned) desired));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004310
Hanno Becker01315ea2018-08-21 17:22:17 +01004311 /* Get rid of future records epoch first, if such exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 ssl_free_buffered_record(ssl);
Hanno Becker01315ea2018-08-21 17:22:17 +01004313
4314 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004315 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4316 hs->buffering.total_bytes_buffered)) {
4317 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing future epoch record"));
4318 return 0;
Hanno Becker01315ea2018-08-21 17:22:17 +01004319 }
Hanno Beckera02b0b42018-08-21 17:20:27 +01004320
Hanno Becker4f432ad2018-08-28 10:02:32 +01004321 /* We don't have enough space to buffer the next expected handshake
4322 * message. Remove buffers used for future messages to gain space,
4323 * starting with the most distant one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004324 for (offset = MBEDTLS_SSL_MAX_BUFFERED_HS - 1;
4325 offset >= 0; offset--) {
4326 MBEDTLS_SSL_DEBUG_MSG(2,
4327 (
4328 "Free buffering slot %d to make space for reassembly of next handshake message",
4329 offset));
Hanno Beckera02b0b42018-08-21 17:20:27 +01004330
Gilles Peskine449bd832023-01-11 14:50:10 +01004331 ssl_buffering_free_slot(ssl, (uint8_t) offset);
Hanno Beckera02b0b42018-08-21 17:20:27 +01004332
4333 /* Check if we have enough space available now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004334 if (desired <= (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4335 hs->buffering.total_bytes_buffered)) {
4336 MBEDTLS_SSL_DEBUG_MSG(2, ("Enough space available after freeing buffered HS messages"));
4337 return 0;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004338 }
4339 }
4340
Gilles Peskine449bd832023-01-11 14:50:10 +01004341 return -1;
Hanno Beckera02b0b42018-08-21 17:20:27 +01004342}
4343
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004344MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004345static int ssl_buffer_message(mbedtls_ssl_context *ssl)
Hanno Becker40f50842018-08-15 14:48:01 +01004346{
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004347 int ret = 0;
4348 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
4349
Gilles Peskine449bd832023-01-11 14:50:10 +01004350 if (hs == NULL) {
4351 return 0;
4352 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004353
Gilles Peskine449bd832023-01-11 14:50:10 +01004354 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_buffer_message"));
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004355
Gilles Peskine449bd832023-01-11 14:50:10 +01004356 switch (ssl->in_msgtype) {
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004357 case MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC:
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 MBEDTLS_SSL_DEBUG_MSG(2, ("Remember CCS message"));
Hanno Beckere678eaa2018-08-21 14:57:46 +01004359
Hanno Beckerd7f8ae22018-08-16 09:45:56 +01004360 hs->buffering.seen_ccs = 1;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004361 break;
4362
4363 case MBEDTLS_SSL_MSG_HANDSHAKE:
Hanno Becker37f95322018-08-16 13:55:32 +01004364 {
4365 unsigned recv_msg_seq_offset;
Gilles Peskine449bd832023-01-11 14:50:10 +01004366 unsigned recv_msg_seq = (ssl->in_msg[4] << 8) | ssl->in_msg[5];
Hanno Becker37f95322018-08-16 13:55:32 +01004367 mbedtls_ssl_hs_buffer *hs_buf;
4368 size_t msg_len = ssl->in_hslen - 12;
4369
4370 /* We should never receive an old handshake
4371 * message - double-check nonetheless. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004372 if (recv_msg_seq < ssl->handshake->in_msg_seq) {
4373 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4374 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker37f95322018-08-16 13:55:32 +01004375 }
4376
4377 recv_msg_seq_offset = recv_msg_seq - ssl->handshake->in_msg_seq;
Gilles Peskine449bd832023-01-11 14:50:10 +01004378 if (recv_msg_seq_offset >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Becker37f95322018-08-16 13:55:32 +01004379 /* Silently ignore -- message too far in the future */
Gilles Peskine449bd832023-01-11 14:50:10 +01004380 MBEDTLS_SSL_DEBUG_MSG(2,
4381 ("Ignore future HS message with sequence number %u, "
4382 "buffering window %u - %u",
4383 recv_msg_seq, ssl->handshake->in_msg_seq,
4384 ssl->handshake->in_msg_seq + MBEDTLS_SSL_MAX_BUFFERED_HS -
4385 1));
Hanno Becker37f95322018-08-16 13:55:32 +01004386
4387 goto exit;
4388 }
4389
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering HS message with sequence number %u, offset %u ",
4391 recv_msg_seq, recv_msg_seq_offset));
Hanno Becker37f95322018-08-16 13:55:32 +01004392
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 hs_buf = &hs->buffering.hs[recv_msg_seq_offset];
Hanno Becker37f95322018-08-16 13:55:32 +01004394
4395 /* Check if the buffering for this seq nr has already commenced. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004396 if (!hs_buf->is_valid) {
Hanno Becker2a97b0e2018-08-21 15:47:49 +01004397 size_t reassembly_buf_sz;
4398
Hanno Becker37f95322018-08-16 13:55:32 +01004399 hs_buf->is_fragmented =
Gilles Peskine449bd832023-01-11 14:50:10 +01004400 (ssl_hs_is_proper_fragment(ssl) == 1);
Hanno Becker37f95322018-08-16 13:55:32 +01004401
4402 /* We copy the message back into the input buffer
4403 * after reassembly, so check that it's not too large.
4404 * This is an implementation-specific limitation
4405 * and not one from the standard, hence it is not
4406 * checked in ssl_check_hs_header(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004407 if (msg_len + 12 > MBEDTLS_SSL_IN_CONTENT_LEN) {
Hanno Becker37f95322018-08-16 13:55:32 +01004408 /* Ignore message */
4409 goto exit;
4410 }
4411
Hanno Beckere0b150f2018-08-21 15:51:03 +01004412 /* Check if we have enough space to buffer the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 if (hs->buffering.total_bytes_buffered >
4414 MBEDTLS_SSL_DTLS_MAX_BUFFERING) {
4415 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4416 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004417 }
4418
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 reassembly_buf_sz = ssl_get_reassembly_buffer_size(msg_len,
4420 hs_buf->is_fragmented);
Hanno Beckere0b150f2018-08-21 15:51:03 +01004421
Gilles Peskine449bd832023-01-11 14:50:10 +01004422 if (reassembly_buf_sz > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4423 hs->buffering.total_bytes_buffered)) {
4424 if (recv_msg_seq_offset > 0) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004425 /* If we can't buffer a future message because
4426 * of space limitations -- ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004427 MBEDTLS_SSL_DEBUG_MSG(2,
4428 ("Buffering of future message of size %"
4429 MBEDTLS_PRINTF_SIZET
4430 " would exceed the compile-time limit %"
4431 MBEDTLS_PRINTF_SIZET
4432 " (already %" MBEDTLS_PRINTF_SIZET
4433 " bytes buffered) -- ignore\n",
4434 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4435 hs->buffering.total_bytes_buffered));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004436 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 } else {
4438 MBEDTLS_SSL_DEBUG_MSG(2,
4439 ("Buffering of future message of size %"
4440 MBEDTLS_PRINTF_SIZET
4441 " would exceed the compile-time limit %"
4442 MBEDTLS_PRINTF_SIZET
4443 " (already %" MBEDTLS_PRINTF_SIZET
4444 " bytes buffered) -- attempt to make space by freeing buffered future messages\n",
4445 msg_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4446 hs->buffering.total_bytes_buffered));
Hanno Beckere1801392018-08-21 16:51:05 +01004447 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004448
Gilles Peskine449bd832023-01-11 14:50:10 +01004449 if (ssl_buffer_make_space(ssl, reassembly_buf_sz) != 0) {
4450 MBEDTLS_SSL_DEBUG_MSG(2,
4451 ("Reassembly of next message of size %"
4452 MBEDTLS_PRINTF_SIZET
4453 " (%" MBEDTLS_PRINTF_SIZET
4454 " with bitmap) would exceed"
4455 " the compile-time limit %"
4456 MBEDTLS_PRINTF_SIZET
4457 " (already %" MBEDTLS_PRINTF_SIZET
4458 " bytes buffered) -- fail\n",
4459 msg_len,
4460 reassembly_buf_sz,
4461 (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4462 hs->buffering.total_bytes_buffered));
Hanno Becker55e9e2a2018-08-21 16:07:55 +01004463 ret = MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4464 goto exit;
4465 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004466 }
4467
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 MBEDTLS_SSL_DEBUG_MSG(2,
4469 ("initialize reassembly, total length = %"
4470 MBEDTLS_PRINTF_SIZET,
4471 msg_len));
Hanno Beckere0b150f2018-08-21 15:51:03 +01004472
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 hs_buf->data = mbedtls_calloc(1, reassembly_buf_sz);
4474 if (hs_buf->data == NULL) {
Hanno Beckere0b150f2018-08-21 15:51:03 +01004475 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
Hanno Becker37f95322018-08-16 13:55:32 +01004476 goto exit;
4477 }
Hanno Beckere0b150f2018-08-21 15:51:03 +01004478 hs_buf->data_len = reassembly_buf_sz;
Hanno Becker37f95322018-08-16 13:55:32 +01004479
4480 /* Prepare final header: copy msg_type, length and message_seq,
4481 * then add standardised fragment_offset and fragment_length */
Gilles Peskine449bd832023-01-11 14:50:10 +01004482 memcpy(hs_buf->data, ssl->in_msg, 6);
4483 memset(hs_buf->data + 6, 0, 3);
4484 memcpy(hs_buf->data + 9, hs_buf->data + 1, 3);
Hanno Becker37f95322018-08-16 13:55:32 +01004485
4486 hs_buf->is_valid = 1;
Hanno Beckere0b150f2018-08-21 15:51:03 +01004487
4488 hs->buffering.total_bytes_buffered += reassembly_buf_sz;
Gilles Peskine449bd832023-01-11 14:50:10 +01004489 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004490 /* Make sure msg_type and length are consistent */
Gilles Peskine449bd832023-01-11 14:50:10 +01004491 if (memcmp(hs_buf->data, ssl->in_msg, 4) != 0) {
4492 MBEDTLS_SSL_DEBUG_MSG(1, ("Fragment header mismatch - ignore"));
Hanno Becker37f95322018-08-16 13:55:32 +01004493 /* Ignore */
4494 goto exit;
4495 }
4496 }
4497
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 if (!hs_buf->is_complete) {
Hanno Becker37f95322018-08-16 13:55:32 +01004499 size_t frag_len, frag_off;
4500 unsigned char * const msg = hs_buf->data + 12;
4501
4502 /*
4503 * Check and copy current fragment
4504 */
4505
4506 /* Validation of header fields already done in
4507 * mbedtls_ssl_prepare_handshake_record(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 frag_off = ssl_get_hs_frag_off(ssl);
4509 frag_len = ssl_get_hs_frag_len(ssl);
Hanno Becker37f95322018-08-16 13:55:32 +01004510
Gilles Peskine449bd832023-01-11 14:50:10 +01004511 MBEDTLS_SSL_DEBUG_MSG(2, ("adding fragment, offset = %" MBEDTLS_PRINTF_SIZET
4512 ", length = %" MBEDTLS_PRINTF_SIZET,
4513 frag_off, frag_len));
4514 memcpy(msg + frag_off, ssl->in_msg + 12, frag_len);
Hanno Becker37f95322018-08-16 13:55:32 +01004515
Gilles Peskine449bd832023-01-11 14:50:10 +01004516 if (hs_buf->is_fragmented) {
Hanno Becker37f95322018-08-16 13:55:32 +01004517 unsigned char * const bitmask = msg + msg_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004518 ssl_bitmask_set(bitmask, frag_off, frag_len);
4519 hs_buf->is_complete = (ssl_bitmask_check(bitmask,
4520 msg_len) == 0);
4521 } else {
Hanno Becker37f95322018-08-16 13:55:32 +01004522 hs_buf->is_complete = 1;
4523 }
4524
Gilles Peskine449bd832023-01-11 14:50:10 +01004525 MBEDTLS_SSL_DEBUG_MSG(2, ("message %scomplete",
4526 hs_buf->is_complete ? "" : "not yet "));
Hanno Becker37f95322018-08-16 13:55:32 +01004527 }
4528
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004529 break;
Hanno Becker37f95322018-08-16 13:55:32 +01004530 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004531
4532 default:
Hanno Becker360bef32018-08-28 10:04:33 +01004533 /* We don't buffer other types of messages. */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004534 break;
4535 }
4536
4537exit:
4538
Gilles Peskine449bd832023-01-11 14:50:10 +01004539 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_buffer_message"));
4540 return ret;
Hanno Becker40f50842018-08-15 14:48:01 +01004541}
4542#endif /* MBEDTLS_SSL_PROTO_DTLS */
4543
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004544MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004545static int ssl_consume_current_message(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004546{
Hanno Becker4a810fb2017-05-24 16:27:30 +01004547 /*
Hanno Becker4a810fb2017-05-24 16:27:30 +01004548 * Consume last content-layer message and potentially
4549 * update in_msglen which keeps track of the contents'
4550 * consumption state.
4551 *
4552 * (1) Handshake messages:
4553 * Remove last handshake message, move content
4554 * and adapt in_msglen.
4555 *
4556 * (2) Alert messages:
4557 * Consume whole record content, in_msglen = 0.
4558 *
Hanno Becker4a810fb2017-05-24 16:27:30 +01004559 * (3) Change cipher spec:
4560 * Consume whole record content, in_msglen = 0.
4561 *
4562 * (4) Application data:
4563 * Don't do anything - the record layer provides
4564 * the application data as a stream transport
4565 * and consumes through mbedtls_ssl_read only.
4566 *
4567 */
4568
4569 /* Case (1): Handshake messages */
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 if (ssl->in_hslen != 0) {
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004571 /* Hard assertion to be sure that no application data
4572 * is in flight, as corrupting ssl->in_msglen during
4573 * ssl->in_offt != NULL is fatal. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 if (ssl->in_offt != NULL) {
4575 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4576 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004577 }
4578
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004579 /*
4580 * Get next Handshake message in the current record
4581 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004582
Hanno Becker4a810fb2017-05-24 16:27:30 +01004583 /* Notes:
Hanno Beckere72489d2017-10-23 13:23:50 +01004584 * (1) in_hslen is not necessarily the size of the
Hanno Becker4a810fb2017-05-24 16:27:30 +01004585 * current handshake content: If DTLS handshake
4586 * fragmentation is used, that's the fragment
4587 * size instead. Using the total handshake message
Hanno Beckere72489d2017-10-23 13:23:50 +01004588 * size here is faulty and should be changed at
4589 * some point.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004590 * (2) While it doesn't seem to cause problems, one
4591 * has to be very careful not to assume that in_hslen
4592 * is always <= in_msglen in a sensible communication.
4593 * Again, it's wrong for DTLS handshake fragmentation.
4594 * The following check is therefore mandatory, and
4595 * should not be treated as a silently corrected assertion.
Hanno Beckerbb9dd0c2017-06-08 11:55:34 +01004596 * Additionally, ssl->in_hslen might be arbitrarily out of
4597 * bounds after handling a DTLS message with an unexpected
4598 * sequence number, see mbedtls_ssl_prepare_handshake_record.
Hanno Becker4a810fb2017-05-24 16:27:30 +01004599 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004600 if (ssl->in_hslen < ssl->in_msglen) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004601 ssl->in_msglen -= ssl->in_hslen;
Gilles Peskine449bd832023-01-11 14:50:10 +01004602 memmove(ssl->in_msg, ssl->in_msg + ssl->in_hslen,
4603 ssl->in_msglen);
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004604
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 MBEDTLS_SSL_DEBUG_BUF(4, "remaining content in record",
4606 ssl->in_msg, ssl->in_msglen);
4607 } else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004608 ssl->in_msglen = 0;
4609 }
Manuel Pégourié-Gonnard4a175362014-09-09 17:45:31 +02004610
Hanno Becker4a810fb2017-05-24 16:27:30 +01004611 ssl->in_hslen = 0;
4612 }
4613 /* Case (4): Application data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004614 else if (ssl->in_offt != NULL) {
4615 return 0;
Hanno Becker4a810fb2017-05-24 16:27:30 +01004616 }
4617 /* Everything else (CCS & Alerts) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004618 else {
Hanno Becker4a810fb2017-05-24 16:27:30 +01004619 ssl->in_msglen = 0;
4620 }
4621
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 return 0;
Hanno Becker1097b342018-08-15 14:09:41 +01004623}
Hanno Becker4a810fb2017-05-24 16:27:30 +01004624
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004625MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004626static int ssl_record_is_in_progress(mbedtls_ssl_context *ssl)
Hanno Beckere74d5562018-08-15 14:26:08 +01004627{
Gilles Peskine449bd832023-01-11 14:50:10 +01004628 if (ssl->in_msglen > 0) {
4629 return 1;
4630 }
Hanno Beckere74d5562018-08-15 14:26:08 +01004631
Gilles Peskine449bd832023-01-11 14:50:10 +01004632 return 0;
Hanno Beckere74d5562018-08-15 14:26:08 +01004633}
4634
Hanno Becker5f066e72018-08-16 14:56:31 +01004635#if defined(MBEDTLS_SSL_PROTO_DTLS)
4636
Gilles Peskine449bd832023-01-11 14:50:10 +01004637static void ssl_free_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004638{
4639 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004640 if (hs == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004641 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004642 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004643
Gilles Peskine449bd832023-01-11 14:50:10 +01004644 if (hs->buffering.future_record.data != NULL) {
Hanno Becker01315ea2018-08-21 17:22:17 +01004645 hs->buffering.total_bytes_buffered -=
4646 hs->buffering.future_record.len;
4647
Gilles Peskine449bd832023-01-11 14:50:10 +01004648 mbedtls_free(hs->buffering.future_record.data);
Hanno Becker01315ea2018-08-21 17:22:17 +01004649 hs->buffering.future_record.data = NULL;
4650 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004651}
4652
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004653MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004654static int ssl_load_buffered_record(mbedtls_ssl_context *ssl)
Hanno Becker5f066e72018-08-16 14:56:31 +01004655{
4656 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 unsigned char *rec;
Hanno Becker5f066e72018-08-16 14:56:31 +01004658 size_t rec_len;
4659 unsigned rec_epoch;
Darryl Greenb33cc762019-11-28 14:29:44 +00004660#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4661 size_t in_buf_len = ssl->in_buf_len;
4662#else
4663 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
4664#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004665 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4666 return 0;
4667 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004668
Gilles Peskine449bd832023-01-11 14:50:10 +01004669 if (hs == NULL) {
4670 return 0;
4671 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004672
Hanno Becker5f066e72018-08-16 14:56:31 +01004673 rec = hs->buffering.future_record.data;
4674 rec_len = hs->buffering.future_record.len;
4675 rec_epoch = hs->buffering.future_record.epoch;
4676
Gilles Peskine449bd832023-01-11 14:50:10 +01004677 if (rec == NULL) {
4678 return 0;
4679 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004680
Hanno Becker4cb782d2018-08-20 11:19:05 +01004681 /* Only consider loading future records if the
4682 * input buffer is empty. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004683 if (ssl_next_record_is_in_datagram(ssl) == 1) {
4684 return 0;
4685 }
Hanno Becker4cb782d2018-08-20 11:19:05 +01004686
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 MBEDTLS_SSL_DEBUG_MSG(2, ("=> ssl_load_buffered_record"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004688
Gilles Peskine449bd832023-01-11 14:50:10 +01004689 if (rec_epoch != ssl->in_epoch) {
4690 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffered record not from current epoch."));
Hanno Becker5f066e72018-08-16 14:56:31 +01004691 goto exit;
4692 }
4693
Gilles Peskine449bd832023-01-11 14:50:10 +01004694 MBEDTLS_SSL_DEBUG_MSG(2, ("Found buffered record from current epoch - load"));
Hanno Becker5f066e72018-08-16 14:56:31 +01004695
4696 /* Double-check that the record is not too large */
Gilles Peskine449bd832023-01-11 14:50:10 +01004697 if (rec_len > in_buf_len - (size_t) (ssl->in_hdr - ssl->in_buf)) {
4698 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
4699 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Hanno Becker5f066e72018-08-16 14:56:31 +01004700 }
4701
Gilles Peskine449bd832023-01-11 14:50:10 +01004702 memcpy(ssl->in_hdr, rec, rec_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004703 ssl->in_left = rec_len;
4704 ssl->next_record_offset = 0;
4705
Gilles Peskine449bd832023-01-11 14:50:10 +01004706 ssl_free_buffered_record(ssl);
Hanno Becker5f066e72018-08-16 14:56:31 +01004707
4708exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004709 MBEDTLS_SSL_DEBUG_MSG(2, ("<= ssl_load_buffered_record"));
4710 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004711}
4712
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004713MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004714static int ssl_buffer_future_record(mbedtls_ssl_context *ssl,
4715 mbedtls_record const *rec)
Hanno Becker5f066e72018-08-16 14:56:31 +01004716{
4717 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
Hanno Becker5f066e72018-08-16 14:56:31 +01004718
4719 /* Don't buffer future records outside handshakes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004720 if (hs == NULL) {
4721 return 0;
4722 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004723
4724 /* Only buffer handshake records (we are only interested
4725 * in Finished messages). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004726 if (rec->type != MBEDTLS_SSL_MSG_HANDSHAKE) {
4727 return 0;
4728 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004729
4730 /* Don't buffer more than one future epoch record. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004731 if (hs->buffering.future_record.data != NULL) {
4732 return 0;
4733 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004734
Hanno Becker01315ea2018-08-21 17:22:17 +01004735 /* Don't buffer record if there's not enough buffering space remaining. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 if (rec->buf_len > (MBEDTLS_SSL_DTLS_MAX_BUFFERING -
4737 hs->buffering.total_bytes_buffered)) {
4738 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffering of future epoch record of size %" MBEDTLS_PRINTF_SIZET
4739 " would exceed the compile-time limit %" MBEDTLS_PRINTF_SIZET
4740 " (already %" MBEDTLS_PRINTF_SIZET
4741 " bytes buffered) -- ignore\n",
4742 rec->buf_len, (size_t) MBEDTLS_SSL_DTLS_MAX_BUFFERING,
4743 hs->buffering.total_bytes_buffered));
4744 return 0;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004745 }
4746
Hanno Becker5f066e72018-08-16 14:56:31 +01004747 /* Buffer record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004748 MBEDTLS_SSL_DEBUG_MSG(2, ("Buffer record from epoch %u",
4749 ssl->in_epoch + 1U));
4750 MBEDTLS_SSL_DEBUG_BUF(3, "Buffered record", rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004751
4752 /* ssl_parse_record_header() only considers records
4753 * of the next epoch as candidates for buffering. */
4754 hs->buffering.future_record.epoch = ssl->in_epoch + 1;
Hanno Becker519f15d2019-07-11 12:43:20 +01004755 hs->buffering.future_record.len = rec->buf_len;
Hanno Becker5f066e72018-08-16 14:56:31 +01004756
4757 hs->buffering.future_record.data =
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 mbedtls_calloc(1, hs->buffering.future_record.len);
4759 if (hs->buffering.future_record.data == NULL) {
Hanno Becker5f066e72018-08-16 14:56:31 +01004760 /* If we run out of RAM trying to buffer a
4761 * record from the next epoch, just ignore. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004762 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004763 }
4764
Gilles Peskine449bd832023-01-11 14:50:10 +01004765 memcpy(hs->buffering.future_record.data, rec->buf, rec->buf_len);
Hanno Becker5f066e72018-08-16 14:56:31 +01004766
Hanno Becker519f15d2019-07-11 12:43:20 +01004767 hs->buffering.total_bytes_buffered += rec->buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004768 return 0;
Hanno Becker5f066e72018-08-16 14:56:31 +01004769}
4770
4771#endif /* MBEDTLS_SSL_PROTO_DTLS */
4772
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004773MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004774static int ssl_get_next_record(mbedtls_ssl_context *ssl)
Hanno Becker1097b342018-08-15 14:09:41 +01004775{
Janos Follath865b3eb2019-12-16 11:46:15 +00004776 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckere5e7e782019-07-11 12:29:35 +01004777 mbedtls_record rec;
Hanno Becker1097b342018-08-15 14:09:41 +01004778
Hanno Becker5f066e72018-08-16 14:56:31 +01004779#if defined(MBEDTLS_SSL_PROTO_DTLS)
4780 /* We might have buffered a future record; if so,
4781 * and if the epoch matches now, load it.
4782 * On success, this call will set ssl->in_left to
4783 * the length of the buffered record, so that
4784 * the calls to ssl_fetch_input() below will
4785 * essentially be no-ops. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004786 ret = ssl_load_buffered_record(ssl);
4787 if (ret != 0) {
4788 return ret;
4789 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004790#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker4a810fb2017-05-24 16:27:30 +01004791
Hanno Beckerca59c2b2019-05-08 12:03:28 +01004792 /* Ensure that we have enough space available for the default form
4793 * of TLS / DTLS record headers (5 Bytes for TLS, 13 Bytes for DTLS,
4794 * with no space for CIDs counted in). */
Gilles Peskine449bd832023-01-11 14:50:10 +01004795 ret = mbedtls_ssl_fetch_input(ssl, mbedtls_ssl_in_hdr_len(ssl));
4796 if (ret != 0) {
4797 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4798 return ret;
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004799 }
4800
Gilles Peskine449bd832023-01-11 14:50:10 +01004801 ret = ssl_parse_record_header(ssl, ssl->in_hdr, ssl->in_left, &rec);
4802 if (ret != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004803#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4805 if (ret == MBEDTLS_ERR_SSL_EARLY_MESSAGE) {
4806 ret = ssl_buffer_future_record(ssl, &rec);
4807 if (ret != 0) {
4808 return ret;
4809 }
Hanno Becker5f066e72018-08-16 14:56:31 +01004810
4811 /* Fall through to handling of unexpected records */
4812 ret = MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
4813 }
4814
Gilles Peskine449bd832023-01-11 14:50:10 +01004815 if (ret == MBEDTLS_ERR_SSL_UNEXPECTED_RECORD) {
Hanno Becker2fddd372019-07-10 14:37:41 +01004816#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004817 /* Reset in pointers to default state for TLS/DTLS records,
4818 * assuming no CID and no offset between record content and
4819 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004820 mbedtls_ssl_update_in_pointers(ssl);
Hanno Beckerd8bf8ce2019-07-12 09:23:47 +01004821
Hanno Becker7ae20e02019-07-12 08:33:49 +01004822 /* Setup internal message pointers from record structure. */
4823 ssl->in_msgtype = rec.type;
4824#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4825 ssl->in_len = ssl->in_cid + rec.cid_len;
4826#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4827 ssl->in_iv = ssl->in_msg = ssl->in_len + 2;
4828 ssl->in_msglen = rec.data_len;
4829
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 ret = ssl_check_client_reconnect(ssl);
4831 MBEDTLS_SSL_DEBUG_RET(2, "ssl_check_client_reconnect", ret);
4832 if (ret != 0) {
4833 return ret;
4834 }
Hanno Becker2fddd372019-07-10 14:37:41 +01004835#endif
4836
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004837 /* Skip unexpected record (but not whole datagram) */
Hanno Becker4acada32019-07-11 12:48:53 +01004838 ssl->next_record_offset = rec.buf_len;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004839
Gilles Peskine449bd832023-01-11 14:50:10 +01004840 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding unexpected record "
4841 "(header)"));
4842 } else {
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004843 /* Skip invalid record and the rest of the datagram */
4844 ssl->next_record_offset = 0;
4845 ssl->in_left = 0;
4846
Gilles Peskine449bd832023-01-11 14:50:10 +01004847 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record "
4848 "(header)"));
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +01004849 }
4850
4851 /* Get next record */
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
4853 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004854#endif
Hanno Becker2fddd372019-07-10 14:37:41 +01004855 {
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 return ret;
Hanno Becker2fddd372019-07-10 14:37:41 +01004857 }
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004858 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004859
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004860#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004861 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckera8814792019-07-10 15:01:45 +01004862 /* Remember offset of next record within datagram. */
Hanno Beckerf50da502019-07-11 12:50:10 +01004863 ssl->next_record_offset = rec.buf_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 if (ssl->next_record_offset < ssl->in_left) {
4865 MBEDTLS_SSL_DEBUG_MSG(3, ("more than one record within datagram"));
Hanno Beckere65ce782017-05-22 14:47:48 +01004866 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004867 } else
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004868#endif
Hanno Beckera8814792019-07-10 15:01:45 +01004869 {
Hanno Becker955a5c92019-07-10 17:12:07 +01004870 /*
4871 * Fetch record contents from underlying transport.
4872 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 ret = mbedtls_ssl_fetch_input(ssl, rec.buf_len);
4874 if (ret != 0) {
4875 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_fetch_input", ret);
4876 return ret;
Hanno Beckera8814792019-07-10 15:01:45 +01004877 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004878
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004879 ssl->in_left = 0;
Hanno Beckera8814792019-07-10 15:01:45 +01004880 }
4881
4882 /*
4883 * Decrypt record contents.
4884 */
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004885
Gilles Peskine449bd832023-01-11 14:50:10 +01004886 if ((ret = ssl_prepare_record_content(ssl, &rec)) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004887#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004888 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004889 /* Silently discard invalid records */
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004891 /* Except when waiting for Finished as a bad mac here
4892 * probably means something went wrong in the handshake
4893 * (eg wrong psk used, mitm downgrade attempt, etc.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01004894 if (ssl->state == MBEDTLS_SSL_CLIENT_FINISHED ||
4895 ssl->state == MBEDTLS_SSL_SERVER_FINISHED) {
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004896#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004897 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4898 mbedtls_ssl_send_alert_message(ssl,
4899 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4900 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004901 }
4902#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004903 return ret;
Manuel Pégourié-Gonnard0a885742015-08-04 12:08:35 +02004904 }
4905
Gilles Peskine449bd832023-01-11 14:50:10 +01004906 if (ssl->conf->badmac_limit != 0 &&
4907 ++ssl->badmac_seen >= ssl->conf->badmac_limit) {
4908 MBEDTLS_SSL_DEBUG_MSG(1, ("too many records with bad MAC"));
4909 return MBEDTLS_ERR_SSL_INVALID_MAC;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004910 }
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02004911
Hanno Becker4a810fb2017-05-24 16:27:30 +01004912 /* As above, invalid records cause
4913 * dismissal of the whole datagram. */
4914
4915 ssl->next_record_offset = 0;
4916 ssl->in_left = 0;
4917
Gilles Peskine449bd832023-01-11 14:50:10 +01004918 MBEDTLS_SSL_DEBUG_MSG(1, ("discarding invalid record (mac)"));
4919 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004920 }
4921
Gilles Peskine449bd832023-01-11 14:50:10 +01004922 return ret;
4923 } else
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004924#endif
4925 {
4926 /* Error out (and send alert) on invalid records */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004927#if defined(MBEDTLS_SSL_ALL_ALERT_MESSAGES)
Gilles Peskine449bd832023-01-11 14:50:10 +01004928 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
4929 mbedtls_ssl_send_alert_message(ssl,
4930 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
4931 MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC);
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004932 }
4933#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004934 return ret;
Manuel Pégourié-Gonnard63eca932014-09-08 16:39:08 +02004935 }
4936 }
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004937
Hanno Becker44d89b22019-07-12 09:40:44 +01004938
4939 /* Reset in pointers to default state for TLS/DTLS records,
4940 * assuming no CID and no offset between record content and
4941 * record plaintext. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004942 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker44d89b22019-07-12 09:40:44 +01004943#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4944 ssl->in_len = ssl->in_cid + rec.cid_len;
4945#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
irwir89af51f2019-09-26 21:04:56 +03004946 ssl->in_iv = ssl->in_len + 2;
Hanno Becker44d89b22019-07-12 09:40:44 +01004947
Hanno Becker8685c822019-07-12 09:37:30 +01004948 /* The record content type may change during decryption,
4949 * so re-read it. */
4950 ssl->in_msgtype = rec.type;
4951 /* Also update the input buffer, because unfortunately
4952 * the server-side ssl_parse_client_hello() reparses the
4953 * record header when receiving a ClientHello initiating
4954 * a renegotiation. */
4955 ssl->in_hdr[0] = rec.type;
4956 ssl->in_msg = rec.buf + rec.data_offset;
4957 ssl->in_msglen = rec.data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004958 MBEDTLS_PUT_UINT16_BE(rec.data_len, ssl->in_len, 0);
Hanno Becker8685c822019-07-12 09:37:30 +01004959
Gilles Peskine449bd832023-01-11 14:50:10 +01004960 return 0;
Simon Butcher99000142016-10-13 17:21:01 +01004961}
4962
Gilles Peskine449bd832023-01-11 14:50:10 +01004963int mbedtls_ssl_handle_message_type(mbedtls_ssl_context *ssl)
Simon Butcher99000142016-10-13 17:21:01 +01004964{
Janos Follath865b3eb2019-12-16 11:46:15 +00004965 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Simon Butcher99000142016-10-13 17:21:01 +01004966
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02004967 /*
Manuel Pégourié-Gonnard167a3762014-09-08 16:14:10 +02004968 * Handle particular types of records
4969 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004970 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
4971 if ((ret = mbedtls_ssl_prepare_handshake_record(ssl)) != 0) {
4972 return ret;
Simon Butcher99000142016-10-13 17:21:01 +01004973 }
Paul Bakker5121ce52009-01-03 21:22:43 +00004974 }
4975
Gilles Peskine449bd832023-01-11 14:50:10 +01004976 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
4977 if (ssl->in_msglen != 1) {
4978 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, len: %" MBEDTLS_PRINTF_SIZET,
4979 ssl->in_msglen));
4980 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01004981 }
4982
Gilles Peskine449bd832023-01-11 14:50:10 +01004983 if (ssl->in_msg[0] != 1) {
4984 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid CCS message, content: %02x",
4985 ssl->in_msg[0]));
4986 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004987 }
4988
4989#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004990 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
Hanno Beckere678eaa2018-08-21 14:57:46 +01004991 ssl->state != MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC &&
Gilles Peskine449bd832023-01-11 14:50:10 +01004992 ssl->state != MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC) {
4993 if (ssl->handshake == NULL) {
4994 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping ChangeCipherSpec outside handshake"));
4995 return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD;
Hanno Beckere678eaa2018-08-21 14:57:46 +01004996 }
4997
Gilles Peskine449bd832023-01-11 14:50:10 +01004998 MBEDTLS_SSL_DEBUG_MSG(1, ("received out-of-order ChangeCipherSpec - remember"));
4999 return MBEDTLS_ERR_SSL_EARLY_MESSAGE;
Hanno Beckere678eaa2018-08-21 14:57:46 +01005000 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01005001#endif
Ronald Cron7e38cba2021-11-24 12:43:39 +01005002
Ronald Cron6f135e12021-12-08 16:57:54 +01005003#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005004 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron7e38cba2021-11-24 12:43:39 +01005005#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gilles Peskine449bd832023-01-11 14:50:10 +01005006 MBEDTLS_SSL_DEBUG_MSG(1,
5007 ("Ignore ChangeCipherSpec in TLS 1.3 compatibility mode"));
5008 return MBEDTLS_ERR_SSL_CONTINUE_PROCESSING;
Ronald Cron7e38cba2021-11-24 12:43:39 +01005009#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005010 MBEDTLS_SSL_DEBUG_MSG(1,
5011 ("ChangeCipherSpec invalid in TLS 1.3 without compatibility mode"));
5012 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Ronald Cron7e38cba2021-11-24 12:43:39 +01005013#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
5014 }
Ronald Cron6f135e12021-12-08 16:57:54 +01005015#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckere678eaa2018-08-21 14:57:46 +01005016 }
Hanno Becker2ed6bcc2018-08-15 15:11:57 +01005017
Gilles Peskine449bd832023-01-11 14:50:10 +01005018 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5019 if (ssl->in_msglen != 2) {
Angus Gratton1a7a17e2018-06-20 15:43:50 +10005020 /* Note: Standard allows for more than one 2 byte alert
5021 to be packed in a single message, but Mbed TLS doesn't
5022 currently support this. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005023 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid alert message, len: %" MBEDTLS_PRINTF_SIZET,
5024 ssl->in_msglen));
5025 return MBEDTLS_ERR_SSL_INVALID_RECORD;
Angus Gratton1a7a17e2018-06-20 15:43:50 +10005026 }
5027
Gilles Peskine449bd832023-01-11 14:50:10 +01005028 MBEDTLS_SSL_DEBUG_MSG(2, ("got an alert message, type: [%u:%u]",
5029 ssl->in_msg[0], ssl->in_msg[1]));
Paul Bakker5121ce52009-01-03 21:22:43 +00005030
5031 /*
Simon Butcher459a9502015-10-27 16:09:03 +00005032 * Ignore non-fatal alerts, except close_notify and no_renegotiation
Paul Bakker5121ce52009-01-03 21:22:43 +00005033 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005034 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_FATAL) {
5035 MBEDTLS_SSL_DEBUG_MSG(1, ("is a fatal alert message (msg %d)",
5036 ssl->in_msg[1]));
5037 return MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005038 }
5039
Gilles Peskine449bd832023-01-11 14:50:10 +01005040 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
5041 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY) {
5042 MBEDTLS_SSL_DEBUG_MSG(2, ("is a close notify message"));
5043 return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY;
Paul Bakker5121ce52009-01-03 21:22:43 +00005044 }
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005045
5046#if defined(MBEDTLS_SSL_RENEGOTIATION_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005047 if (ssl->in_msg[0] == MBEDTLS_SSL_ALERT_LEVEL_WARNING &&
5048 ssl->in_msg[1] == MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION) {
5049 MBEDTLS_SSL_DEBUG_MSG(2, ("is a no renegotiation alert"));
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005050 /* Will be handled when trying to parse ServerHello */
Gilles Peskine449bd832023-01-11 14:50:10 +01005051 return 0;
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005052 }
5053#endif
Manuel Pégourié-Gonnardfbdf06c2015-10-23 11:13:28 +02005054 /* Silently ignore: fetch new message */
Simon Butcher99000142016-10-13 17:21:01 +01005055 return MBEDTLS_ERR_SSL_NON_FATAL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005056 }
5057
Hanno Beckerc76c6192017-06-06 10:03:17 +01005058#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005059 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker37ae9522019-05-03 16:54:26 +01005060 /* Drop unexpected ApplicationData records,
5061 * except at the beginning of renegotiations */
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA &&
5063 mbedtls_ssl_is_handshake_over(ssl) == 0
Hanno Becker37ae9522019-05-03 16:54:26 +01005064#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 && !(ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS &&
5066 ssl->state == MBEDTLS_SSL_SERVER_HELLO)
Hanno Beckerc76c6192017-06-06 10:03:17 +01005067#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005068 ) {
5069 MBEDTLS_SSL_DEBUG_MSG(1, ("dropping unexpected ApplicationData"));
5070 return MBEDTLS_ERR_SSL_NON_FATAL;
Hanno Becker37ae9522019-05-03 16:54:26 +01005071 }
5072
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 if (ssl->handshake != NULL &&
5074 mbedtls_ssl_is_handshake_over(ssl) == 1) {
5075 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Hanno Becker37ae9522019-05-03 16:54:26 +01005076 }
5077 }
Hanno Becker4a4af9f2019-05-08 16:26:21 +01005078#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Beckerc76c6192017-06-06 10:03:17 +01005079
Gilles Peskine449bd832023-01-11 14:50:10 +01005080 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005081}
5082
Gilles Peskine449bd832023-01-11 14:50:10 +01005083int mbedtls_ssl_send_fatal_handshake_failure(mbedtls_ssl_context *ssl)
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005084{
Gilles Peskine449bd832023-01-11 14:50:10 +01005085 return mbedtls_ssl_send_alert_message(ssl,
5086 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5087 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE);
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00005088}
5089
Gilles Peskine449bd832023-01-11 14:50:10 +01005090int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
5091 unsigned char level,
5092 unsigned char message)
Paul Bakker0a925182012-04-16 06:46:41 +00005093{
Janos Follath865b3eb2019-12-16 11:46:15 +00005094 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker0a925182012-04-16 06:46:41 +00005095
Gilles Peskine449bd832023-01-11 14:50:10 +01005096 if (ssl == NULL || ssl->conf == NULL) {
5097 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5098 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005099
Gilles Peskine449bd832023-01-11 14:50:10 +01005100 if (ssl->out_left != 0) {
5101 return mbedtls_ssl_flush_output(ssl);
5102 }
Hanno Becker5e18f742018-08-06 11:35:16 +01005103
Gilles Peskine449bd832023-01-11 14:50:10 +01005104 MBEDTLS_SSL_DEBUG_MSG(2, ("=> send alert message"));
5105 MBEDTLS_SSL_DEBUG_MSG(3, ("send alert level=%u message=%u", level, message));
Paul Bakker0a925182012-04-16 06:46:41 +00005106
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005107 ssl->out_msgtype = MBEDTLS_SSL_MSG_ALERT;
Paul Bakker0a925182012-04-16 06:46:41 +00005108 ssl->out_msglen = 2;
5109 ssl->out_msg[0] = level;
5110 ssl->out_msg[1] = message;
5111
Gilles Peskine449bd832023-01-11 14:50:10 +01005112 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5113 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5114 return ret;
Paul Bakker0a925182012-04-16 06:46:41 +00005115 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005116 MBEDTLS_SSL_DEBUG_MSG(2, ("<= send alert message"));
Paul Bakker0a925182012-04-16 06:46:41 +00005117
Gilles Peskine449bd832023-01-11 14:50:10 +01005118 return 0;
Paul Bakker0a925182012-04-16 06:46:41 +00005119}
5120
Gilles Peskine449bd832023-01-11 14:50:10 +01005121int mbedtls_ssl_write_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005122{
Janos Follath865b3eb2019-12-16 11:46:15 +00005123 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005124
Gilles Peskine449bd832023-01-11 14:50:10 +01005125 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005126
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005127 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
Paul Bakker5121ce52009-01-03 21:22:43 +00005128 ssl->out_msglen = 1;
5129 ssl->out_msg[0] = 1;
5130
Paul Bakker5121ce52009-01-03 21:22:43 +00005131 ssl->state++;
5132
Gilles Peskine449bd832023-01-11 14:50:10 +01005133 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
5134 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
5135 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005136 }
5137
Gilles Peskine449bd832023-01-11 14:50:10 +01005138 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005139
Gilles Peskine449bd832023-01-11 14:50:10 +01005140 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005141}
5142
Gilles Peskine449bd832023-01-11 14:50:10 +01005143int mbedtls_ssl_parse_change_cipher_spec(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005144{
Janos Follath865b3eb2019-12-16 11:46:15 +00005145 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005146
Gilles Peskine449bd832023-01-11 14:50:10 +01005147 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005148
Gilles Peskine449bd832023-01-11 14:50:10 +01005149 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5150 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5151 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005152 }
5153
Gilles Peskine449bd832023-01-11 14:50:10 +01005154 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC) {
5155 MBEDTLS_SSL_DEBUG_MSG(1, ("bad change cipher spec message"));
5156 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
5157 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
5158 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005159 }
5160
Hanno Beckere678eaa2018-08-21 14:57:46 +01005161 /* CCS records are only accepted if they have length 1 and content '1',
5162 * so we don't need to check this here. */
Paul Bakker5121ce52009-01-03 21:22:43 +00005163
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005164 /*
5165 * Switch to our negotiated transform and session parameters for inbound
5166 * data.
5167 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for inbound data"));
Jerry Yu2e199812022-12-01 18:57:19 +08005169#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005170 ssl->transform_in = ssl->transform_negotiate;
Jerry Yu2e199812022-12-01 18:57:19 +08005171#endif
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005172 ssl->session_in = ssl->session_negotiate;
5173
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005174#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005176#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005177 mbedtls_ssl_dtls_replay_reset(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005178#endif
5179
5180 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005181 if (++ssl->in_epoch == 0) {
5182 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
Gilles Peskine1cc8e342017-05-03 16:28:34 +02005183 /* This is highly unlikely to happen for legitimate reasons, so
5184 treat it as an attack and don't send an alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005185 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005186 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005187 } else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005188#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005189 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005190
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 mbedtls_ssl_update_in_pointers(ssl);
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02005192
Paul Bakker5121ce52009-01-03 21:22:43 +00005193 ssl->state++;
5194
Gilles Peskine449bd832023-01-11 14:50:10 +01005195 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse change cipher spec"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005196
Gilles Peskine449bd832023-01-11 14:50:10 +01005197 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005198}
5199
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005200/* Once ssl->out_hdr as the address of the beginning of the
5201 * next outgoing record is set, deduce the other pointers.
5202 *
5203 * Note: For TLS, we save the implicit record sequence number
5204 * (entering MAC computation) in the 8 bytes before ssl->out_hdr,
5205 * and the caller has to make sure there's space for this.
5206 */
5207
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005208static size_t ssl_transform_get_explicit_iv_len(
Gilles Peskine449bd832023-01-11 14:50:10 +01005209 mbedtls_ssl_transform const *transform)
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005210{
Gilles Peskine449bd832023-01-11 14:50:10 +01005211 return transform->ivlen - transform->fixed_ivlen;
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005212}
5213
Gilles Peskine449bd832023-01-11 14:50:10 +01005214void mbedtls_ssl_update_out_pointers(mbedtls_ssl_context *ssl,
5215 mbedtls_ssl_transform *transform)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005216{
5217#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005218 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005219 ssl->out_ctr = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005220#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005221 ssl->out_cid = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005222 ssl->out_len = ssl->out_cid;
Gilles Peskine449bd832023-01-11 14:50:10 +01005223 if (transform != NULL) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005224 ssl->out_len += transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005225 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005226#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005227 ssl->out_len = ssl->out_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005228#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005229 ssl->out_iv = ssl->out_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005230 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005231#endif
5232 {
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005233 ssl->out_len = ssl->out_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005234#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005235 ssl->out_cid = ssl->out_len;
5236#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005237 ssl->out_iv = ssl->out_hdr + 5;
5238 }
5239
Hanno Beckerc0eefa82020-05-28 07:17:36 +01005240 ssl->out_msg = ssl->out_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005241 /* Adjust out_msg to make space for explicit IV, if used. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005242 if (transform != NULL) {
5243 ssl->out_msg += ssl_transform_get_explicit_iv_len(transform);
5244 }
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005245}
5246
5247/* Once ssl->in_hdr as the address of the beginning of the
5248 * next incoming record is set, deduce the other pointers.
5249 *
5250 * Note: For TLS, we save the implicit record sequence number
5251 * (entering MAC computation) in the 8 bytes before ssl->in_hdr,
5252 * and the caller has to make sure there's space for this.
5253 */
5254
Gilles Peskine449bd832023-01-11 14:50:10 +01005255void mbedtls_ssl_update_in_pointers(mbedtls_ssl_context *ssl)
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005256{
Hanno Becker79594fd2019-05-08 09:38:41 +01005257 /* This function sets the pointers to match the case
5258 * of unprotected TLS/DTLS records, with both ssl->in_iv
5259 * and ssl->in_msg pointing to the beginning of the record
5260 * content.
5261 *
5262 * When decrypting a protected record, ssl->in_msg
5263 * will be shifted to point to the beginning of the
5264 * record plaintext.
5265 */
5266
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005267#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005268 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005269 /* This sets the header pointers to match records
5270 * without CID. When we receive a record containing
5271 * a CID, the fields are shifted accordingly in
5272 * ssl_parse_record_header(). */
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005273 ssl->in_ctr = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005274#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Jerry Yuae0b2e22021-10-08 15:21:19 +08005275 ssl->in_cid = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005276 ssl->in_len = ssl->in_cid; /* Default: no CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01005277#else /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Jerry Yuae0b2e22021-10-08 15:21:19 +08005278 ssl->in_len = ssl->in_ctr + MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005279#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01005280 ssl->in_iv = ssl->in_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005281 } else
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005282#endif
5283 {
Jerry Yuae0b2e22021-10-08 15:21:19 +08005284 ssl->in_ctr = ssl->in_hdr - MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005285 ssl->in_len = ssl->in_hdr + 3;
Hanno Beckera0e20d02019-05-15 14:03:01 +01005286#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4c3eb7c2019-05-08 16:43:21 +01005287 ssl->in_cid = ssl->in_len;
5288#endif
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005289 ssl->in_iv = ssl->in_hdr + 5;
5290 }
5291
Hanno Becker79594fd2019-05-08 09:38:41 +01005292 /* This will be adjusted at record decryption time. */
5293 ssl->in_msg = ssl->in_iv;
Hanno Becker5aa4e2c2018-08-06 09:26:08 +01005294}
5295
Paul Bakker5121ce52009-01-03 21:22:43 +00005296/*
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02005297 * Setup an SSL context
5298 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005299
Gilles Peskine449bd832023-01-11 14:50:10 +01005300void mbedtls_ssl_reset_in_out_pointers(mbedtls_ssl_context *ssl)
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005301{
5302 /* Set the incoming and outgoing record pointers. */
5303#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005304 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005305 ssl->out_hdr = ssl->out_buf;
5306 ssl->in_hdr = ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01005307 } else
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005308#endif /* MBEDTLS_SSL_PROTO_DTLS */
5309 {
Hanno Becker12078f42021-03-02 15:28:41 +00005310 ssl->out_ctr = ssl->out_buf;
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005311 ssl->out_hdr = ssl->out_buf + 8;
5312 ssl->in_hdr = ssl->in_buf + 8;
5313 }
5314
5315 /* Derive other internal pointers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005316 mbedtls_ssl_update_out_pointers(ssl, NULL /* no transform enabled */);
5317 mbedtls_ssl_update_in_pointers(ssl);
Hanno Becker2a43f6f2018-08-10 11:12:52 +01005318}
5319
Paul Bakker5121ce52009-01-03 21:22:43 +00005320/*
5321 * SSL get accessors
5322 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005323size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005324{
Gilles Peskine449bd832023-01-11 14:50:10 +01005325 return ssl->in_offt == NULL ? 0 : ssl->in_msglen;
Paul Bakker5121ce52009-01-03 21:22:43 +00005326}
5327
Gilles Peskine449bd832023-01-11 14:50:10 +01005328int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl)
Hanno Becker8b170a02017-10-10 11:51:19 +01005329{
5330 /*
5331 * Case A: We're currently holding back
5332 * a message for further processing.
5333 */
5334
Gilles Peskine449bd832023-01-11 14:50:10 +01005335 if (ssl->keep_current_message == 1) {
5336 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: record held back for processing"));
5337 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005338 }
5339
5340 /*
5341 * Case B: Further records are pending in the current datagram.
5342 */
5343
5344#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005345 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5346 ssl->in_left > ssl->next_record_offset) {
5347 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: more records within current datagram"));
5348 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005349 }
5350#endif /* MBEDTLS_SSL_PROTO_DTLS */
5351
5352 /*
5353 * Case C: A handshake message is being processed.
5354 */
5355
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 if (ssl->in_hslen > 0 && ssl->in_hslen < ssl->in_msglen) {
5357 MBEDTLS_SSL_DEBUG_MSG(3,
5358 ("ssl_check_pending: more handshake messages within current record"));
5359 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005360 }
5361
5362 /*
5363 * Case D: An application data message is being processed
5364 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005365 if (ssl->in_offt != NULL) {
5366 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: application data record is being processed"));
5367 return 1;
Hanno Becker8b170a02017-10-10 11:51:19 +01005368 }
5369
5370 /*
5371 * In all other cases, the rest of the message can be dropped.
Hanno Beckerc573ac32018-08-28 17:15:25 +01005372 * As in ssl_get_next_record, this needs to be adapted if
Hanno Becker8b170a02017-10-10 11:51:19 +01005373 * we implement support for multiple alerts in single records.
5374 */
5375
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 MBEDTLS_SSL_DEBUG_MSG(3, ("ssl_check_pending: nothing pending"));
5377 return 0;
Hanno Becker8b170a02017-10-10 11:51:19 +01005378}
5379
Paul Bakker43ca69c2011-01-15 17:35:19 +00005380
Gilles Peskine449bd832023-01-11 14:50:10 +01005381int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005382{
Hanno Becker3136ede2018-08-17 15:28:19 +01005383 size_t transform_expansion = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005384 const mbedtls_ssl_transform *transform = ssl->transform_out;
Hanno Becker5b559ac2018-08-03 09:40:07 +01005385 unsigned block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005386#if defined(MBEDTLS_USE_PSA_CRYPTO)
5387 psa_key_attributes_t attr = PSA_KEY_ATTRIBUTES_INIT;
5388 psa_key_type_t key_type;
5389#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005390
Gilles Peskine449bd832023-01-11 14:50:10 +01005391 size_t out_hdr_len = mbedtls_ssl_out_hdr_len(ssl);
Hanno Becker5903de42019-05-03 14:46:38 +01005392
Gilles Peskine449bd832023-01-11 14:50:10 +01005393 if (transform == NULL) {
5394 return (int) out_hdr_len;
5395 }
Hanno Becker78640902018-08-13 16:35:15 +01005396
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005397
5398#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005399 if (transform->psa_alg == PSA_ALG_GCM ||
5400 transform->psa_alg == PSA_ALG_CCM ||
5401 transform->psa_alg == PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 8) ||
5402 transform->psa_alg == PSA_ALG_CHACHA20_POLY1305 ||
5403 transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) {
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005404 transform_expansion = transform->minlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 } else if (transform->psa_alg == PSA_ALG_CBC_NO_PADDING) {
5406 (void) psa_get_key_attributes(transform->psa_key_enc, &attr);
5407 key_type = psa_get_key_type(&attr);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005408
Gilles Peskine449bd832023-01-11 14:50:10 +01005409 block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005410
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005411 /* Expansion due to the addition of the MAC. */
5412 transform_expansion += transform->maclen;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005413
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005414 /* Expansion due to the addition of CBC padding;
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005415 * Theoretically up to 256 bytes, but we never use
5416 * more than the block size of the underlying cipher. */
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005417 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005418
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005419 /* For TLS 1.2 or higher, an explicit IV is added
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01005420 * after the record header. */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005421#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Przemyslaw Stekiel1d714472022-01-24 23:46:50 +01005422 transform_expansion += block_size;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005423#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 } else {
5425 MBEDTLS_SSL_DEBUG_MSG(1,
5426 ("Unsupported psa_alg spotted in mbedtls_ssl_get_record_expansion()"));
5427 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005428 }
5429#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 switch (mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005431 case MBEDTLS_MODE_GCM:
5432 case MBEDTLS_MODE_CCM:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005433 case MBEDTLS_MODE_CHACHAPOLY:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005434 case MBEDTLS_MODE_STREAM:
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005435 transform_expansion = transform->minlen;
5436 break;
5437
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005438 case MBEDTLS_MODE_CBC:
Hanno Becker5b559ac2018-08-03 09:40:07 +01005439
5440 block_size = mbedtls_cipher_get_block_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01005441 &transform->cipher_ctx_enc);
Hanno Becker5b559ac2018-08-03 09:40:07 +01005442
Hanno Becker3136ede2018-08-17 15:28:19 +01005443 /* Expansion due to the addition of the MAC. */
5444 transform_expansion += transform->maclen;
5445
5446 /* Expansion due to the addition of CBC padding;
5447 * Theoretically up to 256 bytes, but we never use
5448 * more than the block size of the underlying cipher. */
5449 transform_expansion += block_size;
5450
TRodziewicz4ca18aa2021-05-20 14:46:20 +02005451 /* For TLS 1.2 or higher, an explicit IV is added
Hanno Becker3136ede2018-08-17 15:28:19 +01005452 * after the record header. */
TRodziewicz0f82ec62021-05-12 17:49:18 +02005453#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
TRodziewicz345165c2021-07-06 13:42:11 +02005454 transform_expansion += block_size;
TRodziewicz0f82ec62021-05-12 17:49:18 +02005455#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker3136ede2018-08-17 15:28:19 +01005456
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005457 break;
5458
5459 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005460 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
5461 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005462 }
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01005463#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005464
Hanno Beckera0e20d02019-05-15 14:03:01 +01005465#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine449bd832023-01-11 14:50:10 +01005466 if (transform->out_cid_len != 0) {
Hanno Becker6cbad552019-05-08 15:40:11 +01005467 transform_expansion += MBEDTLS_SSL_MAX_CID_EXPANSION;
Gilles Peskine449bd832023-01-11 14:50:10 +01005468 }
Hanno Beckera0e20d02019-05-15 14:03:01 +01005469#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6cbad552019-05-08 15:40:11 +01005470
Gilles Peskine449bd832023-01-11 14:50:10 +01005471 return (int) (out_hdr_len + transform_expansion);
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02005472}
5473
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005474#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01005475/*
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005476 * Check record counters and renegotiate if they're above the limit.
5477 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005478MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005479static int ssl_check_ctr_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005480{
Gilles Peskine449bd832023-01-11 14:50:10 +01005481 size_t ep_len = mbedtls_ssl_ep_len(ssl);
Andres AG2196c7f2016-12-15 17:01:16 +00005482 int in_ctr_cmp;
5483 int out_ctr_cmp;
5484
Gilles Peskine449bd832023-01-11 14:50:10 +01005485 if (mbedtls_ssl_is_handshake_over(ssl) == 0 ||
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005486 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING ||
Gilles Peskine449bd832023-01-11 14:50:10 +01005487 ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5488 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005489 }
5490
Gilles Peskine449bd832023-01-11 14:50:10 +01005491 in_ctr_cmp = memcmp(ssl->in_ctr + ep_len,
5492 &ssl->conf->renego_period[ep_len],
5493 MBEDTLS_SSL_SEQUENCE_NUMBER_LEN - ep_len);
5494 out_ctr_cmp = memcmp(&ssl->cur_out_ctr[ep_len],
Jerry Yud9a94fe2021-09-28 18:58:59 +08005495 &ssl->conf->renego_period[ep_len],
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 sizeof(ssl->cur_out_ctr) - ep_len);
Andres AG2196c7f2016-12-15 17:01:16 +00005497
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 if (in_ctr_cmp <= 0 && out_ctr_cmp <= 0) {
5499 return 0;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005500 }
5501
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 MBEDTLS_SSL_DEBUG_MSG(1, ("record counter limit reached: renegotiate"));
5503 return mbedtls_ssl_renegotiate(ssl);
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005504}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005505#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005506
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005507#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
5508
5509#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Jerry Yua0446a02022-07-13 11:22:55 +08005510MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005511static int ssl_tls13_check_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005512{
5513
Gilles Peskine449bd832023-01-11 14:50:10 +01005514 if ((ssl->in_hslen == mbedtls_ssl_hs_hdr_len(ssl)) ||
5515 (ssl->in_msg[0] != MBEDTLS_SSL_HS_NEW_SESSION_TICKET)) {
5516 return 0;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005517 }
5518
5519 ssl->keep_current_message = 1;
5520
Gilles Peskine449bd832023-01-11 14:50:10 +01005521 MBEDTLS_SSL_DEBUG_MSG(3, ("NewSessionTicket received"));
5522 mbedtls_ssl_handshake_set_state(ssl,
5523 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005524
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 return MBEDTLS_ERR_SSL_WANT_READ;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005526}
5527#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5528
Jerry Yua0446a02022-07-13 11:22:55 +08005529MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005530static int ssl_tls13_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005531{
5532
Gilles Peskine449bd832023-01-11 14:50:10 +01005533 MBEDTLS_SSL_DEBUG_MSG(3, ("received post-handshake message"));
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005534
5535#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005536 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
5537 int ret = ssl_tls13_check_new_session_ticket(ssl);
5538 if (ret != 0) {
5539 return ret;
5540 }
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005541 }
5542#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
5543
5544 /* Fail in all other cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005545 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005546}
5547#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5548
5549#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005550/* This function is called from mbedtls_ssl_read() when a handshake message is
Hanno Beckerf26cc722021-04-21 07:30:13 +01005551 * received after the initial handshake. In this context, handshake messages
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005552 * may only be sent for the purpose of initiating renegotiations.
5553 *
5554 * This function is introduced as a separate helper since the handling
5555 * of post-handshake handshake messages changes significantly in TLS 1.3,
5556 * and having a helper function allows to distinguish between TLS <= 1.2 and
5557 * TLS 1.3 in the future without bloating the logic of mbedtls_ssl_read().
5558 */
Jerry Yua0446a02022-07-13 11:22:55 +08005559MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005560static int ssl_tls12_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005561{
Hanno Beckerfae12cf2021-04-21 07:20:20 +01005562 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005563
5564 /*
5565 * - For client-side, expect SERVER_HELLO_REQUEST.
5566 * - For server-side, expect CLIENT_HELLO.
5567 * - Fail (TLS) or silently drop record (DTLS) in other cases.
5568 */
5569
5570#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005571 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
5572 (ssl->in_msg[0] != MBEDTLS_SSL_HS_HELLO_REQUEST ||
5573 ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl))) {
5574 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not HelloRequest)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005575
5576 /* With DTLS, drop the packet (probably from last handshake) */
5577#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005578 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5579 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005580 }
5581#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005583 }
5584#endif /* MBEDTLS_SSL_CLI_C */
5585
5586#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005587 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5588 ssl->in_msg[0] != MBEDTLS_SSL_HS_CLIENT_HELLO) {
5589 MBEDTLS_SSL_DEBUG_MSG(1, ("handshake received (not ClientHello)"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005590
5591 /* With DTLS, drop the packet (probably from last handshake) */
5592#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005593 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5594 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005595 }
5596#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005597 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005598 }
5599#endif /* MBEDTLS_SSL_SRV_C */
5600
5601#if defined(MBEDTLS_SSL_RENEGOTIATION)
5602 /* Determine whether renegotiation attempt should be accepted */
Gilles Peskine449bd832023-01-11 14:50:10 +01005603 if (!(ssl->conf->disable_renegotiation == MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
5604 (ssl->secure_renegotiation == MBEDTLS_SSL_LEGACY_RENEGOTIATION &&
5605 ssl->conf->allow_legacy_renegotiation ==
5606 MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION))) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005607 /*
5608 * Accept renegotiation request
5609 */
5610
5611 /* DTLS clients need to know renego is server-initiated */
5612#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005613 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
5614 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005615 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
5616 }
5617#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 ret = mbedtls_ssl_start_renegotiation(ssl);
5619 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5620 ret != 0) {
5621 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation",
5622 ret);
5623 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005624 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005625 } else
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005626#endif /* MBEDTLS_SSL_RENEGOTIATION */
5627 {
5628 /*
5629 * Refuse renegotiation
5630 */
5631
Gilles Peskine449bd832023-01-11 14:50:10 +01005632 MBEDTLS_SSL_DEBUG_MSG(3, ("refusing renegotiation, sending alert"));
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005633
Gilles Peskine449bd832023-01-11 14:50:10 +01005634 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5635 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5636 MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION)) != 0) {
5637 return ret;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005638 }
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005639 }
5640
Gilles Peskine449bd832023-01-11 14:50:10 +01005641 return 0;
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005642}
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005643#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5644
5645MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005646static int ssl_handle_hs_message_post_handshake(mbedtls_ssl_context *ssl)
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005647{
5648 /* Check protocol version and dispatch accordingly. */
5649#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005650 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
5651 return ssl_tls13_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005652 }
5653#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
5654
5655#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005656 if (ssl->tls_version <= MBEDTLS_SSL_VERSION_TLS1_2) {
5657 return ssl_tls12_handle_hs_message_post_handshake(ssl);
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005658 }
5659#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5660
5661 /* Should never happen */
Gilles Peskine449bd832023-01-11 14:50:10 +01005662 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuc62ae5f2022-07-07 09:42:26 +00005663}
Hanno Beckerb03f88f2020-11-24 06:41:37 +00005664
Paul Bakker48916f92012-09-16 19:57:18 +00005665/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005666 * Receive application data decrypted from the SSL layer
5667 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005668int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005669{
Janos Follath865b3eb2019-12-16 11:46:15 +00005670 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker23986e52011-04-24 08:57:21 +00005671 size_t n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005672
Gilles Peskine449bd832023-01-11 14:50:10 +01005673 if (ssl == NULL || ssl->conf == NULL) {
5674 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5675 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005676
Gilles Peskine449bd832023-01-11 14:50:10 +01005677 MBEDTLS_SSL_DEBUG_MSG(2, ("=> read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005678
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005679#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005680 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5681 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5682 return ret;
5683 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005684
Gilles Peskine449bd832023-01-11 14:50:10 +01005685 if (ssl->handshake != NULL &&
5686 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
5687 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
5688 return ret;
5689 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005690 }
Manuel Pégourié-Gonnardabf16242014-09-23 09:42:16 +02005691 }
5692#endif
5693
Hanno Becker4a810fb2017-05-24 16:27:30 +01005694 /*
5695 * Check if renegotiation is necessary and/or handshake is
5696 * in process. If yes, perform/continue, and fall through
5697 * if an unexpected packet is received while the client
5698 * is waiting for the ServerHello.
5699 *
5700 * (There is no equivalent to the last condition on
5701 * the server-side as it is not treated as within
5702 * a handshake while waiting for the ClientHello
5703 * after a renegotiation request.)
5704 */
5705
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005706#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005707 ret = ssl_check_ctr_renegotiate(ssl);
5708 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5709 ret != 0) {
5710 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5711 return ret;
Manuel Pégourié-Gonnardb4458052014-11-04 21:04:22 +01005712 }
5713#endif
5714
Gilles Peskine449bd832023-01-11 14:50:10 +01005715 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5716 ret = mbedtls_ssl_handshake(ssl);
5717 if (ret != MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO &&
5718 ret != 0) {
5719 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5720 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005721 }
5722 }
5723
Hanno Beckere41158b2017-10-23 13:30:32 +01005724 /* Loop as long as no application data record is available */
Gilles Peskine449bd832023-01-11 14:50:10 +01005725 while (ssl->in_offt == NULL) {
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005726 /* Start timer if not already running */
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 if (ssl->f_get_timer != NULL &&
5728 ssl->f_get_timer(ssl->p_timer) == -1) {
5729 mbedtls_ssl_set_timer(ssl, ssl->conf->read_timeout);
Manuel Pégourié-Gonnard545102e2015-05-13 17:28:43 +02005730 }
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005731
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5733 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5734 return 0;
5735 }
Paul Bakker831a7552011-05-18 13:32:51 +00005736
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5738 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005739 }
5740
Gilles Peskine449bd832023-01-11 14:50:10 +01005741 if (ssl->in_msglen == 0 &&
5742 ssl->in_msgtype == MBEDTLS_SSL_MSG_APPLICATION_DATA) {
Paul Bakker5121ce52009-01-03 21:22:43 +00005743 /*
5744 * OpenSSL sends empty messages to randomize the IV
5745 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005746 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
5747 if (ret == MBEDTLS_ERR_SSL_CONN_EOF) {
5748 return 0;
5749 }
Paul Bakker831a7552011-05-18 13:32:51 +00005750
Gilles Peskine449bd832023-01-11 14:50:10 +01005751 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
5752 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005753 }
5754 }
5755
Gilles Peskine449bd832023-01-11 14:50:10 +01005756 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE) {
5757 ret = ssl_handle_hs_message_post_handshake(ssl);
5758 if (ret != 0) {
5759 MBEDTLS_SSL_DEBUG_RET(1, "ssl_handle_hs_message_post_handshake",
5760 ret);
5761 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00005762 }
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005763
Hanno Beckerf26cc722021-04-21 07:30:13 +01005764 /* At this point, we don't know whether the renegotiation triggered
5765 * by the post-handshake message has been completed or not. The cases
5766 * to consider are the following:
Hanno Becker90333da2017-10-10 11:27:13 +01005767 * 1) The renegotiation is complete. In this case, no new record
5768 * has been read yet.
5769 * 2) The renegotiation is incomplete because the client received
5770 * an application data record while awaiting the ServerHello.
5771 * 3) The renegotiation is incomplete because the client received
5772 * a non-handshake, non-application data message while awaiting
5773 * the ServerHello.
Hanno Beckerf26cc722021-04-21 07:30:13 +01005774 *
5775 * In each of these cases, looping will be the proper action:
Hanno Becker90333da2017-10-10 11:27:13 +01005776 * - For 1), the next iteration will read a new record and check
5777 * if it's application data.
5778 * - For 2), the loop condition isn't satisfied as application data
5779 * is present, hence continue is the same as break
5780 * - For 3), the loop condition is satisfied and read_record
5781 * will re-deliver the message that was held back by the client
5782 * when expecting the ServerHello.
5783 */
Hanno Beckerf26cc722021-04-21 07:30:13 +01005784
Hanno Becker90333da2017-10-10 11:27:13 +01005785 continue;
Paul Bakker48916f92012-09-16 19:57:18 +00005786 }
Hanno Becker21df7f92017-10-17 11:03:26 +01005787#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005788 else if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5789 if (ssl->conf->renego_max_records >= 0) {
5790 if (++ssl->renego_records_seen > ssl->conf->renego_max_records) {
5791 MBEDTLS_SSL_DEBUG_MSG(1, ("renegotiation requested, "
5792 "but not honored by client"));
5793 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02005794 }
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02005795 }
Manuel Pégourié-Gonnard6d8404d2013-10-30 16:41:45 +01005796 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005797#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005798
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005799 /* Fatal and closure alerts handled by mbedtls_ssl_read_record() */
Gilles Peskine449bd832023-01-11 14:50:10 +01005800 if (ssl->in_msgtype == MBEDTLS_SSL_MSG_ALERT) {
5801 MBEDTLS_SSL_DEBUG_MSG(2, ("ignoring non-fatal non-closure alert"));
5802 return MBEDTLS_ERR_SSL_WANT_READ;
Manuel Pégourié-Gonnardf26a1e82014-08-19 12:28:50 +02005803 }
5804
Gilles Peskine449bd832023-01-11 14:50:10 +01005805 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_APPLICATION_DATA) {
5806 MBEDTLS_SSL_DEBUG_MSG(1, ("bad application data message"));
5807 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Paul Bakker5121ce52009-01-03 21:22:43 +00005808 }
5809
5810 ssl->in_offt = ssl->in_msg;
Manuel Pégourié-Gonnard6b651412014-10-01 18:29:03 +02005811
Manuel Pégourié-Gonnardba958b82014-10-09 16:13:44 +02005812 /* We're going to return something now, cancel timer,
5813 * except if handshake (renegotiation) is in progress */
Gilles Peskine449bd832023-01-11 14:50:10 +01005814 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5815 mbedtls_ssl_set_timer(ssl, 0);
5816 }
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005817
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02005818#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005819 /* If we requested renego but received AppData, resend HelloRequest.
5820 * Do it now, after setting in_offt, to avoid taking this branch
5821 * again if ssl_write_hello_request() returns WANT_WRITE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005822#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005823 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER &&
5824 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
5825 if ((ret = mbedtls_ssl_resend_hello_request(ssl)) != 0) {
5826 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_resend_hello_request",
5827 ret);
5828 return ret;
Manuel Pégourié-Gonnard26a4cf62014-10-15 13:52:48 +02005829 }
5830 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005831#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker4a810fb2017-05-24 16:27:30 +01005832#endif /* MBEDTLS_SSL_PROTO_DTLS */
Paul Bakker5121ce52009-01-03 21:22:43 +00005833 }
5834
Gilles Peskine449bd832023-01-11 14:50:10 +01005835 n = (len < ssl->in_msglen)
Paul Bakker5121ce52009-01-03 21:22:43 +00005836 ? len : ssl->in_msglen;
5837
ashesman937d6d52022-02-17 11:08:27 +13005838 if (len != 0) {
Ashley Duncan358f94a2022-02-11 09:57:18 +13005839 memcpy(buf, ssl->in_offt, n);
5840 ssl->in_msglen -= n;
5841 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005842
gabor-mezei-arma3214132020-07-15 10:55:00 +02005843 /* Zeroising the plaintext buffer to erase unused application data
5844 from the memory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005845 mbedtls_platform_zeroize(ssl->in_offt, n);
gabor-mezei-arma3214132020-07-15 10:55:00 +02005846
Gilles Peskine449bd832023-01-11 14:50:10 +01005847 if (ssl->in_msglen == 0) {
Hanno Becker4a810fb2017-05-24 16:27:30 +01005848 /* all bytes consumed */
Paul Bakker5121ce52009-01-03 21:22:43 +00005849 ssl->in_offt = NULL;
Hanno Beckerbdf39052017-06-09 10:42:03 +01005850 ssl->keep_current_message = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01005851 } else {
Paul Bakker5121ce52009-01-03 21:22:43 +00005852 /* more data available */
5853 ssl->in_offt += n;
Hanno Becker4a810fb2017-05-24 16:27:30 +01005854 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005855
Gilles Peskine449bd832023-01-11 14:50:10 +01005856 MBEDTLS_SSL_DEBUG_MSG(2, ("<= read"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005857
Gilles Peskine449bd832023-01-11 14:50:10 +01005858 return (int) n;
Paul Bakker5121ce52009-01-03 21:22:43 +00005859}
5860
5861/*
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005862 * Send application data to be encrypted by the SSL layer, taking care of max
5863 * fragment length and buffer size.
5864 *
5865 * According to RFC 5246 Section 6.2.1:
5866 *
5867 * Zero-length fragments of Application data MAY be sent as they are
5868 * potentially useful as a traffic analysis countermeasure.
5869 *
5870 * Therefore, it is possible that the input message length is 0 and the
5871 * corresponding return code is 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +00005872 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005873MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005874static int ssl_write_real(mbedtls_ssl_context *ssl,
5875 const unsigned char *buf, size_t len)
Paul Bakker5121ce52009-01-03 21:22:43 +00005876{
Gilles Peskine449bd832023-01-11 14:50:10 +01005877 int ret = mbedtls_ssl_get_max_out_record_payload(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005878 const size_t max_len = (size_t) ret;
5879
Gilles Peskine449bd832023-01-11 14:50:10 +01005880 if (ret < 0) {
5881 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_get_max_out_record_payload", ret);
5882 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02005883 }
5884
Gilles Peskine449bd832023-01-11 14:50:10 +01005885 if (len > max_len) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005886#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005887 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5888 MBEDTLS_SSL_DEBUG_MSG(1, ("fragment larger than the (negotiated) "
5889 "maximum fragment length: %" MBEDTLS_PRINTF_SIZET
5890 " > %" MBEDTLS_PRINTF_SIZET,
5891 len, max_len));
5892 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5893 } else
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005894#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005895 len = max_len;
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005896 }
Paul Bakker887bd502011-06-08 13:10:54 +00005897
Gilles Peskine449bd832023-01-11 14:50:10 +01005898 if (ssl->out_left != 0) {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005899 /*
5900 * The user has previously tried to send the data and
5901 * MBEDTLS_ERR_SSL_WANT_WRITE or the message was only partially
5902 * written. In this case, we expect the high-level write function
5903 * (e.g. mbedtls_ssl_write()) to be called with the same parameters
5904 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005905 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
5906 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flush_output", ret);
5907 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005908 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005909 } else {
Andres Amaya Garcia5b923522017-09-28 14:41:17 +01005910 /*
5911 * The user is trying to send a message the first time, so we need to
5912 * copy the data into the internal buffers and setup the data structure
5913 * to keep track of partial writes
5914 */
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005915 ssl->out_msglen = len;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005916 ssl->out_msgtype = MBEDTLS_SSL_MSG_APPLICATION_DATA;
Dave Rodgmanf6840252023-02-24 15:41:34 +00005917 if (len > 0) {
5918 memcpy(ssl->out_msg, buf, len);
5919 }
Paul Bakker887bd502011-06-08 13:10:54 +00005920
Gilles Peskine449bd832023-01-11 14:50:10 +01005921 if ((ret = mbedtls_ssl_write_record(ssl, SSL_FORCE_FLUSH)) != 0) {
5922 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_record", ret);
5923 return ret;
Paul Bakker887bd502011-06-08 13:10:54 +00005924 }
Paul Bakker5121ce52009-01-03 21:22:43 +00005925 }
5926
Gilles Peskine449bd832023-01-11 14:50:10 +01005927 return (int) len;
Paul Bakker5121ce52009-01-03 21:22:43 +00005928}
5929
5930/*
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005931 * Write application data (public-facing wrapper)
5932 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005933int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len)
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005934{
Janos Follath865b3eb2019-12-16 11:46:15 +00005935 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005936
Gilles Peskine449bd832023-01-11 14:50:10 +01005937 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005938
Gilles Peskine449bd832023-01-11 14:50:10 +01005939 if (ssl == NULL || ssl->conf == NULL) {
5940 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5941 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005942
Manuel Pégourié-Gonnard144bc222015-04-17 20:39:07 +02005943#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005944 if ((ret = ssl_check_ctr_renegotiate(ssl)) != 0) {
5945 MBEDTLS_SSL_DEBUG_RET(1, "ssl_check_ctr_renegotiate", ret);
5946 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005947 }
5948#endif
5949
Gilles Peskine449bd832023-01-11 14:50:10 +01005950 if (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
5951 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
5952 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
5953 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005954 }
5955 }
5956
Gilles Peskine449bd832023-01-11 14:50:10 +01005957 ret = ssl_write_real(ssl, buf, len);
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005958
Gilles Peskine449bd832023-01-11 14:50:10 +01005959 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write"));
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005960
Gilles Peskine449bd832023-01-11 14:50:10 +01005961 return ret;
Manuel Pégourié-Gonnarda2fce212015-04-15 19:09:03 +02005962}
5963
5964/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005965 * Notify the peer that the connection is being closed
5966 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005967int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005968{
Janos Follath865b3eb2019-12-16 11:46:15 +00005969 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00005970
Gilles Peskine449bd832023-01-11 14:50:10 +01005971 if (ssl == NULL || ssl->conf == NULL) {
5972 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5973 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02005974
Gilles Peskine449bd832023-01-11 14:50:10 +01005975 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005976
Gilles Peskine449bd832023-01-11 14:50:10 +01005977 if (mbedtls_ssl_is_handshake_over(ssl) == 1) {
5978 if ((ret = mbedtls_ssl_send_alert_message(ssl,
5979 MBEDTLS_SSL_ALERT_LEVEL_WARNING,
5980 MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY)) != 0) {
5981 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_send_alert_message", ret);
5982 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00005983 }
5984 }
5985
Gilles Peskine449bd832023-01-11 14:50:10 +01005986 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write close notify"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005987
Gilles Peskine449bd832023-01-11 14:50:10 +01005988 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00005989}
5990
Gilles Peskine449bd832023-01-11 14:50:10 +01005991void mbedtls_ssl_transform_free(mbedtls_ssl_transform *transform)
Paul Bakker48916f92012-09-16 19:57:18 +00005992{
Gilles Peskine449bd832023-01-11 14:50:10 +01005993 if (transform == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005994 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005995 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005996
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01005997#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01005998 psa_destroy_key(transform->psa_key_enc);
5999 psa_destroy_key(transform->psa_key_dec);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01006000#else
Gilles Peskine449bd832023-01-11 14:50:10 +01006001 mbedtls_cipher_free(&transform->cipher_ctx_enc);
6002 mbedtls_cipher_free(&transform->cipher_ctx_dec);
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01006003#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01006004
Hanno Beckerfd86ca82020-11-30 08:54:23 +00006005#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01006006#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006007 psa_destroy_key(transform->psa_mac_enc);
6008 psa_destroy_key(transform->psa_mac_dec);
Neil Armstrongcf8841a2022-02-24 11:17:45 +01006009#else
Gilles Peskine449bd832023-01-11 14:50:10 +01006010 mbedtls_md_free(&transform->md_ctx_enc);
6011 mbedtls_md_free(&transform->md_ctx_dec);
Neil Armstrongcf8841a2022-02-24 11:17:45 +01006012#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd56ed242018-01-03 15:32:51 +00006013#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02006014
Gilles Peskine449bd832023-01-11 14:50:10 +01006015 mbedtls_platform_zeroize(transform, sizeof(mbedtls_ssl_transform));
Paul Bakker48916f92012-09-16 19:57:18 +00006016}
6017
Gilles Peskine449bd832023-01-11 14:50:10 +01006018void mbedtls_ssl_set_inbound_transform(mbedtls_ssl_context *ssl,
6019 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006020{
Jerry Yuc7875b52021-09-05 21:05:50 +08006021 ssl->transform_in = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006022 memset(ssl->in_ctr, 0, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuc7875b52021-09-05 21:05:50 +08006023}
6024
Gilles Peskine449bd832023-01-11 14:50:10 +01006025void mbedtls_ssl_set_outbound_transform(mbedtls_ssl_context *ssl,
6026 mbedtls_ssl_transform *transform)
Jerry Yuc7875b52021-09-05 21:05:50 +08006027{
6028 ssl->transform_out = transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01006029 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yuc7875b52021-09-05 21:05:50 +08006030}
6031
Hanno Becker0271f962018-08-16 13:23:47 +01006032#if defined(MBEDTLS_SSL_PROTO_DTLS)
6033
Gilles Peskine449bd832023-01-11 14:50:10 +01006034void mbedtls_ssl_buffering_free(mbedtls_ssl_context *ssl)
Hanno Becker0271f962018-08-16 13:23:47 +01006035{
6036 unsigned offset;
6037 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6038
Gilles Peskine449bd832023-01-11 14:50:10 +01006039 if (hs == NULL) {
Hanno Becker0271f962018-08-16 13:23:47 +01006040 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006041 }
Hanno Becker0271f962018-08-16 13:23:47 +01006042
Gilles Peskine449bd832023-01-11 14:50:10 +01006043 ssl_free_buffered_record(ssl);
Hanno Becker283f5ef2018-08-24 09:34:47 +01006044
Gilles Peskine449bd832023-01-11 14:50:10 +01006045 for (offset = 0; offset < MBEDTLS_SSL_MAX_BUFFERED_HS; offset++) {
6046 ssl_buffering_free_slot(ssl, offset);
6047 }
Hanno Beckere605b192018-08-21 15:59:07 +01006048}
6049
Gilles Peskine449bd832023-01-11 14:50:10 +01006050static void ssl_buffering_free_slot(mbedtls_ssl_context *ssl,
6051 uint8_t slot)
Hanno Beckere605b192018-08-21 15:59:07 +01006052{
6053 mbedtls_ssl_handshake_params * const hs = ssl->handshake;
6054 mbedtls_ssl_hs_buffer * const hs_buf = &hs->buffering.hs[slot];
Hanno Beckerb309b922018-08-23 13:18:05 +01006055
Gilles Peskine449bd832023-01-11 14:50:10 +01006056 if (slot >= MBEDTLS_SSL_MAX_BUFFERED_HS) {
Hanno Beckerb309b922018-08-23 13:18:05 +01006057 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 }
Hanno Beckerb309b922018-08-23 13:18:05 +01006059
Gilles Peskine449bd832023-01-11 14:50:10 +01006060 if (hs_buf->is_valid == 1) {
Hanno Beckere605b192018-08-21 15:59:07 +01006061 hs->buffering.total_bytes_buffered -= hs_buf->data_len;
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006062 mbedtls_zeroize_and_free(hs_buf->data, hs_buf->data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006063 memset(hs_buf, 0, sizeof(mbedtls_ssl_hs_buffer));
Hanno Becker0271f962018-08-16 13:23:47 +01006064 }
6065}
6066
6067#endif /* MBEDTLS_SSL_PROTO_DTLS */
6068
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006069/*
6070 * Convert version numbers to/from wire format
6071 * and, for DTLS, to/from TLS equivalent.
6072 *
6073 * For TLS this is the identity.
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006074 * For DTLS, map as follows, then use 1's complement (v -> ~v):
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006075 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006076 * DTLS 1.0 is stored as TLS 1.1 internally
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006077 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006078void mbedtls_ssl_write_version(unsigned char version[2], int transport,
6079 mbedtls_ssl_protocol_version tls_version)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006080{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006081 uint16_t tls_version_formatted;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006082#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006083 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006084 tls_version_formatted =
Gilles Peskine449bd832023-01-11 14:50:10 +01006085 ~(tls_version - (tls_version == 0x0302 ? 0x0202 : 0x0201));
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006086 } else
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006087#else
6088 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006089#endif
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006090 {
6091 tls_version_formatted = (uint16_t) tls_version;
6092 }
6093 MBEDTLS_PUT_UINT16_BE(tls_version_formatted, version, 0);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006094}
6095
Gilles Peskine449bd832023-01-11 14:50:10 +01006096uint16_t mbedtls_ssl_read_version(const unsigned char version[2],
6097 int transport)
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006098{
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 uint16_t tls_version = MBEDTLS_GET_UINT16_BE(version, 0);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006100#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006102 tls_version =
Gilles Peskine449bd832023-01-11 14:50:10 +01006103 ~(tls_version - (tls_version == 0xfeff ? 0x0202 : 0x0201));
6104 }
Manuel Pégourié-Gonnard34c10112014-03-25 13:36:22 +01006105#else
6106 ((void) transport);
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006107#endif
Glenn Strausse3af4cb2022-03-15 03:23:42 -04006108 return tls_version;
Manuel Pégourié-Gonnardabc7e3b2014-02-11 18:15:03 +01006109}
6110
Jerry Yue7047812021-09-13 19:26:39 +08006111/*
Jerry Yu3bf1f972021-09-22 21:37:18 +08006112 * Send pending fatal alert.
6113 * 0, No alert message.
6114 * !0, if mbedtls_ssl_send_alert_message() returned in error, the error code it
6115 * returned, ssl->alert_reason otherwise.
Jerry Yue7047812021-09-13 19:26:39 +08006116 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006117int mbedtls_ssl_handle_pending_alert(mbedtls_ssl_context *ssl)
Jerry Yue7047812021-09-13 19:26:39 +08006118{
6119 int ret;
6120
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006121 /* No pending alert, return success*/
Gilles Peskine449bd832023-01-11 14:50:10 +01006122 if (ssl->send_alert == 0) {
6123 return 0;
6124 }
Jerry Yu394ece62021-09-14 22:17:21 +08006125
Gilles Peskine449bd832023-01-11 14:50:10 +01006126 ret = mbedtls_ssl_send_alert_message(ssl,
6127 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6128 ssl->alert_type);
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006129
Jerry Yu3bf1f972021-09-22 21:37:18 +08006130 /* If mbedtls_ssl_send_alert_message() returned with MBEDTLS_ERR_SSL_WANT_WRITE,
6131 * do not clear the alert to be able to send it later.
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006132 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006133 if (ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006134 ssl->send_alert = 0;
Jerry Yue7047812021-09-13 19:26:39 +08006135 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006136
Gilles Peskine449bd832023-01-11 14:50:10 +01006137 if (ret != 0) {
6138 return ret;
6139 }
Jerry Yubbd5a3f2021-09-18 20:50:22 +08006140
Gilles Peskine449bd832023-01-11 14:50:10 +01006141 return ssl->alert_reason;
Jerry Yue7047812021-09-13 19:26:39 +08006142}
6143
Jerry Yu394ece62021-09-14 22:17:21 +08006144/*
6145 * Set pending fatal alert flag.
6146 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006147void mbedtls_ssl_pend_fatal_alert(mbedtls_ssl_context *ssl,
6148 unsigned char alert_type,
6149 int alert_reason)
Jerry Yu394ece62021-09-14 22:17:21 +08006150{
6151 ssl->send_alert = 1;
6152 ssl->alert_type = alert_type;
6153 ssl->alert_reason = alert_reason;
6154}
6155
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006156#endif /* MBEDTLS_SSL_TLS_C */