blob: 8f8f8c27b4068aad95669910e0660d3664388007 [file] [log] [blame]
Jerry Yu65dd2cc2021-08-18 16:38:40 +08001/*
2 * TLS 1.3 functionality shared between client and server
3 *
4 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Jerry Yu65dd2cc2021-08-18 16:38:40 +08006 */
7
8#include "common.h"
9
Jerry Yufb4b6472022-01-27 15:03:26 +080010#if defined(MBEDTLS_SSL_TLS_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu65dd2cc2021-08-18 16:38:40 +080011
Jerry Yu30b071c2021-09-12 20:16:03 +080012#include <string.h>
13
Jerry Yuc8a392c2021-08-18 16:46:28 +080014#include "mbedtls/error.h"
Valerio Settib4f50762024-01-17 10:24:52 +010015#include "debug_internal.h"
Jerry Yu30b071c2021-09-12 20:16:03 +080016#include "mbedtls/oid.h"
17#include "mbedtls/platform.h"
Gabor Mezei685472b2021-11-24 11:17:36 +010018#include "mbedtls/constant_time.h"
Jerry Yu141bbe72022-12-01 20:30:41 +080019#include "psa/crypto.h"
Valerio Setti384fbde2024-01-02 13:26:40 +010020#include "mbedtls/psa_util.h"
Jerry Yuc8a392c2021-08-18 16:46:28 +080021
Jerry Yu65dd2cc2021-08-18 16:38:40 +080022#include "ssl_misc.h"
Ronald Crone3dac4a2022-06-10 17:21:51 +020023#include "ssl_tls13_invasive.h"
Jerry Yu30b071c2021-09-12 20:16:03 +080024#include "ssl_tls13_keys.h"
Jerry Yu67eced02022-02-25 13:37:36 +080025#include "ssl_debug_helpers.h"
Jerry Yu65dd2cc2021-08-18 16:38:40 +080026
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050027#include "psa/crypto.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020028#include "psa_util_internal.h"
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050029
Valerio Settic9ae8622023-07-25 11:23:50 +020030#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Andrzej Kurek00644842023-05-30 05:45:00 -040031/* Define a local translating function to save code size by not using too many
32 * arguments in each translating place. */
33static int local_err_translation(psa_status_t status)
34{
35 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040036 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040037 psa_generic_status_to_mbedtls);
38}
39#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kureka6033ac2023-05-30 15:16:34 -040040#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050041
Jerry Yufbe3e642022-04-25 19:31:51 +080042const uint8_t mbedtls_ssl_tls13_hello_retry_request_magic[
Gilles Peskine449bd832023-01-11 14:50:10 +010043 MBEDTLS_SERVER_HELLO_RANDOM_LEN] =
44{ 0xCF, 0x21, 0xAD, 0x74, 0xE5, 0x9A, 0x61, 0x11,
45 0xBE, 0x1D, 0x8C, 0x02, 0x1E, 0x65, 0xB8, 0x91,
46 0xC2, 0xA2, 0x11, 0x16, 0x7A, 0xBB, 0x8C, 0x5E,
47 0x07, 0x9E, 0x09, 0xE2, 0xC8, 0xA8, 0x33, 0x9C };
Jerry Yu93a13f22022-04-11 23:00:01 +080048
Gilles Peskine449bd832023-01-11 14:50:10 +010049int mbedtls_ssl_tls13_fetch_handshake_msg(mbedtls_ssl_context *ssl,
50 unsigned hs_type,
51 unsigned char **buf,
52 size_t *buf_len)
XiaokangQian6b226b02021-09-24 07:51:16 +000053{
54 int ret;
55
Gilles Peskine449bd832023-01-11 14:50:10 +010056 if ((ret = mbedtls_ssl_read_record(ssl, 0)) != 0) {
57 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
XiaokangQian6b226b02021-09-24 07:51:16 +000058 goto cleanup;
59 }
60
Gilles Peskine449bd832023-01-11 14:50:10 +010061 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE ||
62 ssl->in_msg[0] != hs_type) {
63 MBEDTLS_SSL_DEBUG_MSG(1, ("Receive unexpected handshake message."));
64 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
65 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE);
XiaokangQian6b226b02021-09-24 07:51:16 +000066 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
67 goto cleanup;
68 }
69
XiaokangQian05420b12021-09-29 08:46:37 +000070 /*
71 * Jump handshake header (4 bytes, see Section 4 of RFC 8446).
72 * ...
73 * HandshakeType msg_type;
74 * uint24 length;
75 * ...
76 */
Xiaofei Baieef15042021-11-18 07:29:56 +000077 *buf = ssl->in_msg + 4;
78 *buf_len = ssl->in_hslen - 4;
XiaokangQian6b226b02021-09-24 07:51:16 +000079
XiaokangQian6b226b02021-09-24 07:51:16 +000080cleanup:
81
Gilles Peskine449bd832023-01-11 14:50:10 +010082 return ret;
XiaokangQian6b226b02021-09-24 07:51:16 +000083}
84
Ronald Cron47dce632023-02-08 17:38:29 +010085int mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts(
86 mbedtls_ssl_context *ssl,
87 const unsigned char *buf, const unsigned char *end,
Ronald Croneff56732023-04-03 17:36:31 +020088 const unsigned char **supported_versions_data,
89 const unsigned char **supported_versions_data_end)
Ronald Cron47dce632023-02-08 17:38:29 +010090{
91 const unsigned char *p = buf;
92 size_t extensions_len;
93 const unsigned char *extensions_end;
94
Ronald Croneff56732023-04-03 17:36:31 +020095 *supported_versions_data = NULL;
96 *supported_versions_data_end = NULL;
Ronald Cron47dce632023-02-08 17:38:29 +010097
98 /* Case of no extension */
99 if (p == end) {
100 return 0;
101 }
102
103 /* ...
104 * Extension extensions<x..2^16-1>;
105 * ...
106 * struct {
107 * ExtensionType extension_type; (2 bytes)
108 * opaque extension_data<0..2^16-1>;
109 * } Extension;
110 */
111 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
112 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
113 p += 2;
114
115 /* Check extensions do not go beyond the buffer of data. */
116 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
117 extensions_end = p + extensions_len;
118
119 while (p < extensions_end) {
120 unsigned int extension_type;
121 size_t extension_data_len;
122
123 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
124 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
125 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
126 p += 4;
127 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
128
129 if (extension_type == MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS) {
Ronald Croneff56732023-04-03 17:36:31 +0200130 *supported_versions_data = p;
131 *supported_versions_data_end = p + extension_data_len;
Ronald Cron47dce632023-02-08 17:38:29 +0100132 return 1;
133 }
134 p += extension_data_len;
135 }
136
137 return 0;
138}
139
Ronald Cron928cbd32022-10-04 16:14:26 +0200140#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu30b071c2021-09-12 20:16:03 +0800141/*
Jerry Yu30b071c2021-09-12 20:16:03 +0800142 * STATE HANDLING: Read CertificateVerify
143 */
Jerry Yud0fc5852021-10-29 11:09:06 +0800144/* Macro to express the maximum length of the verify structure.
Jerry Yu30b071c2021-09-12 20:16:03 +0800145 *
146 * The structure is computed per TLS 1.3 specification as:
147 * - 64 bytes of octet 32,
148 * - 33 bytes for the context string
149 * (which is either "TLS 1.3, client CertificateVerify"
150 * or "TLS 1.3, server CertificateVerify"),
Jerry Yud0fc5852021-10-29 11:09:06 +0800151 * - 1 byte for the octet 0x0, which serves as a separator,
Jerry Yu30b071c2021-09-12 20:16:03 +0800152 * - 32 or 48 bytes for the Transcript-Hash(Handshake Context, Certificate)
153 * (depending on the size of the transcript_hash)
154 *
155 * This results in a total size of
156 * - 130 bytes for a SHA256-based transcript hash, or
157 * (64 + 33 + 1 + 32 bytes)
158 * - 146 bytes for a SHA384-based transcript hash.
159 * (64 + 33 + 1 + 48 bytes)
160 *
161 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100162#define SSL_VERIFY_STRUCT_MAX_SIZE (64 + \
163 33 + \
164 1 + \
165 MBEDTLS_TLS1_3_MD_MAX_SIZE \
166 )
Jerry Yu30b071c2021-09-12 20:16:03 +0800167
Jerry Yu0b32c502021-10-28 13:41:59 +0800168/*
169 * The ssl_tls13_create_verify_structure() creates the verify structure.
170 * As input, it requires the transcript hash.
171 *
172 * The caller has to ensure that the buffer has size at least
173 * SSL_VERIFY_STRUCT_MAX_SIZE bytes.
174 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100175static void ssl_tls13_create_verify_structure(const unsigned char *transcript_hash,
176 size_t transcript_hash_len,
177 unsigned char *verify_buffer,
178 size_t *verify_buffer_len,
179 int from)
Jerry Yu0b32c502021-10-28 13:41:59 +0800180{
181 size_t idx;
Jerry Yu30b071c2021-09-12 20:16:03 +0800182
Jerry Yu0b32c502021-10-28 13:41:59 +0800183 /* RFC 8446, Section 4.4.3:
184 *
185 * The digital signature [in the CertificateVerify message] is then
186 * computed over the concatenation of:
187 * - A string that consists of octet 32 (0x20) repeated 64 times
188 * - The context string
189 * - A single 0 byte which serves as the separator
190 * - The content to be signed
191 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100192 memset(verify_buffer, 0x20, 64);
Jerry Yu0b32c502021-10-28 13:41:59 +0800193 idx = 64;
194
Gilles Peskine449bd832023-01-11 14:50:10 +0100195 if (from == MBEDTLS_SSL_IS_CLIENT) {
Tom Cosgroveb32d7ae2024-04-02 14:26:13 +0100196 memcpy(verify_buffer + idx, mbedtls_ssl_tls13_labels.client_cv,
197 MBEDTLS_SSL_TLS1_3_LBL_LEN(client_cv));
Gilles Peskine449bd832023-01-11 14:50:10 +0100198 idx += MBEDTLS_SSL_TLS1_3_LBL_LEN(client_cv);
199 } else { /* from == MBEDTLS_SSL_IS_SERVER */
Tom Cosgroveb32d7ae2024-04-02 14:26:13 +0100200 memcpy(verify_buffer + idx, mbedtls_ssl_tls13_labels.server_cv,
201 MBEDTLS_SSL_TLS1_3_LBL_LEN(server_cv));
Gilles Peskine449bd832023-01-11 14:50:10 +0100202 idx += MBEDTLS_SSL_TLS1_3_LBL_LEN(server_cv);
Jerry Yu0b32c502021-10-28 13:41:59 +0800203 }
204
205 verify_buffer[idx++] = 0x0;
206
Gilles Peskine449bd832023-01-11 14:50:10 +0100207 memcpy(verify_buffer + idx, transcript_hash, transcript_hash_len);
Jerry Yu0b32c502021-10-28 13:41:59 +0800208 idx += transcript_hash_len;
209
210 *verify_buffer_len = idx;
211}
212
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200213MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100214static int ssl_tls13_parse_certificate_verify(mbedtls_ssl_context *ssl,
215 const unsigned char *buf,
216 const unsigned char *end,
217 const unsigned char *verify_buffer,
218 size_t verify_buffer_len)
Jerry Yu30b071c2021-09-12 20:16:03 +0800219{
220 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
pespaceka1378102022-04-26 15:03:11 +0200221 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu30b071c2021-09-12 20:16:03 +0800222 const unsigned char *p = buf;
223 uint16_t algorithm;
Jerry Yu30b071c2021-09-12 20:16:03 +0800224 size_t signature_len;
225 mbedtls_pk_type_t sig_alg;
226 mbedtls_md_type_t md_alg;
pespaceka1378102022-04-26 15:03:11 +0200227 psa_algorithm_t hash_alg = PSA_ALG_NONE;
228 unsigned char verify_hash[PSA_HASH_MAX_SIZE];
Jerry Yu30b071c2021-09-12 20:16:03 +0800229 size_t verify_hash_len;
230
Xiaofei Baid25fab62021-12-02 06:36:27 +0000231 void const *options = NULL;
XiaokangQian82d34cc2021-11-03 08:51:56 +0000232#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
Xiaofei Baid25fab62021-12-02 06:36:27 +0000233 mbedtls_pk_rsassa_pss_options rsassa_pss_options;
XiaokangQian82d34cc2021-11-03 08:51:56 +0000234#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
235
Jerry Yu30b071c2021-09-12 20:16:03 +0800236 /*
237 * struct {
238 * SignatureScheme algorithm;
239 * opaque signature<0..2^16-1>;
240 * } CertificateVerify;
241 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100242 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
243 algorithm = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu30b071c2021-09-12 20:16:03 +0800244 p += 2;
245
246 /* RFC 8446 section 4.4.3
247 *
Xiaokang Qian73437382023-03-29 08:24:12 +0000248 * If the CertificateVerify message is sent by a server, the signature
249 * algorithm MUST be one offered in the client's "signature_algorithms"
250 * extension unless no valid certificate chain can be produced without
251 * unsupported algorithms
Jerry Yu30b071c2021-09-12 20:16:03 +0800252 *
253 * RFC 8446 section 4.4.2.2
254 *
255 * If the client cannot construct an acceptable chain using the provided
Xiaokang Qian73437382023-03-29 08:24:12 +0000256 * certificates and decides to abort the handshake, then it MUST abort the
257 * handshake with an appropriate certificate-related alert
258 * (by default, "unsupported_certificate").
Jerry Yu30b071c2021-09-12 20:16:03 +0800259 *
Jerry Yu6f87f252021-10-29 20:12:51 +0800260 * Check if algorithm is an offered signature algorithm.
Jerry Yu30b071c2021-09-12 20:16:03 +0800261 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100262 if (!mbedtls_ssl_sig_alg_is_offered(ssl, algorithm)) {
Jerry Yu982d9e52021-10-14 15:59:37 +0800263 /* algorithm not in offered signature algorithms list */
Gilles Peskine449bd832023-01-11 14:50:10 +0100264 MBEDTLS_SSL_DEBUG_MSG(1, ("Received signature algorithm(%04x) is not "
265 "offered.",
266 (unsigned int) algorithm));
Jerry Yu6f87f252021-10-29 20:12:51 +0800267 goto error;
Jerry Yu30b071c2021-09-12 20:16:03 +0800268 }
269
Gilles Peskine449bd832023-01-11 14:50:10 +0100270 if (mbedtls_ssl_get_pk_type_and_md_alg_from_sig_alg(
271 algorithm, &sig_alg, &md_alg) != 0) {
Jerry Yu8c338862022-03-23 13:34:04 +0800272 goto error;
Jerry Yu30b071c2021-09-12 20:16:03 +0800273 }
274
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +0200275 hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +0100276 if (hash_alg == 0) {
pespaceka1378102022-04-26 15:03:11 +0200277 goto error;
278 }
279
Gilles Peskine449bd832023-01-11 14:50:10 +0100280 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate Verify: Signature algorithm ( %04x )",
281 (unsigned int) algorithm));
Jerry Yu30b071c2021-09-12 20:16:03 +0800282
283 /*
284 * Check the certificate's key type matches the signature alg
285 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100286 if (!mbedtls_pk_can_do(&ssl->session_negotiate->peer_cert->pk, sig_alg)) {
287 MBEDTLS_SSL_DEBUG_MSG(1, ("signature algorithm doesn't match cert key"));
Jerry Yu6f87f252021-10-29 20:12:51 +0800288 goto error;
Jerry Yu30b071c2021-09-12 20:16:03 +0800289 }
290
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
292 signature_len = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu30b071c2021-09-12 20:16:03 +0800293 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100294 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, signature_len);
Jerry Yu30b071c2021-09-12 20:16:03 +0800295
Gilles Peskine449bd832023-01-11 14:50:10 +0100296 status = psa_hash_compute(hash_alg,
297 verify_buffer,
298 verify_buffer_len,
299 verify_hash,
300 sizeof(verify_hash),
301 &verify_hash_len);
302 if (status != PSA_SUCCESS) {
303 MBEDTLS_SSL_DEBUG_RET(1, "hash computation PSA error", status);
Jerry Yu6f87f252021-10-29 20:12:51 +0800304 goto error;
Jerry Yu133690c2021-10-25 14:01:13 +0800305 }
306
Gilles Peskine449bd832023-01-11 14:50:10 +0100307 MBEDTLS_SSL_DEBUG_BUF(3, "verify hash", verify_hash, verify_hash_len);
XiaokangQian82d34cc2021-11-03 08:51:56 +0000308#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
Gilles Peskine449bd832023-01-11 14:50:10 +0100309 if (sig_alg == MBEDTLS_PK_RSASSA_PSS) {
Xiaofei Baid25fab62021-12-02 06:36:27 +0000310 rsassa_pss_options.mgf1_hash_id = md_alg;
Przemek Stekiel6a5e0182022-06-27 11:53:13 +0200311
Gilles Peskine449bd832023-01-11 14:50:10 +0100312 rsassa_pss_options.expected_salt_len = PSA_HASH_LENGTH(hash_alg);
313 options = (const void *) &rsassa_pss_options;
XiaokangQian82d34cc2021-11-03 08:51:56 +0000314 }
315#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
Jerry Yu30b071c2021-09-12 20:16:03 +0800316
Gilles Peskine449bd832023-01-11 14:50:10 +0100317 if ((ret = mbedtls_pk_verify_ext(sig_alg, options,
318 &ssl->session_negotiate->peer_cert->pk,
319 md_alg, verify_hash, verify_hash_len,
320 p, signature_len)) == 0) {
321 return 0;
Jerry Yu30b071c2021-09-12 20:16:03 +0800322 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_pk_verify_ext", ret);
Jerry Yu30b071c2021-09-12 20:16:03 +0800324
Jerry Yu6f87f252021-10-29 20:12:51 +0800325error:
326 /* RFC 8446 section 4.4.3
327 *
328 * If the verification fails, the receiver MUST terminate the handshake
329 * with a "decrypt_error" alert.
Gilles Peskine449bd832023-01-11 14:50:10 +0100330 */
331 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
332 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
333 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu6f87f252021-10-29 20:12:51 +0800334
Jerry Yu30b071c2021-09-12 20:16:03 +0800335}
Ronald Cron928cbd32022-10-04 16:14:26 +0200336#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu30b071c2021-09-12 20:16:03 +0800337
Gilles Peskine449bd832023-01-11 14:50:10 +0100338int mbedtls_ssl_tls13_process_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu30b071c2021-09-12 20:16:03 +0800339{
Jerry Yu30b071c2021-09-12 20:16:03 +0800340
Ronald Cron928cbd32022-10-04 16:14:26 +0200341#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yuda8cdf22021-10-25 15:06:49 +0800342 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
343 unsigned char verify_buffer[SSL_VERIFY_STRUCT_MAX_SIZE];
344 size_t verify_buffer_len;
345 unsigned char transcript[MBEDTLS_TLS1_3_MD_MAX_SIZE];
346 size_t transcript_len;
347 unsigned char *buf;
348 size_t buf_len;
349
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate verify"));
Jerry Yu30b071c2021-09-12 20:16:03 +0800351
Jerry Yuda8cdf22021-10-25 15:06:49 +0800352 MBEDTLS_SSL_PROC_CHK(
Xiaokang Qian73437382023-03-29 08:24:12 +0000353 mbedtls_ssl_tls13_fetch_handshake_msg(
354 ssl, MBEDTLS_SSL_HS_CERTIFICATE_VERIFY, &buf, &buf_len));
Jerry Yu30b071c2021-09-12 20:16:03 +0800355
Jerry Yuda8cdf22021-10-25 15:06:49 +0800356 /* Need to calculate the hash of the transcript first
Jerry Yu0b32c502021-10-28 13:41:59 +0800357 * before reading the message since otherwise it gets
358 * included in the transcript
359 */
Xiaokang Qian73437382023-03-29 08:24:12 +0000360 ret = mbedtls_ssl_get_handshake_transcript(
361 ssl,
Dave Rodgman2eab4622023-10-05 13:30:37 +0100362 (mbedtls_md_type_t) ssl->handshake->ciphersuite_info->mac,
Xiaokang Qian73437382023-03-29 08:24:12 +0000363 transcript, sizeof(transcript),
364 &transcript_len);
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 if (ret != 0) {
Jerry Yuda8cdf22021-10-25 15:06:49 +0800366 MBEDTLS_SSL_PEND_FATAL_ALERT(
367 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 MBEDTLS_ERR_SSL_INTERNAL_ERROR);
369 return ret;
Jerry Yu30b071c2021-09-12 20:16:03 +0800370 }
371
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 MBEDTLS_SSL_DEBUG_BUF(3, "handshake hash", transcript, transcript_len);
Jerry Yuda8cdf22021-10-25 15:06:49 +0800373
374 /* Create verify structure */
Gilles Peskine449bd832023-01-11 14:50:10 +0100375 ssl_tls13_create_verify_structure(transcript,
376 transcript_len,
377 verify_buffer,
378 &verify_buffer_len,
379 (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) ?
380 MBEDTLS_SSL_IS_SERVER :
381 MBEDTLS_SSL_IS_CLIENT);
Jerry Yuda8cdf22021-10-25 15:06:49 +0800382
383 /* Process the message contents */
Xiaokang Qian73437382023-03-29 08:24:12 +0000384 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_certificate_verify(
385 ssl, buf, buf + buf_len,
386 verify_buffer, verify_buffer_len));
Jerry Yuda8cdf22021-10-25 15:06:49 +0800387
Xiaokang Qian73437382023-03-29 08:24:12 +0000388 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
389 ssl, MBEDTLS_SSL_HS_CERTIFICATE_VERIFY,
390 buf, buf_len));
Jerry Yu30b071c2021-09-12 20:16:03 +0800391
392cleanup:
393
Gilles Peskine449bd832023-01-11 14:50:10 +0100394 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate verify"));
395 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_tls13_process_certificate_verify", ret);
396 return ret;
Jerry Yuda8cdf22021-10-25 15:06:49 +0800397#else
398 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +0100399 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
400 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Ronald Cron928cbd32022-10-04 16:14:26 +0200401#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu30b071c2021-09-12 20:16:03 +0800402}
403
404/*
Xiaofei Bai947571e2021-09-29 09:12:03 +0000405 *
XiaokangQian6b916b12022-04-25 07:29:34 +0000406 * STATE HANDLING: Incoming Certificate.
Xiaofei Bai947571e2021-09-29 09:12:03 +0000407 *
408 */
409
Ronald Cronde08cf32022-10-04 17:15:35 +0200410#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai947571e2021-09-29 09:12:03 +0000411#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
412/*
413 * Structure of Certificate message:
414 *
415 * enum {
416 * X509(0),
417 * RawPublicKey(2),
418 * (255)
419 * } CertificateType;
420 *
421 * struct {
422 * select (certificate_type) {
423 * case RawPublicKey:
424 * * From RFC 7250 ASN.1_subjectPublicKeyInfo *
425 * opaque ASN1_subjectPublicKeyInfo<1..2^24-1>;
426 * case X509:
427 * opaque cert_data<1..2^24-1>;
428 * };
429 * Extension extensions<0..2^16-1>;
430 * } CertificateEntry;
431 *
432 * struct {
433 * opaque certificate_request_context<0..2^8-1>;
434 * CertificateEntry certificate_list<0..2^24-1>;
435 * } Certificate;
436 *
437 */
Xiaofei Bai79595ac2021-10-26 07:16:45 +0000438
439/* Parse certificate chain send by the server. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200440MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Crone3dac4a2022-06-10 17:21:51 +0200441MBEDTLS_STATIC_TESTABLE
Gilles Peskine449bd832023-01-11 14:50:10 +0100442int mbedtls_ssl_tls13_parse_certificate(mbedtls_ssl_context *ssl,
443 const unsigned char *buf,
444 const unsigned char *end)
Xiaofei Bai947571e2021-09-29 09:12:03 +0000445{
446 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
447 size_t certificate_request_context_len = 0;
448 size_t certificate_list_len = 0;
449 const unsigned char *p = buf;
450 const unsigned char *certificate_list_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +0800451 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Bai947571e2021-09-29 09:12:03 +0000452
Gilles Peskine449bd832023-01-11 14:50:10 +0100453 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
Xiaofei Bai947571e2021-09-29 09:12:03 +0000454 certificate_request_context_len = p[0];
Gilles Peskine449bd832023-01-11 14:50:10 +0100455 certificate_list_len = MBEDTLS_GET_UINT24_BE(p, 1);
XiaokangQian63e713e2022-05-15 04:26:57 +0000456 p += 4;
Xiaofei Bai947571e2021-09-29 09:12:03 +0000457
458 /* In theory, the certificate list can be up to 2^24 Bytes, but we don't
459 * support anything beyond 2^16 = 64K.
460 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100461 if ((certificate_request_context_len != 0) ||
462 (certificate_list_len >= 0x10000)) {
463 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
464 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
465 MBEDTLS_ERR_SSL_DECODE_ERROR);
466 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaofei Bai947571e2021-09-29 09:12:03 +0000467 }
468
469 /* In case we tried to reuse a session but it failed */
Gilles Peskine449bd832023-01-11 14:50:10 +0100470 if (ssl->session_negotiate->peer_cert != NULL) {
471 mbedtls_x509_crt_free(ssl->session_negotiate->peer_cert);
472 mbedtls_free(ssl->session_negotiate->peer_cert);
Xiaofei Bai947571e2021-09-29 09:12:03 +0000473 }
474
Manuel Pégourié-Gonnard4d4c0c72024-08-12 10:36:40 +0200475 /* This is used by ssl_tls13_validate_certificate() */
Gilles Peskine449bd832023-01-11 14:50:10 +0100476 if (certificate_list_len == 0) {
XiaokangQianc3017f62022-05-13 05:55:41 +0000477 ssl->session_negotiate->peer_cert = NULL;
478 ret = 0;
479 goto exit;
480 }
481
Gilles Peskine449bd832023-01-11 14:50:10 +0100482 if ((ssl->session_negotiate->peer_cert =
483 mbedtls_calloc(1, sizeof(mbedtls_x509_crt))) == NULL) {
484 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc( %" MBEDTLS_PRINTF_SIZET " bytes ) failed",
485 sizeof(mbedtls_x509_crt)));
486 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR,
487 MBEDTLS_ERR_SSL_ALLOC_FAILED);
488 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Xiaofei Bai947571e2021-09-29 09:12:03 +0000489 }
490
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 mbedtls_x509_crt_init(ssl->session_negotiate->peer_cert);
Xiaofei Bai947571e2021-09-29 09:12:03 +0000492
Gilles Peskine449bd832023-01-11 14:50:10 +0100493 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, certificate_list_len);
Xiaofei Bai947571e2021-09-29 09:12:03 +0000494 certificate_list_end = p + certificate_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100495 while (p < certificate_list_end) {
Xiaofei Bai947571e2021-09-29 09:12:03 +0000496 size_t cert_data_len, extensions_len;
Jerry Yu2eaa7602022-08-04 17:28:15 +0800497 const unsigned char *extensions_end;
Xiaofei Bai947571e2021-09-29 09:12:03 +0000498
Gilles Peskine449bd832023-01-11 14:50:10 +0100499 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, certificate_list_end, 3);
500 cert_data_len = MBEDTLS_GET_UINT24_BE(p, 0);
Xiaofei Bai947571e2021-09-29 09:12:03 +0000501 p += 3;
502
503 /* In theory, the CRT can be up to 2^24 Bytes, but we don't support
504 * anything beyond 2^16 = 64K. Otherwise as in the TLS 1.2 code,
505 * check that we have a minimum of 128 bytes of data, this is not
506 * clear why we need that though.
507 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100508 if ((cert_data_len < 128) || (cert_data_len >= 0x10000)) {
509 MBEDTLS_SSL_DEBUG_MSG(1, ("bad Certificate message"));
510 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
511 MBEDTLS_ERR_SSL_DECODE_ERROR);
512 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaofei Bai947571e2021-09-29 09:12:03 +0000513 }
514
Gilles Peskine449bd832023-01-11 14:50:10 +0100515 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, certificate_list_end, cert_data_len);
516 ret = mbedtls_x509_crt_parse_der(ssl->session_negotiate->peer_cert,
517 p, cert_data_len);
Xiaofei Bai947571e2021-09-29 09:12:03 +0000518
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 switch (ret) {
Xiaofei Bai947571e2021-09-29 09:12:03 +0000520 case 0: /*ok*/
521 break;
522 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
523 /* Ignore certificate with an unknown algorithm: maybe a
524 prior certificate was already trusted. */
525 break;
526
527 case MBEDTLS_ERR_X509_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR,
529 MBEDTLS_ERR_X509_ALLOC_FAILED);
530 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
531 return ret;
Xiaofei Bai947571e2021-09-29 09:12:03 +0000532
533 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT,
535 MBEDTLS_ERR_X509_UNKNOWN_VERSION);
536 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
537 return ret;
Xiaofei Bai947571e2021-09-29 09:12:03 +0000538
539 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_BAD_CERT,
541 ret);
542 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
543 return ret;
Xiaofei Bai947571e2021-09-29 09:12:03 +0000544 }
545
546 p += cert_data_len;
547
548 /* Certificate extensions length */
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, certificate_list_end, 2);
550 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
Xiaofei Bai947571e2021-09-29 09:12:03 +0000551 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, certificate_list_end, extensions_len);
Jerry Yu2eaa7602022-08-04 17:28:15 +0800553
554 extensions_end = p + extensions_len;
Jerry Yu0d5cfb72022-10-31 14:15:48 +0800555 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu2eaa7602022-08-04 17:28:15 +0800556
Gilles Peskine449bd832023-01-11 14:50:10 +0100557 while (p < extensions_end) {
Jerry Yu2eaa7602022-08-04 17:28:15 +0800558 unsigned int extension_type;
559 size_t extension_data_len;
560
561 /*
Gilles Peskine449bd832023-01-11 14:50:10 +0100562 * struct {
563 * ExtensionType extension_type; (2 bytes)
564 * opaque extension_data<0..2^16-1>;
565 * } Extension;
566 */
567 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
568 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
569 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yu2eaa7602022-08-04 17:28:15 +0800570 p += 4;
571
Gilles Peskine449bd832023-01-11 14:50:10 +0100572 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
Jerry Yu2eaa7602022-08-04 17:28:15 +0800573
Jerry Yuc4bf5d62022-10-29 09:08:47 +0800574 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +0100575 ssl, MBEDTLS_SSL_HS_CERTIFICATE, extension_type,
576 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CT);
577 if (ret != 0) {
578 return ret;
579 }
Jerry Yu0c354a22022-08-29 15:25:36 +0800580
Gilles Peskine449bd832023-01-11 14:50:10 +0100581 switch (extension_type) {
Jerry Yu2eaa7602022-08-04 17:28:15 +0800582 default:
Jerry Yu79aa7212022-11-08 21:30:21 +0800583 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu0d5cfb72022-10-31 14:15:48 +0800584 3, MBEDTLS_SSL_HS_CERTIFICATE,
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 extension_type, "( ignored )");
Jerry Yu2eaa7602022-08-04 17:28:15 +0800586 break;
587 }
588
589 p += extension_data_len;
590 }
591
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CERTIFICATE,
593 handshake->received_extensions);
Xiaofei Bai947571e2021-09-29 09:12:03 +0000594 }
595
XiaokangQian63e713e2022-05-15 04:26:57 +0000596exit:
Xiaofei Bai947571e2021-09-29 09:12:03 +0000597 /* Check that all the message is consumed. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100598 if (p != end) {
599 MBEDTLS_SSL_DEBUG_MSG(1, ("bad Certificate message"));
600 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
601 MBEDTLS_ERR_SSL_DECODE_ERROR);
602 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Xiaofei Bai947571e2021-09-29 09:12:03 +0000603 }
604
Xiaokang Qian73437382023-03-29 08:24:12 +0000605 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate",
606 ssl->session_negotiate->peer_cert);
Xiaofei Bai947571e2021-09-29 09:12:03 +0000607
Gilles Peskine449bd832023-01-11 14:50:10 +0100608 return ret;
Xiaofei Bai947571e2021-09-29 09:12:03 +0000609}
610#else
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200611MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Crone3dac4a2022-06-10 17:21:51 +0200612MBEDTLS_STATIC_TESTABLE
Gilles Peskine449bd832023-01-11 14:50:10 +0100613int mbedtls_ssl_tls13_parse_certificate(mbedtls_ssl_context *ssl,
614 const unsigned char *buf,
615 const unsigned char *end)
Xiaofei Bai947571e2021-09-29 09:12:03 +0000616{
617 ((void) ssl);
618 ((void) buf);
619 ((void) end);
Gilles Peskine449bd832023-01-11 14:50:10 +0100620 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Xiaofei Bai947571e2021-09-29 09:12:03 +0000621}
622#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Ronald Cronde08cf32022-10-04 17:15:35 +0200623#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Xiaofei Bai947571e2021-09-29 09:12:03 +0000624
Ronald Cronde08cf32022-10-04 17:15:35 +0200625#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai947571e2021-09-29 09:12:03 +0000626#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Xiaofei Bai79595ac2021-10-26 07:16:45 +0000627/* Validate certificate chain sent by the server. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200628MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100629static int ssl_tls13_validate_certificate(mbedtls_ssl_context *ssl)
Xiaofei Bai947571e2021-09-29 09:12:03 +0000630{
631 int ret = 0;
XiaokangQian989f06d2022-05-17 01:50:15 +0000632 int authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
Xiaofei Bai947571e2021-09-29 09:12:03 +0000633 mbedtls_x509_crt *ca_chain;
634 mbedtls_x509_crl *ca_crl;
Xiaofei Baiff456022021-10-28 06:50:17 +0000635 uint32_t verify_result = 0;
Xiaofei Bai947571e2021-09-29 09:12:03 +0000636
XiaokangQian6b916b12022-04-25 07:29:34 +0000637 /* If SNI was used, overwrite authentication mode
638 * from the configuration. */
XiaokangQian989f06d2022-05-17 01:50:15 +0000639#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100640 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
XiaokangQian0557c942022-05-30 08:10:53 +0000641#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100642 if (ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET) {
XiaokangQian0557c942022-05-30 08:10:53 +0000643 authmode = ssl->handshake->sni_authmode;
Gilles Peskine449bd832023-01-11 14:50:10 +0100644 } else
XiaokangQian0557c942022-05-30 08:10:53 +0000645#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100646 authmode = ssl->conf->authmode;
XiaokangQian0557c942022-05-30 08:10:53 +0000647 }
XiaokangQian6b916b12022-04-25 07:29:34 +0000648#endif
649
650 /*
XiaokangQian989f06d2022-05-17 01:50:15 +0000651 * If the peer hasn't sent a certificate ( i.e. it sent
XiaokangQian6b916b12022-04-25 07:29:34 +0000652 * an empty certificate chain ), this is reflected in the peer CRT
653 * structure being unset.
654 * Check for that and handle it depending on the
XiaokangQian989f06d2022-05-17 01:50:15 +0000655 * authentication mode.
XiaokangQian6b916b12022-04-25 07:29:34 +0000656 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100657 if (ssl->session_negotiate->peer_cert == NULL) {
658 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
XiaokangQian989f06d2022-05-17 01:50:15 +0000659
XiaokangQian63e713e2022-05-15 04:26:57 +0000660#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100661 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
XiaokangQian63e713e2022-05-15 04:26:57 +0000662 /* The client was asked for a certificate but didn't send
663 * one. The client should know what's going on, so we
664 * don't send an alert.
665 */
666 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
Gilles Peskine449bd832023-01-11 14:50:10 +0100667 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
668 return 0;
669 } else {
Xiaokang Qian73437382023-03-29 08:24:12 +0000670 MBEDTLS_SSL_PEND_FATAL_ALERT(
671 MBEDTLS_SSL_ALERT_MSG_NO_CERT,
672 MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE);
Gilles Peskine449bd832023-01-11 14:50:10 +0100673 return MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
XiaokangQian989f06d2022-05-17 01:50:15 +0000674 }
XiaokangQian63e713e2022-05-15 04:26:57 +0000675 }
XiaokangQian6b916b12022-04-25 07:29:34 +0000676#endif /* MBEDTLS_SSL_SRV_C */
677
XiaokangQianc3017f62022-05-13 05:55:41 +0000678#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard4d4c0c72024-08-12 10:36:40 +0200679 /* Regardless of authmode, the server is not allowed to send an empty
680 * certificate chain. (Last paragraph before 4.4.2.1 in RFC 8446: "The
681 * server's certificate_list MUST always be non-empty.") With authmode
682 * optional/none, we continue the handshake if we can't validate the
683 * server's cert, but we still break it if no certificate was sent. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
685 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_NO_CERT,
686 MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE);
687 return MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE;
XiaokangQian63e713e2022-05-15 04:26:57 +0000688 }
XiaokangQianc3017f62022-05-13 05:55:41 +0000689#endif /* MBEDTLS_SSL_CLI_C */
XiaokangQian63e713e2022-05-15 04:26:57 +0000690 }
XiaokangQian6b916b12022-04-25 07:29:34 +0000691
Xiaofei Bai947571e2021-09-29 09:12:03 +0000692#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100693 if (ssl->handshake->sni_ca_chain != NULL) {
Xiaofei Bai947571e2021-09-29 09:12:03 +0000694 ca_chain = ssl->handshake->sni_ca_chain;
695 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 } else
Xiaofei Bai947571e2021-09-29 09:12:03 +0000697#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
698 {
699 ca_chain = ssl->conf->ca_chain;
700 ca_crl = ssl->conf->ca_crl;
701 }
702
703 /*
704 * Main check: verify certificate
705 */
706 ret = mbedtls_x509_crt_verify_with_profile(
707 ssl->session_negotiate->peer_cert,
708 ca_chain, ca_crl,
709 ssl->conf->cert_profile,
710 ssl->hostname,
Xiaofei Baiff456022021-10-28 06:50:17 +0000711 &verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +0100712 ssl->conf->f_vrfy, ssl->conf->p_vrfy);
Xiaofei Bai947571e2021-09-29 09:12:03 +0000713
Gilles Peskine449bd832023-01-11 14:50:10 +0100714 if (ret != 0) {
715 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Xiaofei Bai947571e2021-09-29 09:12:03 +0000716 }
717
718 /*
719 * Secondary checks: always done, but change 'ret' only if it was 0
720 */
Manuel Pégourié-Gonnard4938b692024-08-09 11:49:12 +0200721 if (mbedtls_ssl_check_cert_usage(ssl->session_negotiate->peer_cert,
722 NULL,
723 ssl->conf->endpoint,
724 MBEDTLS_SSL_VERSION_TLS1_3,
725 &verify_result) != 0) {
Manuel Pégourié-Gonnardef41d8c2024-08-08 10:28:56 +0200726 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
727 if (ret == 0) {
728 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
729 }
Xiaofei Bai947571e2021-09-29 09:12:03 +0000730 }
731
XiaokangQian6b916b12022-04-25 07:29:34 +0000732 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
733 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
734 * with details encoded in the verification flags. All other kinds
735 * of error codes, including those from the user provided f_vrfy
736 * functions, are treated as fatal and lead to a failure of
Ronald Crone3dac4a2022-06-10 17:21:51 +0200737 * mbedtls_ssl_tls13_parse_certificate even if verification was optional.
738 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100739 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
740 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
741 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
XiaokangQian6b916b12022-04-25 07:29:34 +0000742 ret = 0;
743 }
Xiaofei Bai947571e2021-09-29 09:12:03 +0000744
Gilles Peskine449bd832023-01-11 14:50:10 +0100745 if (ca_chain == NULL && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
746 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Xiaofei Bai947571e2021-09-29 09:12:03 +0000747 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
748 }
749
Gilles Peskine449bd832023-01-11 14:50:10 +0100750 if (ret != 0) {
Xiaofei Bai947571e2021-09-29 09:12:03 +0000751 /* The certificate may have been rejected for several reasons.
752 Pick one and send the corresponding alert. Which alert to send
753 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100754 if (verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Xiaokang Qian73437382023-03-29 08:24:12 +0000755 MBEDTLS_SSL_PEND_FATAL_ALERT(
756 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED, ret);
Gilles Peskine449bd832023-01-11 14:50:10 +0100757 } else if (verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
758 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_BAD_CERT, ret);
759 } else if (verify_result & (MBEDTLS_X509_BADCERT_KEY_USAGE |
760 MBEDTLS_X509_BADCERT_EXT_KEY_USAGE |
Gilles Peskine449bd832023-01-11 14:50:10 +0100761 MBEDTLS_X509_BADCERT_BAD_PK |
762 MBEDTLS_X509_BADCERT_BAD_KEY)) {
Xiaokang Qian73437382023-03-29 08:24:12 +0000763 MBEDTLS_SSL_PEND_FATAL_ALERT(
764 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT, ret);
Gilles Peskine449bd832023-01-11 14:50:10 +0100765 } else if (verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Xiaokang Qian73437382023-03-29 08:24:12 +0000766 MBEDTLS_SSL_PEND_FATAL_ALERT(
767 MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED, ret);
Gilles Peskine449bd832023-01-11 14:50:10 +0100768 } else if (verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Xiaokang Qian73437382023-03-29 08:24:12 +0000769 MBEDTLS_SSL_PEND_FATAL_ALERT(
770 MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED, ret);
Gilles Peskine449bd832023-01-11 14:50:10 +0100771 } else if (verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
772 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA, ret);
773 } else {
Xiaokang Qian73437382023-03-29 08:24:12 +0000774 MBEDTLS_SSL_PEND_FATAL_ALERT(
775 MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN, ret);
Gilles Peskine449bd832023-01-11 14:50:10 +0100776 }
Xiaofei Bai947571e2021-09-29 09:12:03 +0000777 }
778
779#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100780 if (verify_result != 0) {
781 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
782 (unsigned int) verify_result));
783 } else {
784 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Xiaofei Bai947571e2021-09-29 09:12:03 +0000785 }
786#endif /* MBEDTLS_DEBUG_C */
787
Xiaofei Baiff456022021-10-28 06:50:17 +0000788 ssl->session_negotiate->verify_result = verify_result;
Gilles Peskine449bd832023-01-11 14:50:10 +0100789 return ret;
Xiaofei Bai947571e2021-09-29 09:12:03 +0000790}
791#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200792MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100793static int ssl_tls13_validate_certificate(mbedtls_ssl_context *ssl)
Xiaofei Bai947571e2021-09-29 09:12:03 +0000794{
795 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +0100796 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Xiaofei Bai947571e2021-09-29 09:12:03 +0000797}
798#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Ronald Cronde08cf32022-10-04 17:15:35 +0200799#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Xiaofei Bai947571e2021-09-29 09:12:03 +0000800
Gilles Peskine449bd832023-01-11 14:50:10 +0100801int mbedtls_ssl_tls13_process_certificate(mbedtls_ssl_context *ssl)
Xiaofei Bai947571e2021-09-29 09:12:03 +0000802{
Xiaofei Bai79595ac2021-10-26 07:16:45 +0000803 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100804 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Xiaofei Bai79595ac2021-10-26 07:16:45 +0000805
Ronald Cronde08cf32022-10-04 17:15:35 +0200806#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQianc3017f62022-05-13 05:55:41 +0000807 unsigned char *buf;
808 size_t buf_len;
Xiaofei Bai79595ac2021-10-26 07:16:45 +0000809
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
811 ssl, MBEDTLS_SSL_HS_CERTIFICATE,
812 &buf, &buf_len));
Xiaofei Bai79595ac2021-10-26 07:16:45 +0000813
XiaokangQianc3017f62022-05-13 05:55:41 +0000814 /* Parse the certificate chain sent by the peer. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100815 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_parse_certificate(ssl, buf,
816 buf + buf_len));
XiaokangQianc3017f62022-05-13 05:55:41 +0000817 /* Validate the certificate chain and set the verification results. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100818 MBEDTLS_SSL_PROC_CHK(ssl_tls13_validate_certificate(ssl));
Xiaofei Bai79595ac2021-10-26 07:16:45 +0000819
Xiaokang Qian73437382023-03-29 08:24:12 +0000820 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
821 ssl, MBEDTLS_SSL_HS_CERTIFICATE, buf, buf_len));
Xiaofei Bai79595ac2021-10-26 07:16:45 +0000822
Xiaofei Bai79595ac2021-10-26 07:16:45 +0000823cleanup:
Gilles Peskineff2558a2023-09-05 21:10:39 +0200824#else /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
825 (void) ssl;
Ronald Cronde08cf32022-10-04 17:15:35 +0200826#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Xiaofei Bai79595ac2021-10-26 07:16:45 +0000827
Gilles Peskine449bd832023-01-11 14:50:10 +0100828 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
829 return ret;
Xiaofei Bai947571e2021-09-29 09:12:03 +0000830}
Ronald Cron928cbd32022-10-04 16:14:26 +0200831#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu7399d0d2022-01-30 17:54:19 +0800832/*
833 * enum {
834 * X509(0),
835 * RawPublicKey(2),
836 * (255)
837 * } CertificateType;
838 *
839 * struct {
840 * select (certificate_type) {
841 * case RawPublicKey:
842 * // From RFC 7250 ASN.1_subjectPublicKeyInfo
843 * opaque ASN1_subjectPublicKeyInfo<1..2^24-1>;
844 *
845 * case X509:
846 * opaque cert_data<1..2^24-1>;
847 * };
848 * Extension extensions<0..2^16-1>;
849 * } CertificateEntry;
850 *
851 * struct {
852 * opaque certificate_request_context<0..2^8-1>;
853 * CertificateEntry certificate_list<0..2^24-1>;
854 * } Certificate;
855 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200856MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100857static int ssl_tls13_write_certificate_body(mbedtls_ssl_context *ssl,
858 unsigned char *buf,
859 unsigned char *end,
860 size_t *out_len)
Jerry Yu5cc35062022-01-28 16:16:08 +0800861{
Gilles Peskine449bd832023-01-11 14:50:10 +0100862 const mbedtls_x509_crt *crt = mbedtls_ssl_own_cert(ssl);
Jerry Yu3e536442022-02-15 11:05:59 +0800863 unsigned char *p = buf;
Jerry Yuc8d8d4e2022-02-18 12:10:03 +0800864 unsigned char *certificate_request_context =
Gilles Peskine449bd832023-01-11 14:50:10 +0100865 ssl->handshake->certificate_request_context;
Jerry Yuc8d8d4e2022-02-18 12:10:03 +0800866 unsigned char certificate_request_context_len =
Gilles Peskine449bd832023-01-11 14:50:10 +0100867 ssl->handshake->certificate_request_context_len;
Jerry Yuc8d8d4e2022-02-18 12:10:03 +0800868 unsigned char *p_certificate_list_len;
Jerry Yu5cc35062022-01-28 16:16:08 +0800869
Jerry Yu5cc35062022-01-28 16:16:08 +0800870
Jerry Yu3391ac02022-02-16 11:21:37 +0800871 /* ...
872 * opaque certificate_request_context<0..2^8-1>;
873 * ...
874 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100875 MBEDTLS_SSL_CHK_BUF_PTR(p, end, certificate_request_context_len + 1);
Jerry Yuc8d8d4e2022-02-18 12:10:03 +0800876 *p++ = certificate_request_context_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100877 if (certificate_request_context_len > 0) {
878 memcpy(p, certificate_request_context, certificate_request_context_len);
Jerry Yuc8d8d4e2022-02-18 12:10:03 +0800879 p += certificate_request_context_len;
Jerry Yu537530d2022-02-15 14:00:57 +0800880 }
881
Jerry Yu3391ac02022-02-16 11:21:37 +0800882 /* ...
883 * CertificateEntry certificate_list<0..2^24-1>;
884 * ...
885 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100886 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 3);
Jerry Yuc8d8d4e2022-02-18 12:10:03 +0800887 p_certificate_list_len = p;
Jerry Yu3e536442022-02-15 11:05:59 +0800888 p += 3;
889
Gilles Peskine449bd832023-01-11 14:50:10 +0100890 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", crt);
Jerry Yu5cc35062022-01-28 16:16:08 +0800891
Gilles Peskine449bd832023-01-11 14:50:10 +0100892 while (crt != NULL) {
Jerry Yu7399d0d2022-01-30 17:54:19 +0800893 size_t cert_data_len = crt->raw.len;
Jerry Yu5cc35062022-01-28 16:16:08 +0800894
Gilles Peskine449bd832023-01-11 14:50:10 +0100895 MBEDTLS_SSL_CHK_BUF_PTR(p, end, cert_data_len + 3 + 2);
896 MBEDTLS_PUT_UINT24_BE(cert_data_len, p, 0);
Jerry Yu7399d0d2022-01-30 17:54:19 +0800897 p += 3;
Jerry Yu5cc35062022-01-28 16:16:08 +0800898
Gilles Peskine449bd832023-01-11 14:50:10 +0100899 memcpy(p, crt->raw.p, cert_data_len);
Jerry Yu7399d0d2022-01-30 17:54:19 +0800900 p += cert_data_len;
901 crt = crt->next;
Jerry Yu5cc35062022-01-28 16:16:08 +0800902
903 /* Currently, we don't have any certificate extensions defined.
904 * Hence, we are sending an empty extension with length zero.
905 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100906 MBEDTLS_PUT_UINT16_BE(0, p, 0);
Jerry Yu7399d0d2022-01-30 17:54:19 +0800907 p += 2;
Jerry Yu5cc35062022-01-28 16:16:08 +0800908 }
Jerry Yu5cc35062022-01-28 16:16:08 +0800909
Gilles Peskine449bd832023-01-11 14:50:10 +0100910 MBEDTLS_PUT_UINT24_BE(p - p_certificate_list_len - 3,
911 p_certificate_list_len, 0);
Jerry Yu7399d0d2022-01-30 17:54:19 +0800912
Jerry Yu3e536442022-02-15 11:05:59 +0800913 *out_len = p - buf;
Jerry Yu5cc35062022-01-28 16:16:08 +0800914
Jerry Yu7de2ff02022-11-08 21:43:46 +0800915 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +0100916 3, MBEDTLS_SSL_HS_CERTIFICATE, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800917
Gilles Peskine449bd832023-01-11 14:50:10 +0100918 return 0;
Jerry Yu5cc35062022-01-28 16:16:08 +0800919}
Jerry Yu5cc35062022-01-28 16:16:08 +0800920
Gilles Peskine449bd832023-01-11 14:50:10 +0100921int mbedtls_ssl_tls13_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yu5cc35062022-01-28 16:16:08 +0800922{
923 int ret;
Ronald Cron5bb8fc82022-03-09 07:00:13 +0100924 unsigned char *buf;
925 size_t buf_len, msg_len;
926
Gilles Peskine449bd832023-01-11 14:50:10 +0100927 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yu5cc35062022-01-28 16:16:08 +0800928
Xiaokang Qian73437382023-03-29 08:24:12 +0000929 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
930 ssl, MBEDTLS_SSL_HS_CERTIFICATE, &buf, &buf_len));
Jerry Yu5cc35062022-01-28 16:16:08 +0800931
Gilles Peskine449bd832023-01-11 14:50:10 +0100932 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_body(ssl,
933 buf,
934 buf + buf_len,
935 &msg_len));
Jerry Yu5cc35062022-01-28 16:16:08 +0800936
Xiaokang Qian73437382023-03-29 08:24:12 +0000937 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
938 ssl, MBEDTLS_SSL_HS_CERTIFICATE, buf, msg_len));
Jerry Yu5cc35062022-01-28 16:16:08 +0800939
Gilles Peskine449bd832023-01-11 14:50:10 +0100940 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
941 ssl, buf_len, msg_len));
Jerry Yu5cc35062022-01-28 16:16:08 +0800942cleanup:
943
Gilles Peskine449bd832023-01-11 14:50:10 +0100944 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
945 return ret;
Jerry Yu5cc35062022-01-28 16:16:08 +0800946}
947
Jerry Yu3e536442022-02-15 11:05:59 +0800948/*
949 * STATE HANDLING: Output Certificate Verify
950 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100951int mbedtls_ssl_tls13_check_sig_alg_cert_key_match(uint16_t sig_alg,
952 mbedtls_pk_context *key)
Jerry Yu0c6be8f2022-06-20 20:42:00 +0800953{
Dave Rodgman2eab4622023-10-05 13:30:37 +0100954 mbedtls_pk_type_t pk_type = (mbedtls_pk_type_t) mbedtls_ssl_sig_from_pk(key);
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 size_t key_size = mbedtls_pk_get_bitlen(key);
Jerry Yu0c6be8f2022-06-20 20:42:00 +0800956
Gilles Peskine449bd832023-01-11 14:50:10 +0100957 switch (pk_type) {
Jerry Yu67eced02022-02-25 13:37:36 +0800958 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100959 switch (key_size) {
Jerry Yu67eced02022-02-25 13:37:36 +0800960 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100961 return
962 sig_alg == MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256;
Jerry Yu0c6be8f2022-06-20 20:42:00 +0800963
Jerry Yu67eced02022-02-25 13:37:36 +0800964 case 384:
Gilles Peskine449bd832023-01-11 14:50:10 +0100965 return
966 sig_alg == MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384;
Jerry Yu0c6be8f2022-06-20 20:42:00 +0800967
Jerry Yu67eced02022-02-25 13:37:36 +0800968 case 521:
Gilles Peskine449bd832023-01-11 14:50:10 +0100969 return
970 sig_alg == MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512;
Jerry Yu67eced02022-02-25 13:37:36 +0800971 default:
Jerry Yu67eced02022-02-25 13:37:36 +0800972 break;
973 }
974 break;
Jerry Yu67eced02022-02-25 13:37:36 +0800975
Jerry Yu67eced02022-02-25 13:37:36 +0800976 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100977 switch (sig_alg) {
Ronald Cron38391bf2022-09-16 11:19:27 +0200978 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256: /* Intentional fallthrough */
979 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384: /* Intentional fallthrough */
Jerry Yu0c6be8f2022-06-20 20:42:00 +0800980 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +0100981 return 1;
Jerry Yuc2e04932022-06-27 22:13:03 +0800982
Jerry Yu0c6be8f2022-06-20 20:42:00 +0800983 default:
984 break;
Jerry Yucef3f332022-03-22 23:00:13 +0800985 }
Jerry Yu67eced02022-02-25 13:37:36 +0800986 break;
Jerry Yu0c6be8f2022-06-20 20:42:00 +0800987
Jerry Yu67eced02022-02-25 13:37:36 +0800988 default:
Jerry Yu67eced02022-02-25 13:37:36 +0800989 break;
990 }
Jerry Yu0c6be8f2022-06-20 20:42:00 +0800991
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 return 0;
Jerry Yu0c6be8f2022-06-20 20:42:00 +0800993}
994
Ronald Cronce7d76e2022-07-08 18:56:49 +0200995MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100996static int ssl_tls13_write_certificate_verify_body(mbedtls_ssl_context *ssl,
997 unsigned char *buf,
998 unsigned char *end,
999 size_t *out_len)
Jerry Yu8511f122022-01-29 10:01:04 +08001000{
Ronald Cron067a1e72022-09-16 13:44:49 +02001001 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3e536442022-02-15 11:05:59 +08001002 unsigned char *p = buf;
Jerry Yu8511f122022-01-29 10:01:04 +08001003 mbedtls_pk_context *own_key;
Jerry Yu3e536442022-02-15 11:05:59 +08001004
Gilles Peskine449bd832023-01-11 14:50:10 +01001005 unsigned char handshake_hash[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu8511f122022-01-29 10:01:04 +08001006 size_t handshake_hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 unsigned char verify_buffer[SSL_VERIFY_STRUCT_MAX_SIZE];
Jerry Yu3e536442022-02-15 11:05:59 +08001008 size_t verify_buffer_len;
Ronald Cron067a1e72022-09-16 13:44:49 +02001009
1010 uint16_t *sig_alg = ssl->handshake->received_sig_algs;
Jerry Yu3e536442022-02-15 11:05:59 +08001011 size_t signature_len = 0;
Jerry Yu8511f122022-01-29 10:01:04 +08001012
Jerry Yu0b7b1012022-02-23 12:23:05 +08001013 *out_len = 0;
1014
Gilles Peskine449bd832023-01-11 14:50:10 +01001015 own_key = mbedtls_ssl_own_key(ssl);
1016 if (own_key == NULL) {
1017 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1018 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu8511f122022-01-29 10:01:04 +08001019 }
1020
Xiaokang Qian73437382023-03-29 08:24:12 +00001021 ret = mbedtls_ssl_get_handshake_transcript(
Dave Rodgman2eab4622023-10-05 13:30:37 +01001022 ssl, (mbedtls_md_type_t) ssl->handshake->ciphersuite_info->mac,
Xiaokang Qian73437382023-03-29 08:24:12 +00001023 handshake_hash, sizeof(handshake_hash), &handshake_hash_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001024 if (ret != 0) {
1025 return ret;
1026 }
Jerry Yu8511f122022-01-29 10:01:04 +08001027
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 MBEDTLS_SSL_DEBUG_BUF(3, "handshake hash",
1029 handshake_hash,
1030 handshake_hash_len);
Jerry Yu8511f122022-01-29 10:01:04 +08001031
Gilles Peskine449bd832023-01-11 14:50:10 +01001032 ssl_tls13_create_verify_structure(handshake_hash, handshake_hash_len,
1033 verify_buffer, &verify_buffer_len,
1034 ssl->conf->endpoint);
Jerry Yu8511f122022-01-29 10:01:04 +08001035
1036 /*
1037 * struct {
1038 * SignatureScheme algorithm;
1039 * opaque signature<0..2^16-1>;
1040 * } CertificateVerify;
1041 */
Ronald Cron067a1e72022-09-16 13:44:49 +02001042 /* Check there is space for the algorithm identifier (2 bytes) and the
1043 * signature length (2 bytes).
1044 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001045 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4);
Ronald Cron067a1e72022-09-16 13:44:49 +02001046
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
Ronald Cron067a1e72022-09-16 13:44:49 +02001048 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1049 mbedtls_pk_type_t pk_type = MBEDTLS_PK_NONE;
1050 mbedtls_md_type_t md_alg = MBEDTLS_MD_NONE;
1051 psa_algorithm_t psa_algorithm = PSA_ALG_NONE;
1052 unsigned char verify_hash[PSA_HASH_MAX_SIZE];
1053 size_t verify_hash_len;
Jerry Yu67eced02022-02-25 13:37:36 +08001054
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 if (!mbedtls_ssl_sig_alg_is_offered(ssl, *sig_alg)) {
Ronald Cron067a1e72022-09-16 13:44:49 +02001056 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001057 }
Jerry Yu67eced02022-02-25 13:37:36 +08001058
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 if (!mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(*sig_alg)) {
Ronald Cron067a1e72022-09-16 13:44:49 +02001060 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 }
Ronald Cron067a1e72022-09-16 13:44:49 +02001062
Gilles Peskine449bd832023-01-11 14:50:10 +01001063 if (!mbedtls_ssl_tls13_check_sig_alg_cert_key_match(*sig_alg, own_key)) {
Ronald Cron067a1e72022-09-16 13:44:49 +02001064 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 }
Ronald Cron067a1e72022-09-16 13:44:49 +02001066
Gilles Peskine449bd832023-01-11 14:50:10 +01001067 if (mbedtls_ssl_get_pk_type_and_md_alg_from_sig_alg(
1068 *sig_alg, &pk_type, &md_alg) != 0) {
1069 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Ronald Cron067a1e72022-09-16 13:44:49 +02001070 }
1071
1072 /* Hash verify buffer with indicated hash function */
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02001073 psa_algorithm = mbedtls_md_psa_alg_from_type(md_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 status = psa_hash_compute(psa_algorithm,
1075 verify_buffer,
1076 verify_buffer_len,
1077 verify_hash, sizeof(verify_hash),
1078 &verify_hash_len);
1079 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001080 return PSA_TO_MBEDTLS_ERR(status);
Ronald Cron067a1e72022-09-16 13:44:49 +02001081 }
1082
Gilles Peskine449bd832023-01-11 14:50:10 +01001083 MBEDTLS_SSL_DEBUG_BUF(3, "verify hash", verify_hash, verify_hash_len);
1084
1085 if ((ret = mbedtls_pk_sign_ext(pk_type, own_key,
1086 md_alg, verify_hash, verify_hash_len,
1087 p + 4, (size_t) (end - (p + 4)), &signature_len,
1088 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
1089 MBEDTLS_SSL_DEBUG_MSG(2, ("CertificateVerify signature failed with %s",
1090 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
1091 MBEDTLS_SSL_DEBUG_RET(2, "mbedtls_pk_sign_ext", ret);
1092
1093 /* The signature failed. This is possible if the private key
1094 * was not suitable for the signature operation as purposely we
1095 * did not check its suitability completely. Let's try with
1096 * another signature algorithm.
1097 */
1098 continue;
1099 }
1100
1101 MBEDTLS_SSL_DEBUG_MSG(2, ("CertificateVerify signature with %s",
1102 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
Ronald Cron067a1e72022-09-16 13:44:49 +02001103
1104 break;
1105 }
1106
Gilles Peskine449bd832023-01-11 14:50:10 +01001107 if (*sig_alg == MBEDTLS_TLS1_3_SIG_NONE) {
1108 MBEDTLS_SSL_DEBUG_MSG(1, ("no suitable signature algorithm"));
1109 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1110 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1111 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu8511f122022-01-29 10:01:04 +08001112 }
1113
Gilles Peskine449bd832023-01-11 14:50:10 +01001114 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
1115 MBEDTLS_PUT_UINT16_BE(signature_len, p, 2);
Jerry Yuf3b46b52022-06-19 16:52:27 +08001116
Ronald Cron067a1e72022-09-16 13:44:49 +02001117 *out_len = 4 + signature_len;
Jerry Yu8c338862022-03-23 13:34:04 +08001118
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 return 0;
Jerry Yu8511f122022-01-29 10:01:04 +08001120}
Jerry Yu8511f122022-01-29 10:01:04 +08001121
Gilles Peskine449bd832023-01-11 14:50:10 +01001122int mbedtls_ssl_tls13_write_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu8511f122022-01-29 10:01:04 +08001123{
1124 int ret = 0;
Jerry Yuca133a32022-02-15 14:22:05 +08001125 unsigned char *buf;
1126 size_t buf_len, msg_len;
1127
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate verify"));
Jerry Yu8511f122022-01-29 10:01:04 +08001129
Xiaokang Qian73437382023-03-29 08:24:12 +00001130 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
1131 ssl, MBEDTLS_SSL_HS_CERTIFICATE_VERIFY,
1132 &buf, &buf_len));
Jerry Yu8511f122022-01-29 10:01:04 +08001133
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_verify_body(
1135 ssl, buf, buf + buf_len, &msg_len));
Jerry Yu8511f122022-01-29 10:01:04 +08001136
Xiaokang Qian73437382023-03-29 08:24:12 +00001137 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
1138 ssl, MBEDTLS_SSL_HS_CERTIFICATE_VERIFY,
1139 buf, msg_len));
Jerry Yu8511f122022-01-29 10:01:04 +08001140
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
1142 ssl, buf_len, msg_len));
Jerry Yu8511f122022-01-29 10:01:04 +08001143
1144cleanup:
1145
Gilles Peskine449bd832023-01-11 14:50:10 +01001146 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate verify"));
1147 return ret;
Jerry Yu8511f122022-01-29 10:01:04 +08001148}
1149
Ronald Cron928cbd32022-10-04 16:14:26 +02001150#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu90f152d2022-01-29 22:12:42 +08001151
Jerry Yu5cc35062022-01-28 16:16:08 +08001152/*
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001153 *
XiaokangQianc5c39d52021-11-09 11:55:10 +00001154 * STATE HANDLING: Incoming Finished message.
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001155 */
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001156/*
1157 * Implementation
1158 */
1159
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001160MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001161static int ssl_tls13_preprocess_finished_message(mbedtls_ssl_context *ssl)
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001162{
1163 int ret;
1164
Xiaokang Qian73437382023-03-29 08:24:12 +00001165 ret = mbedtls_ssl_tls13_calculate_verify_data(
1166 ssl,
1167 ssl->handshake->state_local.finished_in.digest,
1168 sizeof(ssl->handshake->state_local.finished_in.digest),
1169 &ssl->handshake->state_local.finished_in.digest_len,
1170 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT ?
1171 MBEDTLS_SSL_IS_SERVER : MBEDTLS_SSL_IS_CLIENT);
Gilles Peskine449bd832023-01-11 14:50:10 +01001172 if (ret != 0) {
1173 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_tls13_calculate_verify_data", ret);
1174 return ret;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001175 }
1176
Gilles Peskine449bd832023-01-11 14:50:10 +01001177 return 0;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001178}
1179
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001180MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001181static int ssl_tls13_parse_finished_message(mbedtls_ssl_context *ssl,
1182 const unsigned char *buf,
1183 const unsigned char *end)
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001184{
XiaokangQian33062842021-11-11 03:37:45 +00001185 /*
1186 * struct {
XiaokangQianc13f9352021-11-11 06:13:22 +00001187 * opaque verify_data[Hash.length];
XiaokangQian33062842021-11-11 03:37:45 +00001188 * } Finished;
1189 */
1190 const unsigned char *expected_verify_data =
1191 ssl->handshake->state_local.finished_in.digest;
1192 size_t expected_verify_data_len =
1193 ssl->handshake->state_local.finished_in.digest_len;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001194 /* Structural validation */
Gilles Peskine449bd832023-01-11 14:50:10 +01001195 if ((size_t) (end - buf) != expected_verify_data_len) {
1196 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001197
Gilles Peskine449bd832023-01-11 14:50:10 +01001198 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
1199 MBEDTLS_ERR_SSL_DECODE_ERROR);
1200 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001201 }
1202
Gilles Peskine449bd832023-01-11 14:50:10 +01001203 MBEDTLS_SSL_DEBUG_BUF(4, "verify_data (self-computed):",
1204 expected_verify_data,
1205 expected_verify_data_len);
1206 MBEDTLS_SSL_DEBUG_BUF(4, "verify_data (received message):", buf,
1207 expected_verify_data_len);
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001208
1209 /* Semantic validation */
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 if (mbedtls_ct_memcmp(buf,
1211 expected_verify_data,
1212 expected_verify_data_len) != 0) {
1213 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001214
Gilles Peskine449bd832023-01-11 14:50:10 +01001215 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
1216 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1217 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001218 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001219 return 0;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001220}
1221
Gilles Peskine449bd832023-01-11 14:50:10 +01001222int mbedtls_ssl_tls13_process_finished_message(mbedtls_ssl_context *ssl)
XiaokangQianc5c39d52021-11-09 11:55:10 +00001223{
XiaokangQian33062842021-11-11 03:37:45 +00001224 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianc5c39d52021-11-09 11:55:10 +00001225 unsigned char *buf;
Xiaofei Baieef15042021-11-18 07:29:56 +00001226 size_t buf_len;
XiaokangQianc5c39d52021-11-09 11:55:10 +00001227
Gilles Peskine449bd832023-01-11 14:50:10 +01001228 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished message"));
XiaokangQianc5c39d52021-11-09 11:55:10 +00001229
Xiaokang Qian73437382023-03-29 08:24:12 +00001230 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1231 ssl, MBEDTLS_SSL_HS_FINISHED, &buf, &buf_len));
Jerry Yu0a92d6c2022-05-16 16:54:46 +08001232
1233 /* Preprocessing step: Compute handshake digest */
Gilles Peskine449bd832023-01-11 14:50:10 +01001234 MBEDTLS_SSL_PROC_CHK(ssl_tls13_preprocess_finished_message(ssl));
Jerry Yu0a92d6c2022-05-16 16:54:46 +08001235
Xiaokang Qian73437382023-03-29 08:24:12 +00001236 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_finished_message(
1237 ssl, buf, buf + buf_len));
Jerry Yu0a92d6c2022-05-16 16:54:46 +08001238
Xiaokang Qian73437382023-03-29 08:24:12 +00001239 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
1240 ssl, MBEDTLS_SSL_HS_FINISHED, buf, buf_len));
XiaokangQianc5c39d52021-11-09 11:55:10 +00001241
1242cleanup:
1243
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished message"));
1245 return ret;
XiaokangQianc5c39d52021-11-09 11:55:10 +00001246}
1247
XiaokangQian74af2a82021-09-22 07:40:30 +00001248/*
1249 *
XiaokangQiancc90c942021-11-09 12:30:09 +00001250 * STATE HANDLING: Write and send Finished message.
XiaokangQian74af2a82021-09-22 07:40:30 +00001251 *
1252 */
XiaokangQian74af2a82021-09-22 07:40:30 +00001253/*
XiaokangQian35dc6252021-11-11 08:16:19 +00001254 * Implement
XiaokangQian74af2a82021-09-22 07:40:30 +00001255 */
1256
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001257MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001258static int ssl_tls13_prepare_finished_message(mbedtls_ssl_context *ssl)
XiaokangQian74af2a82021-09-22 07:40:30 +00001259{
1260 int ret;
1261
1262 /* Compute transcript of handshake up to now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001263 ret = mbedtls_ssl_tls13_calculate_verify_data(ssl,
1264 ssl->handshake->state_local.finished_out.digest,
1265 sizeof(ssl->handshake->state_local.finished_out.
1266 digest),
1267 &ssl->handshake->state_local.finished_out.digest_len,
1268 ssl->conf->endpoint);
XiaokangQian74af2a82021-09-22 07:40:30 +00001269
Gilles Peskine449bd832023-01-11 14:50:10 +01001270 if (ret != 0) {
1271 MBEDTLS_SSL_DEBUG_RET(1, "calculate_verify_data failed", ret);
1272 return ret;
XiaokangQian74af2a82021-09-22 07:40:30 +00001273 }
1274
Gilles Peskine449bd832023-01-11 14:50:10 +01001275 return 0;
XiaokangQian74af2a82021-09-22 07:40:30 +00001276}
1277
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001278MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001279static int ssl_tls13_write_finished_message_body(mbedtls_ssl_context *ssl,
1280 unsigned char *buf,
1281 unsigned char *end,
1282 size_t *out_len)
XiaokangQian74af2a82021-09-22 07:40:30 +00001283{
XiaokangQian8773aa02021-11-10 07:33:09 +00001284 size_t verify_data_len = ssl->handshake->state_local.finished_out.digest_len;
XiaokangQian0fa66432021-11-15 03:33:57 +00001285 /*
1286 * struct {
1287 * opaque verify_data[Hash.length];
1288 * } Finished;
1289 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, verify_data_len);
XiaokangQian74af2a82021-09-22 07:40:30 +00001291
Gilles Peskine449bd832023-01-11 14:50:10 +01001292 memcpy(buf, ssl->handshake->state_local.finished_out.digest,
1293 verify_data_len);
XiaokangQian74af2a82021-09-22 07:40:30 +00001294
Xiaofei Baid25fab62021-12-02 06:36:27 +00001295 *out_len = verify_data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001296 return 0;
XiaokangQian74af2a82021-09-22 07:40:30 +00001297}
XiaokangQianc5c39d52021-11-09 11:55:10 +00001298
XiaokangQian35dc6252021-11-11 08:16:19 +00001299/* Main entry point: orchestrates the other functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01001300int mbedtls_ssl_tls13_write_finished_message(mbedtls_ssl_context *ssl)
XiaokangQian35dc6252021-11-11 08:16:19 +00001301{
1302 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1303 unsigned char *buf;
1304 size_t buf_len, msg_len;
1305
Gilles Peskine449bd832023-01-11 14:50:10 +01001306 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished message"));
XiaokangQian35dc6252021-11-11 08:16:19 +00001307
Gilles Peskine449bd832023-01-11 14:50:10 +01001308 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_finished_message(ssl));
XiaokangQiandce82242021-11-15 06:01:26 +00001309
Gilles Peskine449bd832023-01-11 14:50:10 +01001310 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
1311 MBEDTLS_SSL_HS_FINISHED, &buf, &buf_len));
XiaokangQian35dc6252021-11-11 08:16:19 +00001312
Gilles Peskine449bd832023-01-11 14:50:10 +01001313 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_finished_message_body(
1314 ssl, buf, buf + buf_len, &msg_len));
XiaokangQian35dc6252021-11-11 08:16:19 +00001315
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001316 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01001317 MBEDTLS_SSL_HS_FINISHED, buf, msg_len));
XiaokangQian35dc6252021-11-11 08:16:19 +00001318
Gilles Peskine449bd832023-01-11 14:50:10 +01001319 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
1320 ssl, buf_len, msg_len));
XiaokangQian35dc6252021-11-11 08:16:19 +00001321cleanup:
1322
Gilles Peskine449bd832023-01-11 14:50:10 +01001323 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished message"));
1324 return ret;
XiaokangQian35dc6252021-11-11 08:16:19 +00001325}
1326
Gilles Peskine449bd832023-01-11 14:50:10 +01001327void mbedtls_ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu378254d2021-10-30 21:44:47 +08001328{
1329
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu378254d2021-10-30 21:44:47 +08001331
Gilles Peskine449bd832023-01-11 14:50:10 +01001332 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to application keys for inbound traffic"));
1333 mbedtls_ssl_set_inbound_transform(ssl, ssl->transform_application);
Jerry Yue8c1fca2022-05-18 14:48:56 +08001334
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to application keys for outbound traffic"));
1336 mbedtls_ssl_set_outbound_transform(ssl, ssl->transform_application);
Jerry Yue8c1fca2022-05-18 14:48:56 +08001337
Jerry Yu378254d2021-10-30 21:44:47 +08001338 /*
Jerry Yucfe64f02021-11-15 13:54:06 +08001339 * Free the previous session and switch to the current one.
Jerry Yu378254d2021-10-30 21:44:47 +08001340 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001341 if (ssl->session) {
1342 mbedtls_ssl_session_free(ssl->session);
1343 mbedtls_free(ssl->session);
Jerry Yu378254d2021-10-30 21:44:47 +08001344 }
1345 ssl->session = ssl->session_negotiate;
1346 ssl->session_negotiate = NULL;
1347
Gilles Peskine449bd832023-01-11 14:50:10 +01001348 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu378254d2021-10-30 21:44:47 +08001349}
1350
Ronald Cron49ad6192021-11-24 16:25:31 +01001351/*
1352 *
1353 * STATE HANDLING: Write ChangeCipherSpec
1354 *
1355 */
1356#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001357MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001358static int ssl_tls13_write_change_cipher_spec_body(mbedtls_ssl_context *ssl,
1359 unsigned char *buf,
1360 unsigned char *end,
1361 size_t *olen)
Ronald Cron49ad6192021-11-24 16:25:31 +01001362{
1363 ((void) ssl);
1364
Gilles Peskine449bd832023-01-11 14:50:10 +01001365 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 1);
Ronald Cron49ad6192021-11-24 16:25:31 +01001366 buf[0] = 1;
1367 *olen = 1;
1368
Gilles Peskine449bd832023-01-11 14:50:10 +01001369 return 0;
Ronald Cron49ad6192021-11-24 16:25:31 +01001370}
1371
Gilles Peskine449bd832023-01-11 14:50:10 +01001372int mbedtls_ssl_tls13_write_change_cipher_spec(mbedtls_ssl_context *ssl)
Ronald Cron49ad6192021-11-24 16:25:31 +01001373{
1374 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1375
Gilles Peskine449bd832023-01-11 14:50:10 +01001376 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write change cipher spec"));
Ronald Cron49ad6192021-11-24 16:25:31 +01001377
Ronald Crone273f722024-02-13 18:22:26 +01001378 /* Only one CCS to send. */
Ronald Cron5fbd2702024-02-14 10:03:36 +01001379 if (ssl->handshake->ccs_sent) {
Ronald Crone273f722024-02-13 18:22:26 +01001380 ret = 0;
1381 goto cleanup;
1382 }
1383
Ronald Cron49ad6192021-11-24 16:25:31 +01001384 /* Write CCS message */
Gilles Peskine449bd832023-01-11 14:50:10 +01001385 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_change_cipher_spec_body(
1386 ssl, ssl->out_msg,
1387 ssl->out_msg + MBEDTLS_SSL_OUT_CONTENT_LEN,
1388 &ssl->out_msglen));
Ronald Cron49ad6192021-11-24 16:25:31 +01001389
1390 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
1391
Ronald Cron49ad6192021-11-24 16:25:31 +01001392 /* Dispatch message */
Gilles Peskine449bd832023-01-11 14:50:10 +01001393 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_write_record(ssl, 0));
Ronald Cron49ad6192021-11-24 16:25:31 +01001394
Ronald Cron5fbd2702024-02-14 10:03:36 +01001395 ssl->handshake->ccs_sent = 1;
Ronald Cronfe59ff72024-01-24 14:31:50 +01001396
Ronald Cron49ad6192021-11-24 16:25:31 +01001397cleanup:
1398
Gilles Peskine449bd832023-01-11 14:50:10 +01001399 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write change cipher spec"));
1400 return ret;
Ronald Cron49ad6192021-11-24 16:25:31 +01001401}
1402
1403#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
1404
Xiaokang Qianecc29482022-11-02 07:52:47 +00001405/* Early Data Indication Extension
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001406 *
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001407 * struct {
1408 * select ( Handshake.msg_type ) {
Jerry Yu52335392023-11-23 18:06:06 +08001409 * case new_session_ticket: uint32 max_early_data_size;
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001410 * case client_hello: Empty;
1411 * case encrypted_extensions: Empty;
1412 * };
1413 * } EarlyDataIndication;
1414 */
1415#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001416int mbedtls_ssl_tls13_write_early_data_ext(mbedtls_ssl_context *ssl,
Jerry Yuc59c5862023-12-05 10:40:49 +08001417 int in_new_session_ticket,
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 unsigned char *buf,
1419 const unsigned char *end,
Jerry Yuc59c5862023-12-05 10:40:49 +08001420 size_t *out_len)
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001421{
1422 unsigned char *p = buf;
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001423
Jerry Yu52335392023-11-23 18:06:06 +08001424#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yuc59c5862023-12-05 10:40:49 +08001425 const size_t needed = in_new_session_ticket ? 8 : 4;
Jerry Yu52335392023-11-23 18:06:06 +08001426#else
1427 const size_t needed = 4;
Jerry Yuc59c5862023-12-05 10:40:49 +08001428 ((void) in_new_session_ticket);
Jerry Yu52335392023-11-23 18:06:06 +08001429#endif
1430
1431 *out_len = 0;
1432
1433 MBEDTLS_SSL_CHK_BUF_PTR(p, end, needed);
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001434
Gilles Peskine449bd832023-01-11 14:50:10 +01001435 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_EARLY_DATA, p, 0);
Jerry Yu52335392023-11-23 18:06:06 +08001436 MBEDTLS_PUT_UINT16_BE(needed - 4, p, 2);
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001437
Jerry Yu52335392023-11-23 18:06:06 +08001438#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yuc59c5862023-12-05 10:40:49 +08001439 if (in_new_session_ticket) {
1440 MBEDTLS_PUT_UINT32_BE(ssl->conf->max_early_data_size, p, 4);
Jerry Yu52335392023-11-23 18:06:06 +08001441 MBEDTLS_SSL_DEBUG_MSG(
1442 4, ("Sent max_early_data_size=%u",
Jerry Yuc59c5862023-12-05 10:40:49 +08001443 (unsigned int) ssl->conf->max_early_data_size));
Jerry Yu52335392023-11-23 18:06:06 +08001444 }
1445#endif
1446
1447 *out_len = needed;
Xiaokang Qian2cd5ce02022-11-15 10:33:53 +00001448
Gilles Peskine449bd832023-01-11 14:50:10 +01001449 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_EARLY_DATA);
Xiaokang Qian2cd5ce02022-11-15 10:33:53 +00001450
Gilles Peskine449bd832023-01-11 14:50:10 +01001451 return 0;
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001452}
Ronald Cron85718042024-02-22 10:22:09 +01001453
1454#if defined(MBEDTLS_SSL_SRV_C)
1455int mbedtls_ssl_tls13_check_early_data_len(mbedtls_ssl_context *ssl,
1456 size_t early_data_len)
1457{
Ronald Cron85718042024-02-22 10:22:09 +01001458 /*
1459 * This function should be called only while an handshake is in progress
1460 * and thus a session under negotiation. Add a sanity check to detect a
1461 * misuse.
1462 */
1463 if (ssl->session_negotiate == NULL) {
1464 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1465 }
1466
1467 /* RFC 8446 section 4.6.1
1468 *
1469 * A server receiving more than max_early_data_size bytes of 0-RTT data
1470 * SHOULD terminate the connection with an "unexpected_message" alert.
Ronald Cron93795f22024-03-07 09:24:56 +01001471 * Note that if it is still possible to send early_data_len bytes of early
1472 * data, it means that early_data_len is smaller than max_early_data_size
1473 * (type uint32_t) and can fit in an uint32_t. We use this further
1474 * down.
Ronald Cron85718042024-02-22 10:22:09 +01001475 */
Ronald Cron2e7dfd52024-03-05 10:54:33 +01001476 if (early_data_len >
Ronald Cron85718042024-02-22 10:22:09 +01001477 (ssl->session_negotiate->max_early_data_size -
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001478 ssl->total_early_data_size)) {
Ronald Cron85718042024-02-22 10:22:09 +01001479
1480 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskineeeb4ff52024-06-03 22:16:23 +02001481 2, ("EarlyData: Too much early data received, "
Gilles Peskine400659b2024-06-04 08:45:58 +02001482 "%lu + %" MBEDTLS_PRINTF_SIZET " > %lu",
1483 (unsigned long) ssl->total_early_data_size,
Gilles Peskineeeb4ff52024-06-03 22:16:23 +02001484 early_data_len,
Gilles Peskine400659b2024-06-04 08:45:58 +02001485 (unsigned long) ssl->session_negotiate->max_early_data_size));
Ronald Cron85718042024-02-22 10:22:09 +01001486
1487 MBEDTLS_SSL_PEND_FATAL_ALERT(
1488 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1489 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE);
1490 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
1491 }
1492
Ronald Cron2e7dfd52024-03-05 10:54:33 +01001493 /*
Ronald Cron93795f22024-03-07 09:24:56 +01001494 * early_data_len has been checked to be less than max_early_data_size
1495 * that is uint32_t. Its cast to an uint32_t below is thus safe. We need
1496 * the cast to appease some compilers.
Ronald Cron2e7dfd52024-03-05 10:54:33 +01001497 */
Ronald Cron2e7dfd52024-03-05 10:54:33 +01001498 ssl->total_early_data_size += (uint32_t) early_data_len;
Ronald Cron85718042024-02-22 10:22:09 +01001499
1500 return 0;
1501}
1502#endif /* MBEDTLS_SSL_SRV_C */
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001503#endif /* MBEDTLS_SSL_EARLY_DATA */
1504
XiaokangQian78b1fa72022-01-19 06:56:30 +00001505/* Reset SSL context and update hash for handling HRR.
1506 *
1507 * Replace Transcript-Hash(X) by
1508 * Transcript-Hash( message_hash ||
1509 * 00 00 Hash.length ||
1510 * X )
1511 * A few states of the handshake are preserved, including:
1512 * - session ID
1513 * - session ticket
1514 * - negotiated ciphersuite
1515 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001516int mbedtls_ssl_reset_transcript_for_hrr(mbedtls_ssl_context *ssl)
XiaokangQian78b1fa72022-01-19 06:56:30 +00001517{
1518 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielda645252022-09-14 12:50:51 +02001519 unsigned char hash_transcript[PSA_HASH_MAX_SIZE + 4];
XiaokangQian0ece9982022-01-24 08:56:23 +00001520 size_t hash_len;
Xiaokang Qian6b980012023-02-07 03:17:45 +00001521 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
1522 ssl->handshake->ciphersuite_info;
XiaokangQian78b1fa72022-01-19 06:56:30 +00001523
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 MBEDTLS_SSL_DEBUG_MSG(3, ("Reset SSL session for HRR"));
XiaokangQian78b1fa72022-01-19 06:56:30 +00001525
Dave Rodgman2eab4622023-10-05 13:30:37 +01001526 ret = mbedtls_ssl_get_handshake_transcript(ssl, (mbedtls_md_type_t) ciphersuite_info->mac,
Gilles Peskine449bd832023-01-11 14:50:10 +01001527 hash_transcript + 4,
1528 PSA_HASH_MAX_SIZE,
1529 &hash_len);
1530 if (ret != 0) {
Manuel Pégourié-Gonnardda7979b2023-02-21 09:31:10 +01001531 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_get_handshake_transcript", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01001532 return ret;
XiaokangQian0ece9982022-01-24 08:56:23 +00001533 }
1534
1535 hash_transcript[0] = MBEDTLS_SSL_HS_MESSAGE_HASH;
1536 hash_transcript[1] = 0;
1537 hash_transcript[2] = 0;
1538 hash_transcript[3] = (unsigned char) hash_len;
1539
1540 hash_len += 4;
1541
Manuel Pégourié-Gonnardda7979b2023-02-21 09:31:10 +01001542 MBEDTLS_SSL_DEBUG_BUF(4, "Truncated handshake transcript",
1543 hash_transcript, hash_len);
1544
Manuel Pégourié-Gonnardd7a7a232023-02-05 10:26:49 +01001545 /* Reset running hash and replace it with a hash of the transcript */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001546 ret = mbedtls_ssl_reset_checksum(ssl);
1547 if (ret != 0) {
1548 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1549 return ret;
1550 }
1551 ret = ssl->handshake->update_checksum(ssl, hash_transcript, hash_len);
1552 if (ret != 0) {
1553 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
1554 return ret;
1555 }
Przemyslaw Stekiel4b3fff42022-02-14 16:39:52 +01001556
Gilles Peskine449bd832023-01-11 14:50:10 +01001557 return ret;
XiaokangQian78b1fa72022-01-19 06:56:30 +00001558}
1559
Valerio Settic9ae8622023-07-25 11:23:50 +02001560#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001561
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02001562int mbedtls_ssl_tls13_read_public_xxdhe_share(mbedtls_ssl_context *ssl,
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 const unsigned char *buf,
1564 size_t buf_len)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001565{
Gilles Peskine449bd832023-01-11 14:50:10 +01001566 uint8_t *p = (uint8_t *) buf;
XiaokangQiancfd925f2022-04-14 07:10:37 +00001567 const uint8_t *end = buf + buf_len;
XiaokangQian9b5d04b2022-04-10 10:20:43 +00001568 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001569
XiaokangQian9b5d04b2022-04-10 10:20:43 +00001570 /* Get size of the TLS opaque key_exchange field of the KeyShareEntry struct. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001571 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1572 uint16_t peerkey_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian9b5d04b2022-04-10 10:20:43 +00001573 p += 2;
XiaokangQian3207a322022-02-23 03:15:27 +00001574
XiaokangQian9b5d04b2022-04-10 10:20:43 +00001575 /* Check if key size is consistent with given buffer length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001576 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, peerkey_len);
XiaokangQian9b5d04b2022-04-10 10:20:43 +00001577
Gilles Peskine12c5aaa2023-10-02 14:55:45 +02001578 /* Store peer's ECDH/FFDH public key. */
1579 if (peerkey_len > sizeof(handshake->xxdh_psa_peerkey)) {
Gilles Peskine530c4232023-10-02 15:37:23 +02001580 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid public key length: %u > %" MBEDTLS_PRINTF_SIZET,
1581 (unsigned) peerkey_len,
1582 sizeof(handshake->xxdh_psa_peerkey)));
Gilles Peskine12c5aaa2023-10-02 14:55:45 +02001583 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1584 }
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02001585 memcpy(handshake->xxdh_psa_peerkey, p, peerkey_len);
1586 handshake->xxdh_psa_peerkey_len = peerkey_len;
XiaokangQian9b5d04b2022-04-10 10:20:43 +00001587
Gilles Peskine449bd832023-01-11 14:50:10 +01001588 return 0;
XiaokangQian3207a322022-02-23 03:15:27 +00001589}
Jerry Yu89e103c2022-03-30 22:43:29 +08001590
Valerio Setti711f8532023-07-31 11:28:07 +02001591#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekielda4fba62023-06-02 14:52:28 +02001592static psa_status_t mbedtls_ssl_get_psa_ffdh_info_from_tls_id(
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +02001593 uint16_t tls_id, size_t *bits, psa_key_type_t *key_type)
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001594{
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +02001595 switch (tls_id) {
Valerio Settiecaf7c52024-01-17 12:30:30 +01001596#if defined(PSA_WANT_DH_RFC7919_2048)
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001597 case MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048:
1598 *bits = 2048;
1599 *key_type = PSA_KEY_TYPE_DH_KEY_PAIR(PSA_DH_FAMILY_RFC7919);
1600 return PSA_SUCCESS;
Valerio Settiecaf7c52024-01-17 12:30:30 +01001601#endif /* PSA_WANT_DH_RFC7919_2048 */
1602#if defined(PSA_WANT_DH_RFC7919_3072)
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001603 case MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072:
1604 *bits = 3072;
1605 *key_type = PSA_KEY_TYPE_DH_KEY_PAIR(PSA_DH_FAMILY_RFC7919);
1606 return PSA_SUCCESS;
Valerio Settiecaf7c52024-01-17 12:30:30 +01001607#endif /* PSA_WANT_DH_RFC7919_3072 */
1608#if defined(PSA_WANT_DH_RFC7919_4096)
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001609 case MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096:
1610 *bits = 4096;
1611 *key_type = PSA_KEY_TYPE_DH_KEY_PAIR(PSA_DH_FAMILY_RFC7919);
1612 return PSA_SUCCESS;
Valerio Settiecaf7c52024-01-17 12:30:30 +01001613#endif /* PSA_WANT_DH_RFC7919_4096 */
1614#if defined(PSA_WANT_DH_RFC7919_6144)
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001615 case MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144:
1616 *bits = 6144;
1617 *key_type = PSA_KEY_TYPE_DH_KEY_PAIR(PSA_DH_FAMILY_RFC7919);
1618 return PSA_SUCCESS;
Valerio Settiecaf7c52024-01-17 12:30:30 +01001619#endif /* PSA_WANT_DH_RFC7919_6144 */
1620#if defined(PSA_WANT_DH_RFC7919_8192)
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001621 case MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192:
1622 *bits = 8192;
1623 *key_type = PSA_KEY_TYPE_DH_KEY_PAIR(PSA_DH_FAMILY_RFC7919);
1624 return PSA_SUCCESS;
Valerio Settiecaf7c52024-01-17 12:30:30 +01001625#endif /* PSA_WANT_DH_RFC7919_8192 */
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001626 default:
1627 return PSA_ERROR_NOT_SUPPORTED;
1628 }
1629}
Valerio Setti711f8532023-07-31 11:28:07 +02001630#endif /* PSA_WANT_ALG_FFDH */
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001631
Przemek Stekiel408569f2023-07-06 11:26:44 +02001632int mbedtls_ssl_tls13_generate_and_write_xxdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01001633 mbedtls_ssl_context *ssl,
1634 uint16_t named_group,
1635 unsigned char *buf,
1636 unsigned char *end,
1637 size_t *out_len)
Jerry Yu89e103c2022-03-30 22:43:29 +08001638{
1639 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
1640 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1641 psa_key_attributes_t key_attributes;
1642 size_t own_pubkey_len;
1643 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001644 size_t bits = 0;
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +02001645 psa_key_type_t key_type = PSA_KEY_TYPE_NONE;
1646 psa_algorithm_t alg = PSA_ALG_NONE;
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001647 size_t buf_size = (size_t) (end - buf);
Jerry Yu89e103c2022-03-30 22:43:29 +08001648
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001649 MBEDTLS_SSL_DEBUG_MSG(1, ("Perform PSA-based ECDH/FFDH computation."));
Jerry Yu89e103c2022-03-30 22:43:29 +08001650
Valerio Setti40d9ca92023-01-04 16:08:04 +01001651 /* Convert EC's TLS ID to PSA key type. */
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001652#if defined(PSA_WANT_ALG_ECDH)
Xiaokang Qian73437382023-03-29 08:24:12 +00001653 if (mbedtls_ssl_get_psa_curve_info_from_tls_id(
Przemek Stekielda4fba62023-06-02 14:52:28 +02001654 named_group, &key_type, &bits) == PSA_SUCCESS) {
1655 alg = PSA_ALG_ECDH;
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001656 }
1657#endif
1658#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +02001659 if (mbedtls_ssl_get_psa_ffdh_info_from_tls_id(named_group, &bits,
1660 &key_type) == PSA_SUCCESS) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02001661 alg = PSA_ALG_FFDH;
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001662 }
1663#endif
1664
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +02001665 if (key_type == PSA_KEY_TYPE_NONE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001666 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Valerio Setti40d9ca92023-01-04 16:08:04 +01001667 }
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001668
Przemek Stekielda4fba62023-06-02 14:52:28 +02001669 if (buf_size < PSA_BITS_TO_BYTES(bits)) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02001670 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1671 }
1672
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02001673 handshake->xxdh_psa_type = key_type;
Valerio Settiea59c432023-07-25 11:14:03 +02001674 ssl->handshake->xxdh_psa_bits = bits;
Jerry Yu89e103c2022-03-30 22:43:29 +08001675
1676 key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01001677 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Przemek Stekielda4fba62023-06-02 14:52:28 +02001678 psa_set_key_algorithm(&key_attributes, alg);
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02001679 psa_set_key_type(&key_attributes, handshake->xxdh_psa_type);
Valerio Settiea59c432023-07-25 11:14:03 +02001680 psa_set_key_bits(&key_attributes, handshake->xxdh_psa_bits);
Jerry Yu89e103c2022-03-30 22:43:29 +08001681
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001682 /* Generate ECDH/FFDH private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001683 status = psa_generate_key(&key_attributes,
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02001684 &handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01001685 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001686 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001687 MBEDTLS_SSL_DEBUG_RET(1, "psa_generate_key", ret);
1688 return ret;
Jerry Yu89e103c2022-03-30 22:43:29 +08001689
1690 }
1691
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001692 /* Export the public part of the ECDH/FFDH private key from PSA. */
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02001693 status = psa_export_public_key(handshake->xxdh_psa_privkey,
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001694 buf, buf_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001695 &own_pubkey_len);
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001696
Gilles Peskine449bd832023-01-11 14:50:10 +01001697 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001698 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001699 MBEDTLS_SSL_DEBUG_RET(1, "psa_export_public_key", ret);
1700 return ret;
Jerry Yu89e103c2022-03-30 22:43:29 +08001701 }
1702
1703 *out_len = own_pubkey_len;
1704
Gilles Peskine449bd832023-01-11 14:50:10 +01001705 return 0;
Jerry Yu89e103c2022-03-30 22:43:29 +08001706}
Valerio Settic9ae8622023-07-25 11:23:50 +02001707#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001708
Jerry Yu0c354a22022-08-29 15:25:36 +08001709/* RFC 8446 section 4.2
1710 *
1711 * If an implementation receives an extension which it recognizes and which is
1712 * not specified for the message in which it appears, it MUST abort the handshake
1713 * with an "illegal_parameter" alert.
1714 *
1715 */
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001716int mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001717 mbedtls_ssl_context *ssl,
1718 int hs_msg_type,
1719 unsigned int received_extension_type,
1720 uint32_t hs_msg_allowed_extensions_mask)
Jerry Yu0c354a22022-08-29 15:25:36 +08001721{
Jerry Yudf0ad652022-10-31 13:20:57 +08001722 uint32_t extension_mask = mbedtls_ssl_get_extension_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001723 received_extension_type);
Jerry Yu0c354a22022-08-29 15:25:36 +08001724
Jerry Yu79aa7212022-11-08 21:30:21 +08001725 MBEDTLS_SSL_PRINT_EXT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001726 3, hs_msg_type, received_extension_type, "received");
Jerry Yu0c354a22022-08-29 15:25:36 +08001727
Gilles Peskine449bd832023-01-11 14:50:10 +01001728 if ((extension_mask & hs_msg_allowed_extensions_mask) == 0) {
Jerry Yu79aa7212022-11-08 21:30:21 +08001729 MBEDTLS_SSL_PRINT_EXT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 3, hs_msg_type, received_extension_type, "is illegal");
Jerry Yu0c354a22022-08-29 15:25:36 +08001731 MBEDTLS_SSL_PEND_FATAL_ALERT(
1732 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001733 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1734 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu0c354a22022-08-29 15:25:36 +08001735 }
1736
1737 ssl->handshake->received_extensions |= extension_mask;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001738 /*
1739 * If it is a message containing extension responses, check that we
1740 * previously sent the extension.
1741 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001742 switch (hs_msg_type) {
Jerry Yu0c354a22022-08-29 15:25:36 +08001743 case MBEDTLS_SSL_HS_SERVER_HELLO:
Jerry Yudf0ad652022-10-31 13:20:57 +08001744 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Jerry Yu0c354a22022-08-29 15:25:36 +08001745 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
1746 case MBEDTLS_SSL_HS_CERTIFICATE:
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001747 /* Check if the received extension is sent by peer message.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 if ((ssl->handshake->sent_extensions & extension_mask) != 0) {
1749 return 0;
1750 }
Jerry Yu0c354a22022-08-29 15:25:36 +08001751 break;
1752 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001753 return 0;
Jerry Yu0c354a22022-08-29 15:25:36 +08001754 }
1755
Jerry Yu79aa7212022-11-08 21:30:21 +08001756 MBEDTLS_SSL_PRINT_EXT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001757 3, hs_msg_type, received_extension_type, "is unsupported");
Jerry Yu0c354a22022-08-29 15:25:36 +08001758 MBEDTLS_SSL_PEND_FATAL_ALERT(
1759 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION);
1761 return MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
Jerry Yu0c354a22022-08-29 15:25:36 +08001762}
1763
Jan Bruckner151f6422023-02-10 12:45:19 +01001764#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Yanray Wangfaf70bd2023-12-07 10:03:32 +08001765
1766/* RFC 8449, section 4:
1767 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001768 * The ExtensionData of the "record_size_limit" extension is
1769 * RecordSizeLimit:
1770 * uint16 RecordSizeLimit;
1771 */
1772MBEDTLS_CHECK_RETURN_CRITICAL
1773int mbedtls_ssl_tls13_parse_record_size_limit_ext(mbedtls_ssl_context *ssl,
1774 const unsigned char *buf,
1775 const unsigned char *end)
1776{
Jan Bruckner1a38e542023-03-15 14:15:11 +01001777 const unsigned char *p = buf;
1778 uint16_t record_size_limit;
Jan Brucknera0589e72023-03-15 11:04:45 +01001779 const size_t extension_data_len = end - buf;
Jan Bruckner1a38e542023-03-15 14:15:11 +01001780
Xiaokang Qian73437382023-03-29 08:24:12 +00001781 if (extension_data_len !=
1782 MBEDTLS_SSL_RECORD_SIZE_LIMIT_EXTENSION_DATA_LENGTH) {
Jan Bruckner151f6422023-02-10 12:45:19 +01001783 MBEDTLS_SSL_DEBUG_MSG(2,
Jan Bruckner1a38e542023-03-15 14:15:11 +01001784 ("record_size_limit extension has invalid length: %"
1785 MBEDTLS_PRINTF_SIZET " Bytes",
Jan Bruckner151f6422023-02-10 12:45:19 +01001786 extension_data_len));
1787
1788 MBEDTLS_SSL_PEND_FATAL_ALERT(
1789 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1790 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1791 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1792 }
1793
Jan Bruckner151f6422023-02-10 12:45:19 +01001794 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1795 record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
1796
1797 MBEDTLS_SSL_DEBUG_MSG(2, ("RecordSizeLimit: %u Bytes", record_size_limit));
1798
Waleed Elmelegye1ac98d2024-01-05 18:10:12 +00001799 /* RFC 8449, section 4:
1800 *
1801 * Endpoints MUST NOT send a "record_size_limit" extension with a value
1802 * smaller than 64. An endpoint MUST treat receipt of a smaller value
1803 * as a fatal error and generate an "illegal_parameter" alert.
1804 */
1805 if (record_size_limit < MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN) {
1806 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid record size limit : %u Bytes",
1807 record_size_limit));
1808 MBEDTLS_SSL_PEND_FATAL_ALERT(
1809 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1810 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1811 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jan Bruckner151f6422023-02-10 12:45:19 +01001812 }
1813
Jan Brucknerf482dcc2023-03-15 09:09:06 +01001814 ssl->session_negotiate->record_size_limit = record_size_limit;
Jan Bruckner151f6422023-02-10 12:45:19 +01001815
Jan Brucknerf482dcc2023-03-15 09:09:06 +01001816 return 0;
Jan Bruckner151f6422023-02-10 12:45:19 +01001817}
Jan Brucknerf482dcc2023-03-15 09:09:06 +01001818
Yanray Wangfaf70bd2023-12-07 10:03:32 +08001819MBEDTLS_CHECK_RETURN_CRITICAL
1820int mbedtls_ssl_tls13_write_record_size_limit_ext(mbedtls_ssl_context *ssl,
Yanray Wangfaf70bd2023-12-07 10:03:32 +08001821 unsigned char *buf,
1822 const unsigned char *end,
1823 size_t *out_len)
1824{
Yanray Wangfaf70bd2023-12-07 10:03:32 +08001825 unsigned char *p = buf;
1826 *out_len = 0;
1827
Waleed Elmelegy148dfb62024-01-04 18:02:35 +00001828 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_IN_CONTENT_LEN >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN,
Waleed Elmelegye1ac98d2024-01-05 18:10:12 +00001829 "MBEDTLS_SSL_IN_CONTENT_LEN is less than the "
1830 "minimum record size limit");
Yanray Wangfaf70bd2023-12-07 10:03:32 +08001831
1832 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
1833
1834 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT, p, 0);
Waleed Elmelegye1ac98d2024-01-05 18:10:12 +00001835 MBEDTLS_PUT_UINT16_BE(MBEDTLS_SSL_RECORD_SIZE_LIMIT_EXTENSION_DATA_LENGTH,
1836 p, 2);
Waleed Elmelegy148dfb62024-01-04 18:02:35 +00001837 MBEDTLS_PUT_UINT16_BE(MBEDTLS_SSL_IN_CONTENT_LEN, p, 4);
Yanray Wangfaf70bd2023-12-07 10:03:32 +08001838
1839 *out_len = 6;
1840
Waleed Elmelegy3ff47242024-01-10 16:15:52 +00001841 MBEDTLS_SSL_DEBUG_MSG(2, ("Sent RecordSizeLimit: %d Bytes",
Waleed Elmelegye1ac98d2024-01-05 18:10:12 +00001842 MBEDTLS_SSL_IN_CONTENT_LEN));
Yanray Wangfaf70bd2023-12-07 10:03:32 +08001843
1844 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT);
1845
1846 return 0;
1847}
1848
Jan Bruckner151f6422023-02-10 12:45:19 +01001849#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
1850
Jerry Yufb4b6472022-01-27 15:03:26 +08001851#endif /* MBEDTLS_SSL_TLS_C && MBEDTLS_SSL_PROTO_TLS1_3 */