blob: c130de0a84b527750efd66e005e77cedb450ff69 [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;
Ronald Croncb7f6322024-04-03 09:07:22 +0200632 int have_ca_chain = 0;
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
Manuel Pégourié-Gonnarde1cc9262024-08-14 09:47:38 +0200637 /* Authmode: precedence order is SNI if used else configuration */
638#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
639 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
640 ? ssl->handshake->sni_authmode
641 : ssl->conf->authmode;
642#else
643 const int authmode = ssl->conf->authmode;
XiaokangQian6b916b12022-04-25 07:29:34 +0000644#endif
645
646 /*
XiaokangQian989f06d2022-05-17 01:50:15 +0000647 * If the peer hasn't sent a certificate ( i.e. it sent
XiaokangQian6b916b12022-04-25 07:29:34 +0000648 * an empty certificate chain ), this is reflected in the peer CRT
649 * structure being unset.
650 * Check for that and handle it depending on the
XiaokangQian989f06d2022-05-17 01:50:15 +0000651 * authentication mode.
XiaokangQian6b916b12022-04-25 07:29:34 +0000652 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100653 if (ssl->session_negotiate->peer_cert == NULL) {
654 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
XiaokangQian989f06d2022-05-17 01:50:15 +0000655
XiaokangQian63e713e2022-05-15 04:26:57 +0000656#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100657 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
XiaokangQian63e713e2022-05-15 04:26:57 +0000658 /* The client was asked for a certificate but didn't send
659 * one. The client should know what's going on, so we
660 * don't send an alert.
661 */
662 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
Gilles Peskine449bd832023-01-11 14:50:10 +0100663 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
664 return 0;
665 } else {
Xiaokang Qian73437382023-03-29 08:24:12 +0000666 MBEDTLS_SSL_PEND_FATAL_ALERT(
667 MBEDTLS_SSL_ALERT_MSG_NO_CERT,
668 MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE);
Gilles Peskine449bd832023-01-11 14:50:10 +0100669 return MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
XiaokangQian989f06d2022-05-17 01:50:15 +0000670 }
XiaokangQian63e713e2022-05-15 04:26:57 +0000671 }
XiaokangQian6b916b12022-04-25 07:29:34 +0000672#endif /* MBEDTLS_SSL_SRV_C */
673
XiaokangQianc3017f62022-05-13 05:55:41 +0000674#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard4d4c0c72024-08-12 10:36:40 +0200675 /* Regardless of authmode, the server is not allowed to send an empty
676 * certificate chain. (Last paragraph before 4.4.2.1 in RFC 8446: "The
677 * server's certificate_list MUST always be non-empty.") With authmode
678 * optional/none, we continue the handshake if we can't validate the
679 * server's cert, but we still break it if no certificate was sent. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100680 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
681 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_NO_CERT,
682 MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE);
683 return MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE;
XiaokangQian63e713e2022-05-15 04:26:57 +0000684 }
XiaokangQianc3017f62022-05-13 05:55:41 +0000685#endif /* MBEDTLS_SSL_CLI_C */
XiaokangQian63e713e2022-05-15 04:26:57 +0000686 }
XiaokangQian6b916b12022-04-25 07:29:34 +0000687
Manuel Pégourié-Gonnard2b98a4e2024-08-14 10:44:02 +0200688 /*
689 * NONE means we skip all checks
690 *
691 * Note: we still check above that the server did send a certificate,
692 * because only a non-compliant server would fail to do so. NONE means we
693 * don't care about the server certificate being valid, but we still care
694 * about the server otherwise following the TLS standard.
695 */
696 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
697 return 0;
698 }
699
Xiaofei Bai947571e2021-09-29 09:12:03 +0000700 /*
701 * Main check: verify certificate
702 */
Ronald Croncb7f6322024-04-03 09:07:22 +0200703#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
704 if (ssl->conf->f_ca_cb != NULL) {
705 have_ca_chain = 1;
706
707 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
708 ret = mbedtls_x509_crt_verify_with_ca_cb(
709 ssl->session_negotiate->peer_cert,
710 ssl->conf->f_ca_cb,
711 ssl->conf->p_ca_cb,
712 ssl->conf->cert_profile,
713 ssl->hostname,
714 &verify_result,
715 ssl->conf->f_vrfy, ssl->conf->p_vrfy);
716 } else
717#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
718 {
719#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
720 if (ssl->handshake->sni_ca_chain != NULL) {
721 ca_chain = ssl->handshake->sni_ca_chain;
722 ca_crl = ssl->handshake->sni_ca_crl;
723 } else
724#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
725 {
726 ca_chain = ssl->conf->ca_chain;
727 ca_crl = ssl->conf->ca_crl;
728 }
729
730 if (ca_chain != NULL) {
731 have_ca_chain = 1;
732 }
733
734 ret = mbedtls_x509_crt_verify_with_profile(
735 ssl->session_negotiate->peer_cert,
736 ca_chain, ca_crl,
737 ssl->conf->cert_profile,
738 ssl->hostname,
739 &verify_result,
740 ssl->conf->f_vrfy, ssl->conf->p_vrfy);
741 }
Xiaofei Bai947571e2021-09-29 09:12:03 +0000742
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 if (ret != 0) {
744 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Xiaofei Bai947571e2021-09-29 09:12:03 +0000745 }
746
747 /*
748 * Secondary checks: always done, but change 'ret' only if it was 0
749 */
Manuel Pégourié-Gonnard4938b692024-08-09 11:49:12 +0200750 if (mbedtls_ssl_check_cert_usage(ssl->session_negotiate->peer_cert,
751 NULL,
752 ssl->conf->endpoint,
753 MBEDTLS_SSL_VERSION_TLS1_3,
754 &verify_result) != 0) {
Manuel Pégourié-Gonnardef41d8c2024-08-08 10:28:56 +0200755 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
756 if (ret == 0) {
757 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
758 }
Xiaofei Bai947571e2021-09-29 09:12:03 +0000759 }
760
XiaokangQian6b916b12022-04-25 07:29:34 +0000761 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
762 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
763 * with details encoded in the verification flags. All other kinds
764 * of error codes, including those from the user provided f_vrfy
765 * functions, are treated as fatal and lead to a failure of
Ronald Crone3dac4a2022-06-10 17:21:51 +0200766 * mbedtls_ssl_tls13_parse_certificate even if verification was optional.
767 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100768 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
769 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
770 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
XiaokangQian6b916b12022-04-25 07:29:34 +0000771 ret = 0;
772 }
Xiaofei Bai947571e2021-09-29 09:12:03 +0000773
Ronald Croncb7f6322024-04-03 09:07:22 +0200774 if (!have_ca_chain && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100775 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Xiaofei Bai947571e2021-09-29 09:12:03 +0000776 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
777 }
778
Gilles Peskine449bd832023-01-11 14:50:10 +0100779 if (ret != 0) {
Xiaofei Bai947571e2021-09-29 09:12:03 +0000780 /* The certificate may have been rejected for several reasons.
781 Pick one and send the corresponding alert. Which alert to send
782 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 if (verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Xiaokang Qian73437382023-03-29 08:24:12 +0000784 MBEDTLS_SSL_PEND_FATAL_ALERT(
785 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED, ret);
Gilles Peskine449bd832023-01-11 14:50:10 +0100786 } else if (verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
787 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_BAD_CERT, ret);
788 } else if (verify_result & (MBEDTLS_X509_BADCERT_KEY_USAGE |
789 MBEDTLS_X509_BADCERT_EXT_KEY_USAGE |
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 MBEDTLS_X509_BADCERT_BAD_PK |
791 MBEDTLS_X509_BADCERT_BAD_KEY)) {
Xiaokang Qian73437382023-03-29 08:24:12 +0000792 MBEDTLS_SSL_PEND_FATAL_ALERT(
793 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT, ret);
Gilles Peskine449bd832023-01-11 14:50:10 +0100794 } else if (verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Xiaokang Qian73437382023-03-29 08:24:12 +0000795 MBEDTLS_SSL_PEND_FATAL_ALERT(
796 MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED, ret);
Gilles Peskine449bd832023-01-11 14:50:10 +0100797 } else if (verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Xiaokang Qian73437382023-03-29 08:24:12 +0000798 MBEDTLS_SSL_PEND_FATAL_ALERT(
799 MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED, ret);
Gilles Peskine449bd832023-01-11 14:50:10 +0100800 } else if (verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
801 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA, ret);
802 } else {
Xiaokang Qian73437382023-03-29 08:24:12 +0000803 MBEDTLS_SSL_PEND_FATAL_ALERT(
804 MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN, ret);
Gilles Peskine449bd832023-01-11 14:50:10 +0100805 }
Xiaofei Bai947571e2021-09-29 09:12:03 +0000806 }
807
808#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100809 if (verify_result != 0) {
810 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
811 (unsigned int) verify_result));
812 } else {
813 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Xiaofei Bai947571e2021-09-29 09:12:03 +0000814 }
815#endif /* MBEDTLS_DEBUG_C */
816
Xiaofei Baiff456022021-10-28 06:50:17 +0000817 ssl->session_negotiate->verify_result = verify_result;
Gilles Peskine449bd832023-01-11 14:50:10 +0100818 return ret;
Xiaofei Bai947571e2021-09-29 09:12:03 +0000819}
820#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200821MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100822static int ssl_tls13_validate_certificate(mbedtls_ssl_context *ssl)
Xiaofei Bai947571e2021-09-29 09:12:03 +0000823{
824 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +0100825 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Xiaofei Bai947571e2021-09-29 09:12:03 +0000826}
827#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Ronald Cronde08cf32022-10-04 17:15:35 +0200828#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Xiaofei Bai947571e2021-09-29 09:12:03 +0000829
Gilles Peskine449bd832023-01-11 14:50:10 +0100830int mbedtls_ssl_tls13_process_certificate(mbedtls_ssl_context *ssl)
Xiaofei Bai947571e2021-09-29 09:12:03 +0000831{
Xiaofei Bai79595ac2021-10-26 07:16:45 +0000832 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100833 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Xiaofei Bai79595ac2021-10-26 07:16:45 +0000834
Ronald Cronde08cf32022-10-04 17:15:35 +0200835#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQianc3017f62022-05-13 05:55:41 +0000836 unsigned char *buf;
837 size_t buf_len;
Xiaofei Bai79595ac2021-10-26 07:16:45 +0000838
Gilles Peskine449bd832023-01-11 14:50:10 +0100839 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
840 ssl, MBEDTLS_SSL_HS_CERTIFICATE,
841 &buf, &buf_len));
Xiaofei Bai79595ac2021-10-26 07:16:45 +0000842
XiaokangQianc3017f62022-05-13 05:55:41 +0000843 /* Parse the certificate chain sent by the peer. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100844 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_parse_certificate(ssl, buf,
845 buf + buf_len));
XiaokangQianc3017f62022-05-13 05:55:41 +0000846 /* Validate the certificate chain and set the verification results. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100847 MBEDTLS_SSL_PROC_CHK(ssl_tls13_validate_certificate(ssl));
Xiaofei Bai79595ac2021-10-26 07:16:45 +0000848
Xiaokang Qian73437382023-03-29 08:24:12 +0000849 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
850 ssl, MBEDTLS_SSL_HS_CERTIFICATE, buf, buf_len));
Xiaofei Bai79595ac2021-10-26 07:16:45 +0000851
Xiaofei Bai79595ac2021-10-26 07:16:45 +0000852cleanup:
Gilles Peskineff2558a2023-09-05 21:10:39 +0200853#else /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
854 (void) ssl;
Ronald Cronde08cf32022-10-04 17:15:35 +0200855#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Xiaofei Bai79595ac2021-10-26 07:16:45 +0000856
Gilles Peskine449bd832023-01-11 14:50:10 +0100857 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
858 return ret;
Xiaofei Bai947571e2021-09-29 09:12:03 +0000859}
Ronald Cron928cbd32022-10-04 16:14:26 +0200860#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu7399d0d2022-01-30 17:54:19 +0800861/*
862 * enum {
863 * X509(0),
864 * RawPublicKey(2),
865 * (255)
866 * } CertificateType;
867 *
868 * struct {
869 * select (certificate_type) {
870 * case RawPublicKey:
871 * // From RFC 7250 ASN.1_subjectPublicKeyInfo
872 * opaque ASN1_subjectPublicKeyInfo<1..2^24-1>;
873 *
874 * case X509:
875 * opaque cert_data<1..2^24-1>;
876 * };
877 * Extension extensions<0..2^16-1>;
878 * } CertificateEntry;
879 *
880 * struct {
881 * opaque certificate_request_context<0..2^8-1>;
882 * CertificateEntry certificate_list<0..2^24-1>;
883 * } Certificate;
884 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200885MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100886static int ssl_tls13_write_certificate_body(mbedtls_ssl_context *ssl,
887 unsigned char *buf,
888 unsigned char *end,
889 size_t *out_len)
Jerry Yu5cc35062022-01-28 16:16:08 +0800890{
Gilles Peskine449bd832023-01-11 14:50:10 +0100891 const mbedtls_x509_crt *crt = mbedtls_ssl_own_cert(ssl);
Jerry Yu3e536442022-02-15 11:05:59 +0800892 unsigned char *p = buf;
Jerry Yuc8d8d4e2022-02-18 12:10:03 +0800893 unsigned char *certificate_request_context =
Gilles Peskine449bd832023-01-11 14:50:10 +0100894 ssl->handshake->certificate_request_context;
Jerry Yuc8d8d4e2022-02-18 12:10:03 +0800895 unsigned char certificate_request_context_len =
Gilles Peskine449bd832023-01-11 14:50:10 +0100896 ssl->handshake->certificate_request_context_len;
Jerry Yuc8d8d4e2022-02-18 12:10:03 +0800897 unsigned char *p_certificate_list_len;
Jerry Yu5cc35062022-01-28 16:16:08 +0800898
Jerry Yu5cc35062022-01-28 16:16:08 +0800899
Jerry Yu3391ac02022-02-16 11:21:37 +0800900 /* ...
901 * opaque certificate_request_context<0..2^8-1>;
902 * ...
903 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100904 MBEDTLS_SSL_CHK_BUF_PTR(p, end, certificate_request_context_len + 1);
Jerry Yuc8d8d4e2022-02-18 12:10:03 +0800905 *p++ = certificate_request_context_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100906 if (certificate_request_context_len > 0) {
907 memcpy(p, certificate_request_context, certificate_request_context_len);
Jerry Yuc8d8d4e2022-02-18 12:10:03 +0800908 p += certificate_request_context_len;
Jerry Yu537530d2022-02-15 14:00:57 +0800909 }
910
Jerry Yu3391ac02022-02-16 11:21:37 +0800911 /* ...
912 * CertificateEntry certificate_list<0..2^24-1>;
913 * ...
914 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100915 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 3);
Jerry Yuc8d8d4e2022-02-18 12:10:03 +0800916 p_certificate_list_len = p;
Jerry Yu3e536442022-02-15 11:05:59 +0800917 p += 3;
918
Gilles Peskine449bd832023-01-11 14:50:10 +0100919 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", crt);
Jerry Yu5cc35062022-01-28 16:16:08 +0800920
Gilles Peskine449bd832023-01-11 14:50:10 +0100921 while (crt != NULL) {
Jerry Yu7399d0d2022-01-30 17:54:19 +0800922 size_t cert_data_len = crt->raw.len;
Jerry Yu5cc35062022-01-28 16:16:08 +0800923
Gilles Peskine449bd832023-01-11 14:50:10 +0100924 MBEDTLS_SSL_CHK_BUF_PTR(p, end, cert_data_len + 3 + 2);
925 MBEDTLS_PUT_UINT24_BE(cert_data_len, p, 0);
Jerry Yu7399d0d2022-01-30 17:54:19 +0800926 p += 3;
Jerry Yu5cc35062022-01-28 16:16:08 +0800927
Gilles Peskine449bd832023-01-11 14:50:10 +0100928 memcpy(p, crt->raw.p, cert_data_len);
Jerry Yu7399d0d2022-01-30 17:54:19 +0800929 p += cert_data_len;
930 crt = crt->next;
Jerry Yu5cc35062022-01-28 16:16:08 +0800931
932 /* Currently, we don't have any certificate extensions defined.
933 * Hence, we are sending an empty extension with length zero.
934 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100935 MBEDTLS_PUT_UINT16_BE(0, p, 0);
Jerry Yu7399d0d2022-01-30 17:54:19 +0800936 p += 2;
Jerry Yu5cc35062022-01-28 16:16:08 +0800937 }
Jerry Yu5cc35062022-01-28 16:16:08 +0800938
Gilles Peskine449bd832023-01-11 14:50:10 +0100939 MBEDTLS_PUT_UINT24_BE(p - p_certificate_list_len - 3,
940 p_certificate_list_len, 0);
Jerry Yu7399d0d2022-01-30 17:54:19 +0800941
Jerry Yu3e536442022-02-15 11:05:59 +0800942 *out_len = p - buf;
Jerry Yu5cc35062022-01-28 16:16:08 +0800943
Jerry Yu7de2ff02022-11-08 21:43:46 +0800944 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +0100945 3, MBEDTLS_SSL_HS_CERTIFICATE, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +0800946
Gilles Peskine449bd832023-01-11 14:50:10 +0100947 return 0;
Jerry Yu5cc35062022-01-28 16:16:08 +0800948}
Jerry Yu5cc35062022-01-28 16:16:08 +0800949
Gilles Peskine449bd832023-01-11 14:50:10 +0100950int mbedtls_ssl_tls13_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yu5cc35062022-01-28 16:16:08 +0800951{
952 int ret;
Ronald Cron5bb8fc82022-03-09 07:00:13 +0100953 unsigned char *buf;
954 size_t buf_len, msg_len;
955
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yu5cc35062022-01-28 16:16:08 +0800957
Xiaokang Qian73437382023-03-29 08:24:12 +0000958 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
959 ssl, MBEDTLS_SSL_HS_CERTIFICATE, &buf, &buf_len));
Jerry Yu5cc35062022-01-28 16:16:08 +0800960
Gilles Peskine449bd832023-01-11 14:50:10 +0100961 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_body(ssl,
962 buf,
963 buf + buf_len,
964 &msg_len));
Jerry Yu5cc35062022-01-28 16:16:08 +0800965
Xiaokang Qian73437382023-03-29 08:24:12 +0000966 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
967 ssl, MBEDTLS_SSL_HS_CERTIFICATE, buf, msg_len));
Jerry Yu5cc35062022-01-28 16:16:08 +0800968
Gilles Peskine449bd832023-01-11 14:50:10 +0100969 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
970 ssl, buf_len, msg_len));
Jerry Yu5cc35062022-01-28 16:16:08 +0800971cleanup:
972
Gilles Peskine449bd832023-01-11 14:50:10 +0100973 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
974 return ret;
Jerry Yu5cc35062022-01-28 16:16:08 +0800975}
976
Jerry Yu3e536442022-02-15 11:05:59 +0800977/*
978 * STATE HANDLING: Output Certificate Verify
979 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100980int mbedtls_ssl_tls13_check_sig_alg_cert_key_match(uint16_t sig_alg,
981 mbedtls_pk_context *key)
Jerry Yu0c6be8f2022-06-20 20:42:00 +0800982{
Dave Rodgman2eab4622023-10-05 13:30:37 +0100983 mbedtls_pk_type_t pk_type = (mbedtls_pk_type_t) mbedtls_ssl_sig_from_pk(key);
Gilles Peskine449bd832023-01-11 14:50:10 +0100984 size_t key_size = mbedtls_pk_get_bitlen(key);
Jerry Yu0c6be8f2022-06-20 20:42:00 +0800985
Gilles Peskine449bd832023-01-11 14:50:10 +0100986 switch (pk_type) {
Jerry Yu67eced02022-02-25 13:37:36 +0800987 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100988 switch (key_size) {
Jerry Yu67eced02022-02-25 13:37:36 +0800989 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 return
991 sig_alg == MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256;
Jerry Yu0c6be8f2022-06-20 20:42:00 +0800992
Jerry Yu67eced02022-02-25 13:37:36 +0800993 case 384:
Gilles Peskine449bd832023-01-11 14:50:10 +0100994 return
995 sig_alg == MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384;
Jerry Yu0c6be8f2022-06-20 20:42:00 +0800996
Jerry Yu67eced02022-02-25 13:37:36 +0800997 case 521:
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 return
999 sig_alg == MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512;
Jerry Yu67eced02022-02-25 13:37:36 +08001000 default:
Jerry Yu67eced02022-02-25 13:37:36 +08001001 break;
1002 }
1003 break;
Jerry Yu67eced02022-02-25 13:37:36 +08001004
Jerry Yu67eced02022-02-25 13:37:36 +08001005 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01001006 switch (sig_alg) {
Ronald Cron38391bf2022-09-16 11:19:27 +02001007 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256: /* Intentional fallthrough */
1008 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384: /* Intentional fallthrough */
Jerry Yu0c6be8f2022-06-20 20:42:00 +08001009 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001010 return 1;
Jerry Yuc2e04932022-06-27 22:13:03 +08001011
Jerry Yu0c6be8f2022-06-20 20:42:00 +08001012 default:
1013 break;
Jerry Yucef3f332022-03-22 23:00:13 +08001014 }
Jerry Yu67eced02022-02-25 13:37:36 +08001015 break;
Jerry Yu0c6be8f2022-06-20 20:42:00 +08001016
Jerry Yu67eced02022-02-25 13:37:36 +08001017 default:
Jerry Yu67eced02022-02-25 13:37:36 +08001018 break;
1019 }
Jerry Yu0c6be8f2022-06-20 20:42:00 +08001020
Gilles Peskine449bd832023-01-11 14:50:10 +01001021 return 0;
Jerry Yu0c6be8f2022-06-20 20:42:00 +08001022}
1023
Ronald Cronce7d76e2022-07-08 18:56:49 +02001024MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001025static int ssl_tls13_write_certificate_verify_body(mbedtls_ssl_context *ssl,
1026 unsigned char *buf,
1027 unsigned char *end,
1028 size_t *out_len)
Jerry Yu8511f122022-01-29 10:01:04 +08001029{
Ronald Cron067a1e72022-09-16 13:44:49 +02001030 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3e536442022-02-15 11:05:59 +08001031 unsigned char *p = buf;
Jerry Yu8511f122022-01-29 10:01:04 +08001032 mbedtls_pk_context *own_key;
Jerry Yu3e536442022-02-15 11:05:59 +08001033
Gilles Peskine449bd832023-01-11 14:50:10 +01001034 unsigned char handshake_hash[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yu8511f122022-01-29 10:01:04 +08001035 size_t handshake_hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001036 unsigned char verify_buffer[SSL_VERIFY_STRUCT_MAX_SIZE];
Jerry Yu3e536442022-02-15 11:05:59 +08001037 size_t verify_buffer_len;
Ronald Cron067a1e72022-09-16 13:44:49 +02001038
1039 uint16_t *sig_alg = ssl->handshake->received_sig_algs;
Jerry Yu3e536442022-02-15 11:05:59 +08001040 size_t signature_len = 0;
Jerry Yu8511f122022-01-29 10:01:04 +08001041
Jerry Yu0b7b1012022-02-23 12:23:05 +08001042 *out_len = 0;
1043
Gilles Peskine449bd832023-01-11 14:50:10 +01001044 own_key = mbedtls_ssl_own_key(ssl);
1045 if (own_key == NULL) {
1046 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
1047 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu8511f122022-01-29 10:01:04 +08001048 }
1049
Xiaokang Qian73437382023-03-29 08:24:12 +00001050 ret = mbedtls_ssl_get_handshake_transcript(
Dave Rodgman2eab4622023-10-05 13:30:37 +01001051 ssl, (mbedtls_md_type_t) ssl->handshake->ciphersuite_info->mac,
Xiaokang Qian73437382023-03-29 08:24:12 +00001052 handshake_hash, sizeof(handshake_hash), &handshake_hash_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001053 if (ret != 0) {
1054 return ret;
1055 }
Jerry Yu8511f122022-01-29 10:01:04 +08001056
Gilles Peskine449bd832023-01-11 14:50:10 +01001057 MBEDTLS_SSL_DEBUG_BUF(3, "handshake hash",
1058 handshake_hash,
1059 handshake_hash_len);
Jerry Yu8511f122022-01-29 10:01:04 +08001060
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 ssl_tls13_create_verify_structure(handshake_hash, handshake_hash_len,
1062 verify_buffer, &verify_buffer_len,
1063 ssl->conf->endpoint);
Jerry Yu8511f122022-01-29 10:01:04 +08001064
1065 /*
1066 * struct {
1067 * SignatureScheme algorithm;
1068 * opaque signature<0..2^16-1>;
1069 * } CertificateVerify;
1070 */
Ronald Cron067a1e72022-09-16 13:44:49 +02001071 /* Check there is space for the algorithm identifier (2 bytes) and the
1072 * signature length (2 bytes).
1073 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4);
Ronald Cron067a1e72022-09-16 13:44:49 +02001075
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
Ronald Cron067a1e72022-09-16 13:44:49 +02001077 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1078 mbedtls_pk_type_t pk_type = MBEDTLS_PK_NONE;
1079 mbedtls_md_type_t md_alg = MBEDTLS_MD_NONE;
1080 psa_algorithm_t psa_algorithm = PSA_ALG_NONE;
1081 unsigned char verify_hash[PSA_HASH_MAX_SIZE];
1082 size_t verify_hash_len;
Jerry Yu67eced02022-02-25 13:37:36 +08001083
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 if (!mbedtls_ssl_sig_alg_is_offered(ssl, *sig_alg)) {
Ronald Cron067a1e72022-09-16 13:44:49 +02001085 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 }
Jerry Yu67eced02022-02-25 13:37:36 +08001087
Gilles Peskine449bd832023-01-11 14:50:10 +01001088 if (!mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(*sig_alg)) {
Ronald Cron067a1e72022-09-16 13:44:49 +02001089 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 }
Ronald Cron067a1e72022-09-16 13:44:49 +02001091
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 if (!mbedtls_ssl_tls13_check_sig_alg_cert_key_match(*sig_alg, own_key)) {
Ronald Cron067a1e72022-09-16 13:44:49 +02001093 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 }
Ronald Cron067a1e72022-09-16 13:44:49 +02001095
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 if (mbedtls_ssl_get_pk_type_and_md_alg_from_sig_alg(
1097 *sig_alg, &pk_type, &md_alg) != 0) {
1098 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Ronald Cron067a1e72022-09-16 13:44:49 +02001099 }
1100
1101 /* Hash verify buffer with indicated hash function */
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02001102 psa_algorithm = mbedtls_md_psa_alg_from_type(md_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01001103 status = psa_hash_compute(psa_algorithm,
1104 verify_buffer,
1105 verify_buffer_len,
1106 verify_hash, sizeof(verify_hash),
1107 &verify_hash_len);
1108 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001109 return PSA_TO_MBEDTLS_ERR(status);
Ronald Cron067a1e72022-09-16 13:44:49 +02001110 }
1111
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 MBEDTLS_SSL_DEBUG_BUF(3, "verify hash", verify_hash, verify_hash_len);
1113
1114 if ((ret = mbedtls_pk_sign_ext(pk_type, own_key,
1115 md_alg, verify_hash, verify_hash_len,
1116 p + 4, (size_t) (end - (p + 4)), &signature_len,
1117 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
1118 MBEDTLS_SSL_DEBUG_MSG(2, ("CertificateVerify signature failed with %s",
1119 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
1120 MBEDTLS_SSL_DEBUG_RET(2, "mbedtls_pk_sign_ext", ret);
1121
1122 /* The signature failed. This is possible if the private key
1123 * was not suitable for the signature operation as purposely we
1124 * did not check its suitability completely. Let's try with
1125 * another signature algorithm.
1126 */
1127 continue;
1128 }
1129
1130 MBEDTLS_SSL_DEBUG_MSG(2, ("CertificateVerify signature with %s",
1131 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
Ronald Cron067a1e72022-09-16 13:44:49 +02001132
1133 break;
1134 }
1135
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 if (*sig_alg == MBEDTLS_TLS1_3_SIG_NONE) {
1137 MBEDTLS_SSL_DEBUG_MSG(1, ("no suitable signature algorithm"));
1138 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1139 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1140 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu8511f122022-01-29 10:01:04 +08001141 }
1142
Gilles Peskine449bd832023-01-11 14:50:10 +01001143 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
1144 MBEDTLS_PUT_UINT16_BE(signature_len, p, 2);
Jerry Yuf3b46b52022-06-19 16:52:27 +08001145
Ronald Cron067a1e72022-09-16 13:44:49 +02001146 *out_len = 4 + signature_len;
Jerry Yu8c338862022-03-23 13:34:04 +08001147
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 return 0;
Jerry Yu8511f122022-01-29 10:01:04 +08001149}
Jerry Yu8511f122022-01-29 10:01:04 +08001150
Gilles Peskine449bd832023-01-11 14:50:10 +01001151int mbedtls_ssl_tls13_write_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu8511f122022-01-29 10:01:04 +08001152{
1153 int ret = 0;
Jerry Yuca133a32022-02-15 14:22:05 +08001154 unsigned char *buf;
1155 size_t buf_len, msg_len;
1156
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate verify"));
Jerry Yu8511f122022-01-29 10:01:04 +08001158
Xiaokang Qian73437382023-03-29 08:24:12 +00001159 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
1160 ssl, MBEDTLS_SSL_HS_CERTIFICATE_VERIFY,
1161 &buf, &buf_len));
Jerry Yu8511f122022-01-29 10:01:04 +08001162
Gilles Peskine449bd832023-01-11 14:50:10 +01001163 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_verify_body(
1164 ssl, buf, buf + buf_len, &msg_len));
Jerry Yu8511f122022-01-29 10:01:04 +08001165
Xiaokang Qian73437382023-03-29 08:24:12 +00001166 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
1167 ssl, MBEDTLS_SSL_HS_CERTIFICATE_VERIFY,
1168 buf, msg_len));
Jerry Yu8511f122022-01-29 10:01:04 +08001169
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
1171 ssl, buf_len, msg_len));
Jerry Yu8511f122022-01-29 10:01:04 +08001172
1173cleanup:
1174
Gilles Peskine449bd832023-01-11 14:50:10 +01001175 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate verify"));
1176 return ret;
Jerry Yu8511f122022-01-29 10:01:04 +08001177}
1178
Ronald Cron928cbd32022-10-04 16:14:26 +02001179#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu90f152d2022-01-29 22:12:42 +08001180
Jerry Yu5cc35062022-01-28 16:16:08 +08001181/*
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001182 *
XiaokangQianc5c39d52021-11-09 11:55:10 +00001183 * STATE HANDLING: Incoming Finished message.
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001184 */
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001185/*
1186 * Implementation
1187 */
1188
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001189MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001190static int ssl_tls13_preprocess_finished_message(mbedtls_ssl_context *ssl)
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001191{
1192 int ret;
1193
Xiaokang Qian73437382023-03-29 08:24:12 +00001194 ret = mbedtls_ssl_tls13_calculate_verify_data(
1195 ssl,
1196 ssl->handshake->state_local.finished_in.digest,
1197 sizeof(ssl->handshake->state_local.finished_in.digest),
1198 &ssl->handshake->state_local.finished_in.digest_len,
1199 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT ?
1200 MBEDTLS_SSL_IS_SERVER : MBEDTLS_SSL_IS_CLIENT);
Gilles Peskine449bd832023-01-11 14:50:10 +01001201 if (ret != 0) {
1202 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_tls13_calculate_verify_data", ret);
1203 return ret;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001204 }
1205
Gilles Peskine449bd832023-01-11 14:50:10 +01001206 return 0;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001207}
1208
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001209MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001210static int ssl_tls13_parse_finished_message(mbedtls_ssl_context *ssl,
1211 const unsigned char *buf,
1212 const unsigned char *end)
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001213{
XiaokangQian33062842021-11-11 03:37:45 +00001214 /*
1215 * struct {
XiaokangQianc13f9352021-11-11 06:13:22 +00001216 * opaque verify_data[Hash.length];
XiaokangQian33062842021-11-11 03:37:45 +00001217 * } Finished;
1218 */
1219 const unsigned char *expected_verify_data =
1220 ssl->handshake->state_local.finished_in.digest;
1221 size_t expected_verify_data_len =
1222 ssl->handshake->state_local.finished_in.digest_len;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001223 /* Structural validation */
Gilles Peskine449bd832023-01-11 14:50:10 +01001224 if ((size_t) (end - buf) != expected_verify_data_len) {
1225 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001226
Gilles Peskine449bd832023-01-11 14:50:10 +01001227 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
1228 MBEDTLS_ERR_SSL_DECODE_ERROR);
1229 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001230 }
1231
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 MBEDTLS_SSL_DEBUG_BUF(4, "verify_data (self-computed):",
1233 expected_verify_data,
1234 expected_verify_data_len);
1235 MBEDTLS_SSL_DEBUG_BUF(4, "verify_data (received message):", buf,
1236 expected_verify_data_len);
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001237
1238 /* Semantic validation */
Gilles Peskine449bd832023-01-11 14:50:10 +01001239 if (mbedtls_ct_memcmp(buf,
1240 expected_verify_data,
1241 expected_verify_data_len) != 0) {
1242 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001243
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
1245 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1246 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001247 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 return 0;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001249}
1250
Gilles Peskine449bd832023-01-11 14:50:10 +01001251int mbedtls_ssl_tls13_process_finished_message(mbedtls_ssl_context *ssl)
XiaokangQianc5c39d52021-11-09 11:55:10 +00001252{
XiaokangQian33062842021-11-11 03:37:45 +00001253 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianc5c39d52021-11-09 11:55:10 +00001254 unsigned char *buf;
Xiaofei Baieef15042021-11-18 07:29:56 +00001255 size_t buf_len;
XiaokangQianc5c39d52021-11-09 11:55:10 +00001256
Gilles Peskine449bd832023-01-11 14:50:10 +01001257 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished message"));
XiaokangQianc5c39d52021-11-09 11:55:10 +00001258
Xiaokang Qian73437382023-03-29 08:24:12 +00001259 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1260 ssl, MBEDTLS_SSL_HS_FINISHED, &buf, &buf_len));
Jerry Yu0a92d6c2022-05-16 16:54:46 +08001261
1262 /* Preprocessing step: Compute handshake digest */
Gilles Peskine449bd832023-01-11 14:50:10 +01001263 MBEDTLS_SSL_PROC_CHK(ssl_tls13_preprocess_finished_message(ssl));
Jerry Yu0a92d6c2022-05-16 16:54:46 +08001264
Xiaokang Qian73437382023-03-29 08:24:12 +00001265 MBEDTLS_SSL_PROC_CHK(ssl_tls13_parse_finished_message(
1266 ssl, buf, buf + buf_len));
Jerry Yu0a92d6c2022-05-16 16:54:46 +08001267
Xiaokang Qian73437382023-03-29 08:24:12 +00001268 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
1269 ssl, MBEDTLS_SSL_HS_FINISHED, buf, buf_len));
XiaokangQianc5c39d52021-11-09 11:55:10 +00001270
1271cleanup:
1272
Gilles Peskine449bd832023-01-11 14:50:10 +01001273 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished message"));
1274 return ret;
XiaokangQianc5c39d52021-11-09 11:55:10 +00001275}
1276
XiaokangQian74af2a82021-09-22 07:40:30 +00001277/*
1278 *
XiaokangQiancc90c942021-11-09 12:30:09 +00001279 * STATE HANDLING: Write and send Finished message.
XiaokangQian74af2a82021-09-22 07:40:30 +00001280 *
1281 */
XiaokangQian74af2a82021-09-22 07:40:30 +00001282/*
XiaokangQian35dc6252021-11-11 08:16:19 +00001283 * Implement
XiaokangQian74af2a82021-09-22 07:40:30 +00001284 */
1285
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001286MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001287static int ssl_tls13_prepare_finished_message(mbedtls_ssl_context *ssl)
XiaokangQian74af2a82021-09-22 07:40:30 +00001288{
1289 int ret;
1290
1291 /* Compute transcript of handshake up to now. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001292 ret = mbedtls_ssl_tls13_calculate_verify_data(ssl,
1293 ssl->handshake->state_local.finished_out.digest,
1294 sizeof(ssl->handshake->state_local.finished_out.
1295 digest),
1296 &ssl->handshake->state_local.finished_out.digest_len,
1297 ssl->conf->endpoint);
XiaokangQian74af2a82021-09-22 07:40:30 +00001298
Gilles Peskine449bd832023-01-11 14:50:10 +01001299 if (ret != 0) {
1300 MBEDTLS_SSL_DEBUG_RET(1, "calculate_verify_data failed", ret);
1301 return ret;
XiaokangQian74af2a82021-09-22 07:40:30 +00001302 }
1303
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 return 0;
XiaokangQian74af2a82021-09-22 07:40:30 +00001305}
1306
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001307MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001308static int ssl_tls13_write_finished_message_body(mbedtls_ssl_context *ssl,
1309 unsigned char *buf,
1310 unsigned char *end,
1311 size_t *out_len)
XiaokangQian74af2a82021-09-22 07:40:30 +00001312{
XiaokangQian8773aa02021-11-10 07:33:09 +00001313 size_t verify_data_len = ssl->handshake->state_local.finished_out.digest_len;
XiaokangQian0fa66432021-11-15 03:33:57 +00001314 /*
1315 * struct {
1316 * opaque verify_data[Hash.length];
1317 * } Finished;
1318 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001319 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, verify_data_len);
XiaokangQian74af2a82021-09-22 07:40:30 +00001320
Gilles Peskine449bd832023-01-11 14:50:10 +01001321 memcpy(buf, ssl->handshake->state_local.finished_out.digest,
1322 verify_data_len);
XiaokangQian74af2a82021-09-22 07:40:30 +00001323
Xiaofei Baid25fab62021-12-02 06:36:27 +00001324 *out_len = verify_data_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001325 return 0;
XiaokangQian74af2a82021-09-22 07:40:30 +00001326}
XiaokangQianc5c39d52021-11-09 11:55:10 +00001327
XiaokangQian35dc6252021-11-11 08:16:19 +00001328/* Main entry point: orchestrates the other functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01001329int mbedtls_ssl_tls13_write_finished_message(mbedtls_ssl_context *ssl)
XiaokangQian35dc6252021-11-11 08:16:19 +00001330{
1331 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1332 unsigned char *buf;
1333 size_t buf_len, msg_len;
1334
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished message"));
XiaokangQian35dc6252021-11-11 08:16:19 +00001336
Gilles Peskine449bd832023-01-11 14:50:10 +01001337 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_finished_message(ssl));
XiaokangQiandce82242021-11-15 06:01:26 +00001338
Gilles Peskine449bd832023-01-11 14:50:10 +01001339 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
1340 MBEDTLS_SSL_HS_FINISHED, &buf, &buf_len));
XiaokangQian35dc6252021-11-11 08:16:19 +00001341
Gilles Peskine449bd832023-01-11 14:50:10 +01001342 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_finished_message_body(
1343 ssl, buf, buf + buf_len, &msg_len));
XiaokangQian35dc6252021-11-11 08:16:19 +00001344
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001345 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01001346 MBEDTLS_SSL_HS_FINISHED, buf, msg_len));
XiaokangQian35dc6252021-11-11 08:16:19 +00001347
Gilles Peskine449bd832023-01-11 14:50:10 +01001348 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
1349 ssl, buf_len, msg_len));
XiaokangQian35dc6252021-11-11 08:16:19 +00001350cleanup:
1351
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished message"));
1353 return ret;
XiaokangQian35dc6252021-11-11 08:16:19 +00001354}
1355
Gilles Peskine449bd832023-01-11 14:50:10 +01001356void mbedtls_ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu378254d2021-10-30 21:44:47 +08001357{
1358
Gilles Peskine449bd832023-01-11 14:50:10 +01001359 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu378254d2021-10-30 21:44:47 +08001360
Gilles Peskine449bd832023-01-11 14:50:10 +01001361 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to application keys for inbound traffic"));
1362 mbedtls_ssl_set_inbound_transform(ssl, ssl->transform_application);
Jerry Yue8c1fca2022-05-18 14:48:56 +08001363
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to application keys for outbound traffic"));
1365 mbedtls_ssl_set_outbound_transform(ssl, ssl->transform_application);
Jerry Yue8c1fca2022-05-18 14:48:56 +08001366
Jerry Yu378254d2021-10-30 21:44:47 +08001367 /*
Jerry Yucfe64f02021-11-15 13:54:06 +08001368 * Free the previous session and switch to the current one.
Jerry Yu378254d2021-10-30 21:44:47 +08001369 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001370 if (ssl->session) {
1371 mbedtls_ssl_session_free(ssl->session);
1372 mbedtls_free(ssl->session);
Jerry Yu378254d2021-10-30 21:44:47 +08001373 }
1374 ssl->session = ssl->session_negotiate;
1375 ssl->session_negotiate = NULL;
1376
Gilles Peskine449bd832023-01-11 14:50:10 +01001377 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu378254d2021-10-30 21:44:47 +08001378}
1379
Ronald Cron49ad6192021-11-24 16:25:31 +01001380/*
1381 *
1382 * STATE HANDLING: Write ChangeCipherSpec
1383 *
1384 */
1385#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001386MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001387static int ssl_tls13_write_change_cipher_spec_body(mbedtls_ssl_context *ssl,
1388 unsigned char *buf,
1389 unsigned char *end,
1390 size_t *olen)
Ronald Cron49ad6192021-11-24 16:25:31 +01001391{
1392 ((void) ssl);
1393
Gilles Peskine449bd832023-01-11 14:50:10 +01001394 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 1);
Ronald Cron49ad6192021-11-24 16:25:31 +01001395 buf[0] = 1;
1396 *olen = 1;
1397
Gilles Peskine449bd832023-01-11 14:50:10 +01001398 return 0;
Ronald Cron49ad6192021-11-24 16:25:31 +01001399}
1400
Gilles Peskine449bd832023-01-11 14:50:10 +01001401int mbedtls_ssl_tls13_write_change_cipher_spec(mbedtls_ssl_context *ssl)
Ronald Cron49ad6192021-11-24 16:25:31 +01001402{
1403 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1404
Gilles Peskine449bd832023-01-11 14:50:10 +01001405 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write change cipher spec"));
Ronald Cron49ad6192021-11-24 16:25:31 +01001406
Ronald Crone273f722024-02-13 18:22:26 +01001407 /* Only one CCS to send. */
Ronald Cron5fbd2702024-02-14 10:03:36 +01001408 if (ssl->handshake->ccs_sent) {
Ronald Crone273f722024-02-13 18:22:26 +01001409 ret = 0;
1410 goto cleanup;
1411 }
1412
Ronald Cron49ad6192021-11-24 16:25:31 +01001413 /* Write CCS message */
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_change_cipher_spec_body(
1415 ssl, ssl->out_msg,
1416 ssl->out_msg + MBEDTLS_SSL_OUT_CONTENT_LEN,
1417 &ssl->out_msglen));
Ronald Cron49ad6192021-11-24 16:25:31 +01001418
1419 ssl->out_msgtype = MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC;
1420
Ronald Cron49ad6192021-11-24 16:25:31 +01001421 /* Dispatch message */
Gilles Peskine449bd832023-01-11 14:50:10 +01001422 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_write_record(ssl, 0));
Ronald Cron49ad6192021-11-24 16:25:31 +01001423
Ronald Cron5fbd2702024-02-14 10:03:36 +01001424 ssl->handshake->ccs_sent = 1;
Ronald Cronfe59ff72024-01-24 14:31:50 +01001425
Ronald Cron49ad6192021-11-24 16:25:31 +01001426cleanup:
1427
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write change cipher spec"));
1429 return ret;
Ronald Cron49ad6192021-11-24 16:25:31 +01001430}
1431
1432#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
1433
Xiaokang Qianecc29482022-11-02 07:52:47 +00001434/* Early Data Indication Extension
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001435 *
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001436 * struct {
1437 * select ( Handshake.msg_type ) {
Jerry Yu52335392023-11-23 18:06:06 +08001438 * case new_session_ticket: uint32 max_early_data_size;
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001439 * case client_hello: Empty;
1440 * case encrypted_extensions: Empty;
1441 * };
1442 * } EarlyDataIndication;
1443 */
1444#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001445int mbedtls_ssl_tls13_write_early_data_ext(mbedtls_ssl_context *ssl,
Jerry Yuc59c5862023-12-05 10:40:49 +08001446 int in_new_session_ticket,
Gilles Peskine449bd832023-01-11 14:50:10 +01001447 unsigned char *buf,
1448 const unsigned char *end,
Jerry Yuc59c5862023-12-05 10:40:49 +08001449 size_t *out_len)
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001450{
1451 unsigned char *p = buf;
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001452
Jerry Yu52335392023-11-23 18:06:06 +08001453#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yuc59c5862023-12-05 10:40:49 +08001454 const size_t needed = in_new_session_ticket ? 8 : 4;
Jerry Yu52335392023-11-23 18:06:06 +08001455#else
1456 const size_t needed = 4;
Jerry Yuc59c5862023-12-05 10:40:49 +08001457 ((void) in_new_session_ticket);
Jerry Yu52335392023-11-23 18:06:06 +08001458#endif
1459
1460 *out_len = 0;
1461
1462 MBEDTLS_SSL_CHK_BUF_PTR(p, end, needed);
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001463
Gilles Peskine449bd832023-01-11 14:50:10 +01001464 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_EARLY_DATA, p, 0);
Jerry Yu52335392023-11-23 18:06:06 +08001465 MBEDTLS_PUT_UINT16_BE(needed - 4, p, 2);
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001466
Jerry Yu52335392023-11-23 18:06:06 +08001467#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yuc59c5862023-12-05 10:40:49 +08001468 if (in_new_session_ticket) {
1469 MBEDTLS_PUT_UINT32_BE(ssl->conf->max_early_data_size, p, 4);
Jerry Yu52335392023-11-23 18:06:06 +08001470 MBEDTLS_SSL_DEBUG_MSG(
1471 4, ("Sent max_early_data_size=%u",
Jerry Yuc59c5862023-12-05 10:40:49 +08001472 (unsigned int) ssl->conf->max_early_data_size));
Jerry Yu52335392023-11-23 18:06:06 +08001473 }
1474#endif
1475
1476 *out_len = needed;
Xiaokang Qian2cd5ce02022-11-15 10:33:53 +00001477
Gilles Peskine449bd832023-01-11 14:50:10 +01001478 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_EARLY_DATA);
Xiaokang Qian2cd5ce02022-11-15 10:33:53 +00001479
Gilles Peskine449bd832023-01-11 14:50:10 +01001480 return 0;
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001481}
Ronald Cron85718042024-02-22 10:22:09 +01001482
1483#if defined(MBEDTLS_SSL_SRV_C)
1484int mbedtls_ssl_tls13_check_early_data_len(mbedtls_ssl_context *ssl,
1485 size_t early_data_len)
1486{
Ronald Cron85718042024-02-22 10:22:09 +01001487 /*
1488 * This function should be called only while an handshake is in progress
1489 * and thus a session under negotiation. Add a sanity check to detect a
1490 * misuse.
1491 */
1492 if (ssl->session_negotiate == NULL) {
1493 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1494 }
1495
1496 /* RFC 8446 section 4.6.1
1497 *
1498 * A server receiving more than max_early_data_size bytes of 0-RTT data
1499 * SHOULD terminate the connection with an "unexpected_message" alert.
Ronald Cron93795f22024-03-07 09:24:56 +01001500 * Note that if it is still possible to send early_data_len bytes of early
1501 * data, it means that early_data_len is smaller than max_early_data_size
1502 * (type uint32_t) and can fit in an uint32_t. We use this further
1503 * down.
Ronald Cron85718042024-02-22 10:22:09 +01001504 */
Ronald Cron2e7dfd52024-03-05 10:54:33 +01001505 if (early_data_len >
Ronald Cron85718042024-02-22 10:22:09 +01001506 (ssl->session_negotiate->max_early_data_size -
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001507 ssl->total_early_data_size)) {
Ronald Cron85718042024-02-22 10:22:09 +01001508
1509 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskineeeb4ff52024-06-03 22:16:23 +02001510 2, ("EarlyData: Too much early data received, "
Gilles Peskine400659b2024-06-04 08:45:58 +02001511 "%lu + %" MBEDTLS_PRINTF_SIZET " > %lu",
1512 (unsigned long) ssl->total_early_data_size,
Gilles Peskineeeb4ff52024-06-03 22:16:23 +02001513 early_data_len,
Gilles Peskine400659b2024-06-04 08:45:58 +02001514 (unsigned long) ssl->session_negotiate->max_early_data_size));
Ronald Cron85718042024-02-22 10:22:09 +01001515
1516 MBEDTLS_SSL_PEND_FATAL_ALERT(
1517 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1518 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE);
1519 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
1520 }
1521
Ronald Cron2e7dfd52024-03-05 10:54:33 +01001522 /*
Ronald Cron93795f22024-03-07 09:24:56 +01001523 * early_data_len has been checked to be less than max_early_data_size
1524 * that is uint32_t. Its cast to an uint32_t below is thus safe. We need
1525 * the cast to appease some compilers.
Ronald Cron2e7dfd52024-03-05 10:54:33 +01001526 */
Ronald Cron2e7dfd52024-03-05 10:54:33 +01001527 ssl->total_early_data_size += (uint32_t) early_data_len;
Ronald Cron85718042024-02-22 10:22:09 +01001528
1529 return 0;
1530}
1531#endif /* MBEDTLS_SSL_SRV_C */
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001532#endif /* MBEDTLS_SSL_EARLY_DATA */
1533
XiaokangQian78b1fa72022-01-19 06:56:30 +00001534/* Reset SSL context and update hash for handling HRR.
1535 *
1536 * Replace Transcript-Hash(X) by
1537 * Transcript-Hash( message_hash ||
1538 * 00 00 Hash.length ||
1539 * X )
1540 * A few states of the handshake are preserved, including:
1541 * - session ID
1542 * - session ticket
1543 * - negotiated ciphersuite
1544 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001545int mbedtls_ssl_reset_transcript_for_hrr(mbedtls_ssl_context *ssl)
XiaokangQian78b1fa72022-01-19 06:56:30 +00001546{
1547 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielda645252022-09-14 12:50:51 +02001548 unsigned char hash_transcript[PSA_HASH_MAX_SIZE + 4];
XiaokangQian0ece9982022-01-24 08:56:23 +00001549 size_t hash_len;
Xiaokang Qian6b980012023-02-07 03:17:45 +00001550 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
1551 ssl->handshake->ciphersuite_info;
XiaokangQian78b1fa72022-01-19 06:56:30 +00001552
Gilles Peskine449bd832023-01-11 14:50:10 +01001553 MBEDTLS_SSL_DEBUG_MSG(3, ("Reset SSL session for HRR"));
XiaokangQian78b1fa72022-01-19 06:56:30 +00001554
Dave Rodgman2eab4622023-10-05 13:30:37 +01001555 ret = mbedtls_ssl_get_handshake_transcript(ssl, (mbedtls_md_type_t) ciphersuite_info->mac,
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 hash_transcript + 4,
1557 PSA_HASH_MAX_SIZE,
1558 &hash_len);
1559 if (ret != 0) {
Manuel Pégourié-Gonnardda7979b2023-02-21 09:31:10 +01001560 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_get_handshake_transcript", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01001561 return ret;
XiaokangQian0ece9982022-01-24 08:56:23 +00001562 }
1563
1564 hash_transcript[0] = MBEDTLS_SSL_HS_MESSAGE_HASH;
1565 hash_transcript[1] = 0;
1566 hash_transcript[2] = 0;
1567 hash_transcript[3] = (unsigned char) hash_len;
1568
1569 hash_len += 4;
1570
Manuel Pégourié-Gonnardda7979b2023-02-21 09:31:10 +01001571 MBEDTLS_SSL_DEBUG_BUF(4, "Truncated handshake transcript",
1572 hash_transcript, hash_len);
1573
Manuel Pégourié-Gonnardd7a7a232023-02-05 10:26:49 +01001574 /* Reset running hash and replace it with a hash of the transcript */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001575 ret = mbedtls_ssl_reset_checksum(ssl);
1576 if (ret != 0) {
1577 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1578 return ret;
1579 }
1580 ret = ssl->handshake->update_checksum(ssl, hash_transcript, hash_len);
1581 if (ret != 0) {
1582 MBEDTLS_SSL_DEBUG_RET(1, "update_checksum", ret);
1583 return ret;
1584 }
Przemyslaw Stekiel4b3fff42022-02-14 16:39:52 +01001585
Gilles Peskine449bd832023-01-11 14:50:10 +01001586 return ret;
XiaokangQian78b1fa72022-01-19 06:56:30 +00001587}
1588
Valerio Settic9ae8622023-07-25 11:23:50 +02001589#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001590
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02001591int mbedtls_ssl_tls13_read_public_xxdhe_share(mbedtls_ssl_context *ssl,
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 const unsigned char *buf,
1593 size_t buf_len)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001594{
Gilles Peskine449bd832023-01-11 14:50:10 +01001595 uint8_t *p = (uint8_t *) buf;
XiaokangQiancfd925f2022-04-14 07:10:37 +00001596 const uint8_t *end = buf + buf_len;
XiaokangQian9b5d04b2022-04-10 10:20:43 +00001597 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001598
XiaokangQian9b5d04b2022-04-10 10:20:43 +00001599 /* Get size of the TLS opaque key_exchange field of the KeyShareEntry struct. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001600 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1601 uint16_t peerkey_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian9b5d04b2022-04-10 10:20:43 +00001602 p += 2;
XiaokangQian3207a322022-02-23 03:15:27 +00001603
XiaokangQian9b5d04b2022-04-10 10:20:43 +00001604 /* Check if key size is consistent with given buffer length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001605 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, peerkey_len);
XiaokangQian9b5d04b2022-04-10 10:20:43 +00001606
Gilles Peskine12c5aaa2023-10-02 14:55:45 +02001607 /* Store peer's ECDH/FFDH public key. */
1608 if (peerkey_len > sizeof(handshake->xxdh_psa_peerkey)) {
Gilles Peskine530c4232023-10-02 15:37:23 +02001609 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid public key length: %u > %" MBEDTLS_PRINTF_SIZET,
1610 (unsigned) peerkey_len,
1611 sizeof(handshake->xxdh_psa_peerkey)));
Gilles Peskine12c5aaa2023-10-02 14:55:45 +02001612 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1613 }
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02001614 memcpy(handshake->xxdh_psa_peerkey, p, peerkey_len);
1615 handshake->xxdh_psa_peerkey_len = peerkey_len;
XiaokangQian9b5d04b2022-04-10 10:20:43 +00001616
Gilles Peskine449bd832023-01-11 14:50:10 +01001617 return 0;
XiaokangQian3207a322022-02-23 03:15:27 +00001618}
Jerry Yu89e103c2022-03-30 22:43:29 +08001619
Valerio Setti711f8532023-07-31 11:28:07 +02001620#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekielda4fba62023-06-02 14:52:28 +02001621static psa_status_t mbedtls_ssl_get_psa_ffdh_info_from_tls_id(
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +02001622 uint16_t tls_id, size_t *bits, psa_key_type_t *key_type)
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001623{
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +02001624 switch (tls_id) {
Valerio Settiecaf7c52024-01-17 12:30:30 +01001625#if defined(PSA_WANT_DH_RFC7919_2048)
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001626 case MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048:
1627 *bits = 2048;
1628 *key_type = PSA_KEY_TYPE_DH_KEY_PAIR(PSA_DH_FAMILY_RFC7919);
1629 return PSA_SUCCESS;
Valerio Settiecaf7c52024-01-17 12:30:30 +01001630#endif /* PSA_WANT_DH_RFC7919_2048 */
1631#if defined(PSA_WANT_DH_RFC7919_3072)
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001632 case MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072:
1633 *bits = 3072;
1634 *key_type = PSA_KEY_TYPE_DH_KEY_PAIR(PSA_DH_FAMILY_RFC7919);
1635 return PSA_SUCCESS;
Valerio Settiecaf7c52024-01-17 12:30:30 +01001636#endif /* PSA_WANT_DH_RFC7919_3072 */
1637#if defined(PSA_WANT_DH_RFC7919_4096)
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001638 case MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096:
1639 *bits = 4096;
1640 *key_type = PSA_KEY_TYPE_DH_KEY_PAIR(PSA_DH_FAMILY_RFC7919);
1641 return PSA_SUCCESS;
Valerio Settiecaf7c52024-01-17 12:30:30 +01001642#endif /* PSA_WANT_DH_RFC7919_4096 */
1643#if defined(PSA_WANT_DH_RFC7919_6144)
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001644 case MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144:
1645 *bits = 6144;
1646 *key_type = PSA_KEY_TYPE_DH_KEY_PAIR(PSA_DH_FAMILY_RFC7919);
1647 return PSA_SUCCESS;
Valerio Settiecaf7c52024-01-17 12:30:30 +01001648#endif /* PSA_WANT_DH_RFC7919_6144 */
1649#if defined(PSA_WANT_DH_RFC7919_8192)
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001650 case MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192:
1651 *bits = 8192;
1652 *key_type = PSA_KEY_TYPE_DH_KEY_PAIR(PSA_DH_FAMILY_RFC7919);
1653 return PSA_SUCCESS;
Valerio Settiecaf7c52024-01-17 12:30:30 +01001654#endif /* PSA_WANT_DH_RFC7919_8192 */
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001655 default:
1656 return PSA_ERROR_NOT_SUPPORTED;
1657 }
1658}
Valerio Setti711f8532023-07-31 11:28:07 +02001659#endif /* PSA_WANT_ALG_FFDH */
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001660
Przemek Stekiel408569f2023-07-06 11:26:44 +02001661int mbedtls_ssl_tls13_generate_and_write_xxdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01001662 mbedtls_ssl_context *ssl,
1663 uint16_t named_group,
1664 unsigned char *buf,
1665 unsigned char *end,
1666 size_t *out_len)
Jerry Yu89e103c2022-03-30 22:43:29 +08001667{
1668 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
1669 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1670 psa_key_attributes_t key_attributes;
1671 size_t own_pubkey_len;
1672 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001673 size_t bits = 0;
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +02001674 psa_key_type_t key_type = PSA_KEY_TYPE_NONE;
1675 psa_algorithm_t alg = PSA_ALG_NONE;
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001676 size_t buf_size = (size_t) (end - buf);
Jerry Yu89e103c2022-03-30 22:43:29 +08001677
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001678 MBEDTLS_SSL_DEBUG_MSG(1, ("Perform PSA-based ECDH/FFDH computation."));
Jerry Yu89e103c2022-03-30 22:43:29 +08001679
Valerio Setti40d9ca92023-01-04 16:08:04 +01001680 /* Convert EC's TLS ID to PSA key type. */
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001681#if defined(PSA_WANT_ALG_ECDH)
Xiaokang Qian73437382023-03-29 08:24:12 +00001682 if (mbedtls_ssl_get_psa_curve_info_from_tls_id(
Przemek Stekielda4fba62023-06-02 14:52:28 +02001683 named_group, &key_type, &bits) == PSA_SUCCESS) {
1684 alg = PSA_ALG_ECDH;
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001685 }
1686#endif
1687#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +02001688 if (mbedtls_ssl_get_psa_ffdh_info_from_tls_id(named_group, &bits,
1689 &key_type) == PSA_SUCCESS) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02001690 alg = PSA_ALG_FFDH;
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001691 }
1692#endif
1693
Przemek Stekiel75a5a9c2023-06-12 11:21:18 +02001694 if (key_type == PSA_KEY_TYPE_NONE) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001695 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Valerio Setti40d9ca92023-01-04 16:08:04 +01001696 }
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001697
Przemek Stekielda4fba62023-06-02 14:52:28 +02001698 if (buf_size < PSA_BITS_TO_BYTES(bits)) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02001699 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
1700 }
1701
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02001702 handshake->xxdh_psa_type = key_type;
Valerio Settiea59c432023-07-25 11:14:03 +02001703 ssl->handshake->xxdh_psa_bits = bits;
Jerry Yu89e103c2022-03-30 22:43:29 +08001704
1705 key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01001706 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Przemek Stekielda4fba62023-06-02 14:52:28 +02001707 psa_set_key_algorithm(&key_attributes, alg);
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02001708 psa_set_key_type(&key_attributes, handshake->xxdh_psa_type);
Valerio Settiea59c432023-07-25 11:14:03 +02001709 psa_set_key_bits(&key_attributes, handshake->xxdh_psa_bits);
Jerry Yu89e103c2022-03-30 22:43:29 +08001710
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001711 /* Generate ECDH/FFDH private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 status = psa_generate_key(&key_attributes,
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02001713 &handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01001714 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001715 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001716 MBEDTLS_SSL_DEBUG_RET(1, "psa_generate_key", ret);
1717 return ret;
Jerry Yu89e103c2022-03-30 22:43:29 +08001718
1719 }
1720
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001721 /* Export the public part of the ECDH/FFDH private key from PSA. */
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02001722 status = psa_export_public_key(handshake->xxdh_psa_privkey,
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001723 buf, buf_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001724 &own_pubkey_len);
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001725
Gilles Peskine449bd832023-01-11 14:50:10 +01001726 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05001727 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01001728 MBEDTLS_SSL_DEBUG_RET(1, "psa_export_public_key", ret);
1729 return ret;
Jerry Yu89e103c2022-03-30 22:43:29 +08001730 }
1731
1732 *out_len = own_pubkey_len;
1733
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 return 0;
Jerry Yu89e103c2022-03-30 22:43:29 +08001735}
Valerio Settic9ae8622023-07-25 11:23:50 +02001736#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001737
Jerry Yu0c354a22022-08-29 15:25:36 +08001738/* RFC 8446 section 4.2
1739 *
1740 * If an implementation receives an extension which it recognizes and which is
1741 * not specified for the message in which it appears, it MUST abort the handshake
1742 * with an "illegal_parameter" alert.
1743 *
1744 */
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001745int mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 mbedtls_ssl_context *ssl,
1747 int hs_msg_type,
1748 unsigned int received_extension_type,
1749 uint32_t hs_msg_allowed_extensions_mask)
Jerry Yu0c354a22022-08-29 15:25:36 +08001750{
Jerry Yudf0ad652022-10-31 13:20:57 +08001751 uint32_t extension_mask = mbedtls_ssl_get_extension_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 received_extension_type);
Jerry Yu0c354a22022-08-29 15:25:36 +08001753
Jerry Yu79aa7212022-11-08 21:30:21 +08001754 MBEDTLS_SSL_PRINT_EXT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 3, hs_msg_type, received_extension_type, "received");
Jerry Yu0c354a22022-08-29 15:25:36 +08001756
Gilles Peskine449bd832023-01-11 14:50:10 +01001757 if ((extension_mask & hs_msg_allowed_extensions_mask) == 0) {
Jerry Yu79aa7212022-11-08 21:30:21 +08001758 MBEDTLS_SSL_PRINT_EXT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001759 3, hs_msg_type, received_extension_type, "is illegal");
Jerry Yu0c354a22022-08-29 15:25:36 +08001760 MBEDTLS_SSL_PEND_FATAL_ALERT(
1761 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1763 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu0c354a22022-08-29 15:25:36 +08001764 }
1765
1766 ssl->handshake->received_extensions |= extension_mask;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001767 /*
1768 * If it is a message containing extension responses, check that we
1769 * previously sent the extension.
1770 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001771 switch (hs_msg_type) {
Jerry Yu0c354a22022-08-29 15:25:36 +08001772 case MBEDTLS_SSL_HS_SERVER_HELLO:
Jerry Yudf0ad652022-10-31 13:20:57 +08001773 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Jerry Yu0c354a22022-08-29 15:25:36 +08001774 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
1775 case MBEDTLS_SSL_HS_CERTIFICATE:
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001776 /* Check if the received extension is sent by peer message.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01001777 if ((ssl->handshake->sent_extensions & extension_mask) != 0) {
1778 return 0;
1779 }
Jerry Yu0c354a22022-08-29 15:25:36 +08001780 break;
1781 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001782 return 0;
Jerry Yu0c354a22022-08-29 15:25:36 +08001783 }
1784
Jerry Yu79aa7212022-11-08 21:30:21 +08001785 MBEDTLS_SSL_PRINT_EXT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001786 3, hs_msg_type, received_extension_type, "is unsupported");
Jerry Yu0c354a22022-08-29 15:25:36 +08001787 MBEDTLS_SSL_PEND_FATAL_ALERT(
1788 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
Gilles Peskine449bd832023-01-11 14:50:10 +01001789 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION);
1790 return MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
Jerry Yu0c354a22022-08-29 15:25:36 +08001791}
1792
Jan Bruckner151f6422023-02-10 12:45:19 +01001793#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Yanray Wangfaf70bd2023-12-07 10:03:32 +08001794
1795/* RFC 8449, section 4:
1796 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001797 * The ExtensionData of the "record_size_limit" extension is
1798 * RecordSizeLimit:
1799 * uint16 RecordSizeLimit;
1800 */
1801MBEDTLS_CHECK_RETURN_CRITICAL
1802int mbedtls_ssl_tls13_parse_record_size_limit_ext(mbedtls_ssl_context *ssl,
1803 const unsigned char *buf,
1804 const unsigned char *end)
1805{
Jan Bruckner1a38e542023-03-15 14:15:11 +01001806 const unsigned char *p = buf;
1807 uint16_t record_size_limit;
Jan Brucknera0589e72023-03-15 11:04:45 +01001808 const size_t extension_data_len = end - buf;
Jan Bruckner1a38e542023-03-15 14:15:11 +01001809
Xiaokang Qian73437382023-03-29 08:24:12 +00001810 if (extension_data_len !=
1811 MBEDTLS_SSL_RECORD_SIZE_LIMIT_EXTENSION_DATA_LENGTH) {
Jan Bruckner151f6422023-02-10 12:45:19 +01001812 MBEDTLS_SSL_DEBUG_MSG(2,
Jan Bruckner1a38e542023-03-15 14:15:11 +01001813 ("record_size_limit extension has invalid length: %"
1814 MBEDTLS_PRINTF_SIZET " Bytes",
Jan Bruckner151f6422023-02-10 12:45:19 +01001815 extension_data_len));
1816
1817 MBEDTLS_SSL_PEND_FATAL_ALERT(
1818 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1819 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1820 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1821 }
1822
Jan Bruckner151f6422023-02-10 12:45:19 +01001823 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
1824 record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
1825
1826 MBEDTLS_SSL_DEBUG_MSG(2, ("RecordSizeLimit: %u Bytes", record_size_limit));
1827
Waleed Elmelegye1ac98d2024-01-05 18:10:12 +00001828 /* RFC 8449, section 4:
1829 *
1830 * Endpoints MUST NOT send a "record_size_limit" extension with a value
1831 * smaller than 64. An endpoint MUST treat receipt of a smaller value
1832 * as a fatal error and generate an "illegal_parameter" alert.
1833 */
1834 if (record_size_limit < MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN) {
1835 MBEDTLS_SSL_DEBUG_MSG(1, ("Invalid record size limit : %u Bytes",
1836 record_size_limit));
1837 MBEDTLS_SSL_PEND_FATAL_ALERT(
1838 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1839 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1840 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jan Bruckner151f6422023-02-10 12:45:19 +01001841 }
1842
Jan Brucknerf482dcc2023-03-15 09:09:06 +01001843 ssl->session_negotiate->record_size_limit = record_size_limit;
Jan Bruckner151f6422023-02-10 12:45:19 +01001844
Jan Brucknerf482dcc2023-03-15 09:09:06 +01001845 return 0;
Jan Bruckner151f6422023-02-10 12:45:19 +01001846}
Jan Brucknerf482dcc2023-03-15 09:09:06 +01001847
Yanray Wangfaf70bd2023-12-07 10:03:32 +08001848MBEDTLS_CHECK_RETURN_CRITICAL
1849int mbedtls_ssl_tls13_write_record_size_limit_ext(mbedtls_ssl_context *ssl,
Yanray Wangfaf70bd2023-12-07 10:03:32 +08001850 unsigned char *buf,
1851 const unsigned char *end,
1852 size_t *out_len)
1853{
Yanray Wangfaf70bd2023-12-07 10:03:32 +08001854 unsigned char *p = buf;
1855 *out_len = 0;
1856
Waleed Elmelegy148dfb62024-01-04 18:02:35 +00001857 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_IN_CONTENT_LEN >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN,
Waleed Elmelegye1ac98d2024-01-05 18:10:12 +00001858 "MBEDTLS_SSL_IN_CONTENT_LEN is less than the "
1859 "minimum record size limit");
Yanray Wangfaf70bd2023-12-07 10:03:32 +08001860
1861 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
1862
1863 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT, p, 0);
Waleed Elmelegye1ac98d2024-01-05 18:10:12 +00001864 MBEDTLS_PUT_UINT16_BE(MBEDTLS_SSL_RECORD_SIZE_LIMIT_EXTENSION_DATA_LENGTH,
1865 p, 2);
Waleed Elmelegy148dfb62024-01-04 18:02:35 +00001866 MBEDTLS_PUT_UINT16_BE(MBEDTLS_SSL_IN_CONTENT_LEN, p, 4);
Yanray Wangfaf70bd2023-12-07 10:03:32 +08001867
1868 *out_len = 6;
1869
Waleed Elmelegy3ff47242024-01-10 16:15:52 +00001870 MBEDTLS_SSL_DEBUG_MSG(2, ("Sent RecordSizeLimit: %d Bytes",
Waleed Elmelegye1ac98d2024-01-05 18:10:12 +00001871 MBEDTLS_SSL_IN_CONTENT_LEN));
Yanray Wangfaf70bd2023-12-07 10:03:32 +08001872
1873 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT);
1874
1875 return 0;
1876}
1877
Jan Bruckner151f6422023-02-10 12:45:19 +01001878#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
1879
Jerry Yufb4b6472022-01-27 15:03:26 +08001880#endif /* MBEDTLS_SSL_TLS_C && MBEDTLS_SSL_PROTO_TLS1_3 */