blob: 3794d388de4ecf93e9472be55b84f3f56bd4ce4b [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * 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
Paul Bakker5121ce52009-01-03 21:22:43 +00006 */
7/*
Paul Bakker5121ce52009-01-03 21:22:43 +00008 * http://www.ietf.org/rfc/rfc2246.txt
9 * http://www.ietf.org/rfc/rfc4346.txt
10 */
11
Harry Ramsey0f6bc412024-10-04 10:36:54 +010012#include "ssl_misc.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020014#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000015
SimonBd5800b72016-04-26 07:43:27 +010016#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010017
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000018#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010019#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010020#include "ssl_debug_helpers.h"
Max Fillingerbd81c9d2024-07-22 14:43:56 +020021#include "ssl_tls13_keys.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040022
Valerio Settib4f50762024-01-17 10:24:52 +010023#include "debug_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000024#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050025#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010026#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020027#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020028
Rich Evans00ab4702015-02-06 13:43:58 +000029#include <string.h>
30
Valerio Setti384fbde2024-01-02 13:26:40 +010031#include "mbedtls/psa_util.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020032#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020033#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050034#include "psa/crypto.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050035
Janos Follath23bdca02016-10-07 14:47:14 +010036#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000037#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020038#endif
39
Andrzej Kurek00644842023-05-30 05:45:00 -040040/* Define local translating functions to save code size by not using too many
41 * arguments in each translating place. */
42static int local_err_translation(psa_status_t status)
43{
44 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040045 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040046 psa_generic_status_to_mbedtls);
47}
48#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050049
Ronald Cronad8c17b2022-06-10 17:18:09 +020050#if defined(MBEDTLS_TEST_HOOKS)
51static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
52
53void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010054 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020055{
56 chk_buf_ptr_fail_args.cur = cur;
57 chk_buf_ptr_fail_args.end = end;
58 chk_buf_ptr_fail_args.need = need;
59}
60
Gilles Peskine449bd832023-01-11 14:50:10 +010061void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020062{
Gilles Peskine449bd832023-01-11 14:50:10 +010063 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020064}
65
Gilles Peskine449bd832023-01-11 14:50:10 +010066int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020067{
Gilles Peskine449bd832023-01-11 14:50:10 +010068 return (chk_buf_ptr_fail_args.cur != args->cur) ||
69 (chk_buf_ptr_fail_args.end != args->end) ||
70 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020071}
72#endif /* MBEDTLS_TEST_HOOKS */
73
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020074#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010075
Hanno Beckera0e20d02019-05-15 14:03:01 +010076#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010077/* Top-level Connection ID API */
78
Gilles Peskine449bd832023-01-11 14:50:10 +010079int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
80 size_t len,
81 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010082{
Gilles Peskine449bd832023-01-11 14:50:10 +010083 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
84 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
85 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010086
Gilles Peskine449bd832023-01-11 14:50:10 +010087 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
88 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
89 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010090 }
91
92 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010093 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010094 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010095}
96
Gilles Peskine449bd832023-01-11 14:50:10 +010097int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
98 int enable,
99 unsigned char const *own_cid,
100 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100101{
Gilles Peskine449bd832023-01-11 14:50:10 +0100102 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
103 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
104 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100105
Hanno Beckerca092242019-04-25 16:01:49 +0100106 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100107 if (enable == MBEDTLS_SSL_CID_DISABLED) {
108 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
109 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100110 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100111 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
112 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100113
Gilles Peskine449bd832023-01-11 14:50:10 +0100114 if (own_cid_len != ssl->conf->cid_len) {
115 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
116 (unsigned) own_cid_len,
117 (unsigned) ssl->conf->cid_len));
118 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100119 }
120
Gilles Peskine449bd832023-01-11 14:50:10 +0100121 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100122 /* Truncation is not an issue here because
123 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
124 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100125
Gilles Peskine449bd832023-01-11 14:50:10 +0100126 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100127}
128
Gilles Peskine449bd832023-01-11 14:50:10 +0100129int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
130 int *enabled,
Sam Berry3504c882024-06-11 14:34:17 +0100131 unsigned char own_cid[MBEDTLS_SSL_CID_IN_LEN_MAX],
Gilles Peskine449bd832023-01-11 14:50:10 +0100132 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000133{
134 *enabled = MBEDTLS_SSL_CID_DISABLED;
135
Gilles Peskine449bd832023-01-11 14:50:10 +0100136 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
137 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
138 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000139
140 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
141 * zero as this is indistinguishable from not requesting to use
142 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100143 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
144 return 0;
145 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000146
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000148 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100149 if (own_cid != NULL) {
150 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
151 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000152 }
153
154 *enabled = MBEDTLS_SSL_CID_ENABLED;
155
Gilles Peskine449bd832023-01-11 14:50:10 +0100156 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000157}
158
Gilles Peskine449bd832023-01-11 14:50:10 +0100159int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
160 int *enabled,
161 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
162 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100163{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100164 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100165
Gilles Peskine449bd832023-01-11 14:50:10 +0100166 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
167 mbedtls_ssl_is_handshake_over(ssl) == 0) {
168 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100169 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100170
Hanno Beckerc5f24222019-05-03 12:54:52 +0100171 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
172 * were used, but client and server requested the empty CID.
173 * This is indistinguishable from not using the CID extension
174 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100175 if (ssl->transform_in->in_cid_len == 0 &&
176 ssl->transform_in->out_cid_len == 0) {
177 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100178 }
179
Gilles Peskine449bd832023-01-11 14:50:10 +0100180 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100181 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100182 if (peer_cid != NULL) {
183 memcpy(peer_cid, ssl->transform_in->out_cid,
184 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100185 }
186 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100187
188 *enabled = MBEDTLS_SSL_CID_ENABLED;
189
Gilles Peskine449bd832023-01-11 14:50:10 +0100190 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100191}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100192#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100193
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200194#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200195
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200196#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200197/*
198 * Convert max_fragment_length codes to length.
199 * RFC 6066 says:
200 * enum{
201 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
202 * } MaxFragmentLength;
203 * and we add 0 -> extension unused
204 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100205static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200206{
Gilles Peskine449bd832023-01-11 14:50:10 +0100207 switch (mfl) {
208 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
209 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
210 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
211 return 512;
212 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
213 return 1024;
214 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
215 return 2048;
216 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
217 return 4096;
218 default:
219 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000220 }
221}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200222#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200223
Gilles Peskine449bd832023-01-11 14:50:10 +0100224int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
225 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200226{
Gilles Peskine449bd832023-01-11 14:50:10 +0100227 mbedtls_ssl_session_free(dst);
228 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800229#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
230 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000231#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
232 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000233 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800234#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000235#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800236
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000237#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
238 defined(MBEDTLS_SSL_EARLY_DATA)
239 dst->ticket_alpn = NULL;
240#endif
241
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200242#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000243
244#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100245 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000246 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200247
Gilles Peskine449bd832023-01-11 14:50:10 +0100248 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
249 if (dst->peer_cert == NULL) {
250 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
251 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200252
Gilles Peskine449bd832023-01-11 14:50:10 +0100253 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200254
Gilles Peskine449bd832023-01-11 14:50:10 +0100255 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
256 src->peer_cert->raw.len)) != 0) {
257 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200258 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100259 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200260 }
261 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000262#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000264 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100265 mbedtls_calloc(1, src->peer_cert_digest_len);
266 if (dst->peer_cert_digest == NULL) {
267 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
268 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000269
Gilles Peskine449bd832023-01-11 14:50:10 +0100270 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
271 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000272 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000273 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000274 }
275#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
276
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200277#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200278
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000279#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
280 defined(MBEDTLS_SSL_EARLY_DATA)
281 {
282 int ret = mbedtls_ssl_session_set_ticket_alpn(dst, src->ticket_alpn);
283 if (ret != 0) {
284 return ret;
285 }
286 }
287#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_ALPN && MBEDTLS_SSL_EARLY_DATA */
288
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200289#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100290 if (src->ticket != NULL) {
291 dst->ticket = mbedtls_calloc(1, src->ticket_len);
292 if (dst->ticket == NULL) {
293 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
294 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200295
Gilles Peskine449bd832023-01-11 14:50:10 +0100296 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200297 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000298
299#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
300 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000302 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100303 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
304 if (ret != 0) {
305 return ret;
306 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000307 }
308#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
309 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200310#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200311
Gilles Peskine449bd832023-01-11 14:50:10 +0100312 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200313}
314
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500315#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200316MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100317static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500318{
Gilles Peskine449bd832023-01-11 14:50:10 +0100319 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
320 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800321 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100322 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500323
324 /* We want to copy len_new bytes when downsizing the buffer, and
325 * len_old bytes when upsizing, so we choose the smaller of two sizes,
326 * to fit one buffer into another. Size checks, ensuring that no data is
327 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100328 memcpy(resized_buffer, *buffer,
329 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100330 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500331
332 *buffer = resized_buffer;
333 *len_old = len_new;
334
335 return 0;
336}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200337
Gilles Peskine449bd832023-01-11 14:50:10 +0100338static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
339 size_t in_buf_new_len,
340 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200341{
342 int modified = 0;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000343 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0, hdr_in = 0;
Andrzej Kurek4a063792020-10-21 15:08:44 +0200344 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200346 written_in = ssl->in_msg - ssl->in_buf;
347 iv_offset_in = ssl->in_iv - ssl->in_buf;
348 len_offset_in = ssl->in_len - ssl->in_buf;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000349 hdr_in = ssl->in_hdr - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200351 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100352 ssl->in_buf_len < in_buf_new_len) {
353 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
354 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
355 } else {
356 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
357 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200358 modified = 1;
359 }
360 }
361 }
362
Gilles Peskine449bd832023-01-11 14:50:10 +0100363 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200364 written_out = ssl->out_msg - ssl->out_buf;
365 iv_offset_out = ssl->out_iv - ssl->out_buf;
366 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100367 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200368 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100369 ssl->out_buf_len < out_buf_new_len) {
370 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
371 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
372 } else {
373 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
374 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200375 modified = 1;
376 }
377 }
378 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100379 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200380 /* Update pointers here to avoid doing it twice. */
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000381 ssl->in_hdr = ssl->in_buf + hdr_in;
382 mbedtls_ssl_update_in_pointers(ssl);
383 mbedtls_ssl_reset_out_pointers(ssl);
384
Andrzej Kurek4a063792020-10-21 15:08:44 +0200385 /* Fields below might not be properly updated with record
386 * splitting or with CID, so they are manually updated here. */
387 ssl->out_msg = ssl->out_buf + written_out;
388 ssl->out_len = ssl->out_buf + len_offset_out;
389 ssl->out_iv = ssl->out_buf + iv_offset_out;
390
391 ssl->in_msg = ssl->in_buf + written_in;
392 ssl->in_len = ssl->in_buf + len_offset_in;
393 ssl->in_iv = ssl->in_buf + iv_offset_in;
394 }
395}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500396#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
397
Jerry Yudb8c48a2022-01-27 14:54:54 +0800398#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800399
400#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100401typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
402 const char *label,
403 const unsigned char *random, size_t rlen,
404 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800405
Gilles Peskine449bd832023-01-11 14:50:10 +0100406static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800407
408#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
409
410/* Type for the TLS PRF */
411typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
412 const unsigned char *, size_t,
413 unsigned char *, size_t);
414
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200415MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100416static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
417 int ciphersuite,
418 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200419#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200421#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100422 ssl_tls_prf_t tls_prf,
423 const unsigned char randbytes[64],
424 mbedtls_ssl_protocol_version tls_version,
425 unsigned endpoint,
426 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800427
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100428#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200429MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100430static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300431 const char *label,
432 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100434static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
435static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100436
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100437#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100438
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100439#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100440MBEDTLS_CHECK_RETURN_CRITICAL
441static int tls_prf_sha384(const unsigned char *secret, size_t slen,
442 const char *label,
443 const unsigned char *random, size_t rlen,
444 unsigned char *dstbuf, size_t dlen);
445
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100446static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
447static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100448#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100449
Gilles Peskine449bd832023-01-11 14:50:10 +0100450MBEDTLS_CHECK_RETURN_CRITICAL
451static int ssl_tls12_session_load(mbedtls_ssl_session *session,
452 const unsigned char *buf,
453 size_t len);
454#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
455
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100456static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100457
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100458#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100459static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100460#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100461
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100462#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100463static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100464#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100465
466int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
467 const unsigned char *secret, size_t slen,
468 const char *label,
469 const unsigned char *random, size_t rlen,
470 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300471{
472 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
473
Gilles Peskine449bd832023-01-11 14:50:10 +0100474 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300475#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100476#if defined(PSA_WANT_ALG_SHA_384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477 case MBEDTLS_SSL_TLS_PRF_SHA384:
478 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 break;
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100480#endif /* PSA_WANT_ALG_SHA_384*/
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100481#if defined(PSA_WANT_ALG_SHA_256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300482 case MBEDTLS_SSL_TLS_PRF_SHA256:
483 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100484 break;
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100485#endif /* PSA_WANT_ALG_SHA_256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300486#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 default:
488 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300489 }
490
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300492}
493
Jerry Yuc73c6182022-02-08 20:29:25 +0800494#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100495static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800496{
497#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100498 if (session->peer_cert != NULL) {
499 mbedtls_x509_crt_free(session->peer_cert);
500 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800501 session->peer_cert = NULL;
502 }
503#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100504 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800505 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100506 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800507 session->peer_cert_digest = NULL;
508 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
509 session->peer_cert_digest_len = 0;
510 }
511#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
512}
513#endif /* MBEDTLS_X509_CRT_PARSE_C */
514
Gilles Peskine449bd832023-01-11 14:50:10 +0100515uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800516{
Gilles Peskine449bd832023-01-11 14:50:10 +0100517 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800518 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800520
521 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800523
524 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800526
527 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
581 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800583
584 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800586
587 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800589
590 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100591 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800592
593 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800595
Jan Bruckner151f6422023-02-10 12:45:19 +0100596 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
597 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
598
Jerry Yu7a485c12022-10-31 13:08:18 +0800599 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100600 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800601
602 }
603
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800605}
606
Gilles Peskine449bd832023-01-11 14:50:10 +0100607uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800608{
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800610}
611
Jerry Yud25cab02022-10-31 12:48:30 +0800612#if defined(MBEDTLS_DEBUG_C)
613static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800614 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800615 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
616 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
617 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
618 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
619 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
620 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
621 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
622 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
623 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
624 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
625 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
626 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
627 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
628 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
629 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
630 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
631 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
632 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
633 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
634 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
635 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
636 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
637 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
638 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
639 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
640 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100641 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
642 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800643};
644
Chien Wong4e9683e2023-12-28 17:07:43 +0800645static const unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800646 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
647 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
648 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
649 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
650 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
651 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
652 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
653 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
654 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
655 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
656 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
657 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
658 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
659 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
660 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
661 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
662 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
663 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
664 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
665 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
666 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
667 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
668 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
669 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
670 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
671 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
672 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100673 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
674 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800675};
676
Gilles Peskine449bd832023-01-11 14:50:10 +0100677const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800678{
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 return extension_name_table[
680 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800681}
682
Gilles Peskine449bd832023-01-11 14:50:10 +0100683static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800684{
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800686 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800688 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800690 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100691 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800692 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100693 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800694 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800696 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100697 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800698 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800700 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800702}
703
Gilles Peskine449bd832023-01-11 14:50:10 +0100704void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
705 int level, const char *file, int line,
706 int hs_msg_type, unsigned int extension_type,
707 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800708{
709 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800711 mbedtls_debug_print_msg(
712 ssl, level, file, line,
713 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100714 ssl_tls13_get_hs_msg_name(hs_msg_type),
715 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800716 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800718 return;
719 }
720
721 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100722 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800723 mbedtls_debug_print_msg(
724 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100725 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
726 mbedtls_ssl_get_extension_name(extension_type), extension_type,
727 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800728 return;
729 }
730
731 mbedtls_debug_print_msg(
732 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
734 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800735}
736
Gilles Peskine449bd832023-01-11 14:50:10 +0100737void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
738 int level, const char *file, int line,
739 int hs_msg_type, uint32_t extensions_mask,
740 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800741{
742
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 for (unsigned i = 0;
744 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
745 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800746 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800747 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100748 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800749 }
750}
751
Pengyu Lvee455c02023-01-12 14:37:24 +0800752#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800753static const char *ticket_flag_name_table[] =
754{
755 [0] = "ALLOW_PSK_RESUMPTION",
756 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
757 [3] = "ALLOW_EARLY_DATA",
758};
759
Pengyu Lv4938a562023-01-16 11:28:49 +0800760void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
761 int level, const char *file, int line,
762 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800763{
764 size_t i;
765
766 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800767 "print ticket_flags (0x%02x)", flags);
768
769 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800770
771 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800772 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800773 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
774 ticket_flag_name_table[i]);
775 }
776 }
777}
778#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
779
Jerry Yud25cab02022-10-31 12:48:30 +0800780#endif /* MBEDTLS_DEBUG_C */
781
Gilles Peskine449bd832023-01-11 14:50:10 +0100782void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
783 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800784{
785 ((void) ciphersuite_info);
786
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100787#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100788 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800789 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800791#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100792#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800794 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800796#endif
797 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800799 return;
800 }
801}
802
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100803int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100804 unsigned hs_type,
805 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100806{
807 unsigned char hs_hdr[4];
808
809 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
811 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
812 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
813 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100814
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100815 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100816}
817
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100818int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100819 unsigned hs_type,
820 unsigned char const *msg,
821 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100822{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100823 int ret;
824 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100825 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100826 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100827 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100828 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100829}
830
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100831int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800832{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100833#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100834 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100835 psa_status_t status;
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100836#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800837 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100838#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100839#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100840 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
841 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200842 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100843 }
844 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
845 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200846 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100847 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800848#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100849#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100850 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
851 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200852 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100853 }
854 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
855 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200856 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100857 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800858#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100859 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800860}
861
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100862static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100863 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800864{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100865#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100866 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100867 psa_status_t status;
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100868#else /* SHA-256 or SHA-384 */
869 ((void) ssl);
870 (void) buf;
871 (void) len;
872#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100873#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100874 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
875 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200876 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100877 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800878#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100879#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100880 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
881 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200882 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100883 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800884#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100885 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800886}
887
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100888#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100889static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100890 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800891{
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200892 return mbedtls_md_error_from_psa(psa_hash_update(
893 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800894}
895#endif
896
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100897#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100898static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100899 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800900{
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200901 return mbedtls_md_error_from_psa(psa_hash_update(
902 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800903}
904#endif
905
Gilles Peskine449bd832023-01-11 14:50:10 +0100906static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200907{
Gilles Peskine449bd832023-01-11 14:50:10 +0100908 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200909
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100910#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500911 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500912#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100913#if defined(PSA_WANT_ALG_SHA_384)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500914 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500915#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200916
917 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100918
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200919#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200920 handshake->psa_pake_ctx = psa_pake_operation_init();
921 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200922#if defined(MBEDTLS_SSL_CLI_C)
923 handshake->ecjpake_cache = NULL;
924 handshake->ecjpake_cache_len = 0;
925#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200926#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200927
Gilles Peskineeccd8882020-03-10 12:19:08 +0100928#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100929 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200930#endif
931
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200932#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
933 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
934#endif
Hanno Becker75173122019-02-06 16:18:31 +0000935
936#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
937 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100938 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +0000939#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200940}
941
Gilles Peskine449bd832023-01-11 14:50:10 +0100942void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200943{
Gilles Peskine449bd832023-01-11 14:50:10 +0100944 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +0200945
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100946 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
947 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100948
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000949#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100950 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
951 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100952#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200953}
954
Gilles Peskine449bd832023-01-11 14:50:10 +0100955void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200956{
Gilles Peskine449bd832023-01-11 14:50:10 +0100957 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200958}
959
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200960MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100961static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +0000962{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100963 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
964
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200965 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +0800966#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +0100967 if (ssl->transform_negotiate) {
968 mbedtls_ssl_transform_free(ssl->transform_negotiate);
969 }
Jerry Yu2e199812022-12-01 18:57:19 +0800970#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100971 if (ssl->session_negotiate) {
972 mbedtls_ssl_session_free(ssl->session_negotiate);
973 }
974 if (ssl->handshake) {
975 mbedtls_ssl_handshake_free(ssl);
976 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200977
Jerry Yu2e199812022-12-01 18:57:19 +0800978#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200979 /*
980 * Either the pointers are now NULL or cleared properly and can be freed.
981 * Now allocate missing structures.
982 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 if (ssl->transform_negotiate == NULL) {
984 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200985 }
Jerry Yu2e199812022-12-01 18:57:19 +0800986#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000987
Gilles Peskine449bd832023-01-11 14:50:10 +0100988 if (ssl->session_negotiate == NULL) {
989 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200990 }
Paul Bakker48916f92012-09-16 19:57:18 +0000991
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 if (ssl->handshake == NULL) {
993 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200994 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500995#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
996 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400997
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
999 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001000#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001001
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001002 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001003 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001004#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001005 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001006#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 ssl->session_negotiate == NULL) {
1008 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001009
Gilles Peskine449bd832023-01-11 14:50:10 +01001010 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001011 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001012
1013#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001014 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001015 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001016#endif
1017
Gilles Peskine449bd832023-01-11 14:50:10 +01001018 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001019 ssl->session_negotiate = NULL;
1020
Gilles Peskine449bd832023-01-11 14:50:10 +01001021 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001022 }
1023
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001024#if defined(MBEDTLS_SSL_EARLY_DATA)
1025#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001026 ssl->early_data_state = MBEDTLS_SSL_EARLY_DATA_STATE_IDLE;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001027#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001028#if defined(MBEDTLS_SSL_SRV_C)
1029 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1030#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001031 ssl->total_early_data_size = 0;
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001032#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001033
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001034 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001035 mbedtls_ssl_session_init(ssl->session_negotiate);
1036 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001037
Jerry Yu2e199812022-12-01 18:57:19 +08001038#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001039 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001040#endif
1041
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001042 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001043 ret = mbedtls_ssl_reset_checksum(ssl);
1044 if (ret != 0) {
1045 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1046 return ret;
1047 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001048
Jerry Yud0766ec2022-09-22 10:46:57 +08001049#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1050 defined(MBEDTLS_SSL_SRV_C) && \
1051 defined(MBEDTLS_SSL_SESSION_TICKETS)
1052 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001053 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001054#endif
1055
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001056#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001057 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001058 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001059
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001061 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001062 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001063 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001065
Gilles Peskine449bd832023-01-11 14:50:10 +01001066 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001067 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001068#endif
1069
Ronald Crone68ab4f2022-10-05 12:46:29 +02001070#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001071#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001072#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001073 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1074 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1076 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001077 const int *md;
1078 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001079 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001080 uint16_t *p;
1081
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001082 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1083 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1084 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1087 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001088 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001089 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001090#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001092#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001093
Jerry Yub476a442022-01-21 18:14:45 +08001094#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001096#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1098 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1099 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001100 }
1101
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1103 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1104 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001105
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1107 sizeof(uint16_t));
1108 if (ssl->handshake->sig_algs == NULL) {
1109 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1110 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001111
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 p = (uint16_t *) ssl->handshake->sig_algs;
1113 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1114 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1115 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001116 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001118#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001120 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001121#endif
1122#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001124 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001125#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001126 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001127 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001128 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001130#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001131 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001132 ssl->handshake->sig_algs_heap_allocated = 0;
1133 }
Jerry Yucc539102022-06-27 16:27:35 +08001134#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001135#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001137}
1138
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001139#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001140/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001141MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001142static int ssl_cookie_write_dummy(void *ctx,
1143 unsigned char **p, unsigned char *end,
1144 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001145{
1146 ((void) ctx);
1147 ((void) p);
1148 ((void) end);
1149 ((void) cli_id);
1150 ((void) cli_id_len);
1151
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001153}
1154
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001155MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001156static int ssl_cookie_check_dummy(void *ctx,
1157 const unsigned char *cookie, size_t cookie_len,
1158 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001159{
1160 ((void) ctx);
1161 ((void) cookie);
1162 ((void) cookie_len);
1163 ((void) cli_id);
1164 ((void) cli_id_len);
1165
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001167}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001168#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001169
Paul Bakker5121ce52009-01-03 21:22:43 +00001170/*
1171 * Initialize an SSL context
1172 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001173void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001174{
Gilles Peskine449bd832023-01-11 14:50:10 +01001175 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001176}
1177
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001178MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001179static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001180{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001181 const mbedtls_ssl_config *conf = ssl->conf;
1182
Ronald Cron6f135e12021-12-08 16:57:54 +01001183#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001184 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1185 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1186 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1187 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001188 }
1189
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1191 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001192 }
1193#endif
1194
1195#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001196 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1197 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1198 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001199 }
1200#endif
1201
Ronald Cron6f135e12021-12-08 16:57:54 +01001202#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001203 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1204 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1205 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1206 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001207 }
1208
Gilles Peskine449bd832023-01-11 14:50:10 +01001209 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1210 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001211 }
1212#endif
1213
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1215 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001216}
1217
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001218MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001219static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1220{
1221 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001222 ret = ssl_conf_version_check(ssl);
1223 if (ret != 0) {
1224 return ret;
1225 }
Jerry Yu60835a82021-08-04 10:13:52 +08001226
1227 /* Space for further checks */
1228
Gilles Peskine449bd832023-01-11 14:50:10 +01001229 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001230}
1231
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001232/*
1233 * Setup an SSL context
1234 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001235
Gilles Peskine449bd832023-01-11 14:50:10 +01001236int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1237 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001238{
Janos Follath865b3eb2019-12-16 11:46:15 +00001239 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001240 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1241 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001242
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001243 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001244
Gilles Peskine449bd832023-01-11 14:50:10 +01001245 if ((ret = ssl_conf_check(ssl)) != 0) {
1246 return ret;
1247 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001248 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001249
Paul Bakker62f2dee2012-09-28 07:31:51 +00001250 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001251 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001252 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001253
1254 /* Set to NULL in case of an error condition */
1255 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001256
Darryl Greenb33cc762019-11-28 14:29:44 +00001257#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1258 ssl->in_buf_len = in_buf_len;
1259#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1261 if (ssl->in_buf == NULL) {
1262 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001263 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001264 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001265 }
1266
Darryl Greenb33cc762019-11-28 14:29:44 +00001267#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1268 ssl->out_buf_len = out_buf_len;
1269#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001270 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1271 if (ssl->out_buf == NULL) {
1272 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001273 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001274 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001275 }
1276
Deomid rojer Ryabkov3dfe75e2025-01-26 10:43:42 +02001277 mbedtls_ssl_reset_in_pointers(ssl);
1278 mbedtls_ssl_reset_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001279
Johan Pascalb62bb512015-12-03 21:56:45 +01001280#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001281 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001282#endif
1283
Gilles Peskine449bd832023-01-11 14:50:10 +01001284 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001285 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001287
Gilles Peskine449bd832023-01-11 14:50:10 +01001288 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001289
1290error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001291 mbedtls_free(ssl->in_buf);
1292 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001293
1294 ssl->conf = NULL;
1295
Darryl Greenb33cc762019-11-28 14:29:44 +00001296#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1297 ssl->in_buf_len = 0;
1298 ssl->out_buf_len = 0;
1299#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001300 ssl->in_buf = NULL;
1301 ssl->out_buf = NULL;
1302
1303 ssl->in_hdr = NULL;
1304 ssl->in_ctr = NULL;
1305 ssl->in_len = NULL;
1306 ssl->in_iv = NULL;
1307 ssl->in_msg = NULL;
1308
1309 ssl->out_hdr = NULL;
1310 ssl->out_ctr = NULL;
1311 ssl->out_len = NULL;
1312 ssl->out_iv = NULL;
1313 ssl->out_msg = NULL;
1314
Gilles Peskine449bd832023-01-11 14:50:10 +01001315 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001316}
1317
1318/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001319 * Reset an initialized and used SSL context for re-use while retaining
1320 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001321 *
1322 * If partial is non-zero, keep data in the input buffer and client ID.
1323 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001324 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001325void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1326 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001327{
Darryl Greenb33cc762019-11-28 14:29:44 +00001328#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1329 size_t in_buf_len = ssl->in_buf_len;
1330 size_t out_buf_len = ssl->out_buf_len;
1331#else
1332 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1333 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1334#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001335
Hanno Beckerb0302c42021-08-03 09:39:42 +01001336#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1337 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001338#endif
1339
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001340 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001341 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001342
Deomid rojer Ryabkov3dfe75e2025-01-26 10:43:42 +02001343 mbedtls_ssl_reset_in_pointers(ssl);
1344 mbedtls_ssl_reset_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001345
1346 /* Reset incoming message parsing */
1347 ssl->in_offt = NULL;
1348 ssl->nb_zero = 0;
1349 ssl->in_msgtype = 0;
1350 ssl->in_msglen = 0;
1351 ssl->in_hslen = 0;
Deomid rojer Ryabkovdd14c0a2025-02-13 13:41:51 +03001352 ssl->in_hsfraglen = 0;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001353 ssl->keep_current_message = 0;
1354 ssl->transform_in = NULL;
1355
1356#if defined(MBEDTLS_SSL_PROTO_DTLS)
1357 ssl->next_record_offset = 0;
1358 ssl->in_epoch = 0;
1359#endif
1360
1361 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001362 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001363 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001365 }
1366
Ronald Cronad8c17b2022-06-10 17:18:09 +02001367 ssl->send_alert = 0;
1368
Hanno Beckerb0302c42021-08-03 09:39:42 +01001369 /* Reset outgoing message writing */
1370 ssl->out_msgtype = 0;
1371 ssl->out_msglen = 0;
1372 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001373 memset(ssl->out_buf, 0, out_buf_len);
1374 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001375 ssl->transform_out = NULL;
1376
1377#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001378 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001379#endif
1380
XiaokangQian2b01dc32022-01-21 02:53:13 +00001381#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001382 if (ssl->transform) {
1383 mbedtls_ssl_transform_free(ssl->transform);
1384 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001385 ssl->transform = NULL;
1386 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001387#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1388
XiaokangQian2b01dc32022-01-21 02:53:13 +00001389#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001390 mbedtls_ssl_transform_free(ssl->transform_application);
1391 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001392 ssl->transform_application = NULL;
1393
Gilles Peskine449bd832023-01-11 14:50:10 +01001394 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001395#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001396 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1397 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001398 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001399#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001400
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1402 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001403 ssl->handshake->transform_handshake = NULL;
1404 }
1405
XiaokangQian2b01dc32022-01-21 02:53:13 +00001406#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001407}
1408
Gilles Peskine449bd832023-01-11 14:50:10 +01001409int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001410{
1411 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1412
Gilles Peskinef670ba52025-03-07 15:09:32 +01001413 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_REQUEST);
Gilles Peskinefd89acc2025-02-24 18:45:49 +01001414 ssl->flags &= MBEDTLS_SSL_CONTEXT_FLAGS_KEEP_AT_SESSION;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001415 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001416
Gilles Peskine449bd832023-01-11 14:50:10 +01001417 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001418
1419 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001420#if defined(MBEDTLS_SSL_RENEGOTIATION)
1421 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001422 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001423
1424 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1426 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001427#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001428 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001429
Hanno Beckerb0302c42021-08-03 09:39:42 +01001430 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001431 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 if (ssl->session) {
1433 mbedtls_ssl_session_free(ssl->session);
1434 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001435 ssl->session = NULL;
1436 }
1437
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001438#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001439 ssl->alpn_chosen = NULL;
1440#endif
1441
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001442#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001443 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001444#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001446#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001447 if (free_cli_id) {
1448 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001449 ssl->cli_id = NULL;
1450 ssl->cli_id_len = 0;
1451 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001452#endif
1453
Gilles Peskine449bd832023-01-11 14:50:10 +01001454 if ((ret = ssl_handshake_init(ssl)) != 0) {
1455 return ret;
1456 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001457
Gilles Peskine449bd832023-01-11 14:50:10 +01001458 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001459}
1460
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001461/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001462 * Reset an initialized and used SSL context for re-use while retaining
1463 * all application-set variables, function pointers and data.
1464 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001465int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001466{
Gilles Peskine449bd832023-01-11 14:50:10 +01001467 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001468}
1469
1470/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001471 * SSL set accessors
1472 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001473void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001474{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001475 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001476}
1477
Gilles Peskine449bd832023-01-11 14:50:10 +01001478void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001479{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001480 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001481}
1482
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001483#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001484void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001485{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001486 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001487}
1488#endif
1489
Gilles Peskine449bd832023-01-11 14:50:10 +01001490void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001491{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001492 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001493}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001494
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001495#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001496
Gilles Peskine449bd832023-01-11 14:50:10 +01001497void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1498 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001499{
1500 ssl->disable_datagram_packing = !allow_packing;
1501}
1502
Gilles Peskine449bd832023-01-11 14:50:10 +01001503void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1504 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001505{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001506 conf->hs_timeout_min = min;
1507 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001508}
1509#endif
1510
Gilles Peskine449bd832023-01-11 14:50:10 +01001511void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001512{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001513 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001514}
1515
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001516#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001517void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1518 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1519 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001520{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001521 conf->f_vrfy = f_vrfy;
1522 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001523}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001524#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001525
Gilles Peskine449bd832023-01-11 14:50:10 +01001526void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1527 void (*f_dbg)(void *, int, const char *, int, const char *),
1528 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001529{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001530 conf->f_dbg = f_dbg;
1531 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001532}
1533
Gilles Peskine449bd832023-01-11 14:50:10 +01001534void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1535 void *p_bio,
1536 mbedtls_ssl_send_t *f_send,
1537 mbedtls_ssl_recv_t *f_recv,
1538 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001539{
1540 ssl->p_bio = p_bio;
1541 ssl->f_send = f_send;
1542 ssl->f_recv = f_recv;
1543 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001544}
1545
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001546#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001547void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001548{
1549 ssl->mtu = mtu;
1550}
1551#endif
1552
Gilles Peskine449bd832023-01-11 14:50:10 +01001553void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001554{
1555 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001556}
1557
Gilles Peskine449bd832023-01-11 14:50:10 +01001558void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1559 void *p_timer,
1560 mbedtls_ssl_set_timer_t *f_set_timer,
1561 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001562{
1563 ssl->p_timer = p_timer;
1564 ssl->f_set_timer = f_set_timer;
1565 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001566
1567 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001568 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001569}
1570
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001571#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001572void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1573 void *p_cache,
1574 mbedtls_ssl_cache_get_t *f_get_cache,
1575 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001576{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001577 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001578 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001579 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001580}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001581#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001582
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001583#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001584int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001585{
Janos Follath865b3eb2019-12-16 11:46:15 +00001586 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001587
Gilles Peskine449bd832023-01-11 14:50:10 +01001588 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001589 session == NULL ||
1590 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001591 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1592 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001593 }
1594
Gilles Peskine449bd832023-01-11 14:50:10 +01001595 if (ssl->handshake->resume == 1) {
1596 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1597 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001598
Jerry Yu21092062022-10-10 21:21:31 +08001599#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001600 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron233fcaa2024-04-04 14:05:21 +02001601#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001602 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001603 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001604
Gilles Peskine449bd832023-01-11 14:50:10 +01001605 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001606 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001607 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1608 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1609 session->ciphersuite));
1610 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001611 }
Ronald Cron233fcaa2024-04-04 14:05:21 +02001612#else
1613 /*
1614 * If session tickets are not enabled, it is not possible to resume a
1615 * TLS 1.3 session, thus do not make any change to the SSL context in
1616 * the first place.
1617 */
1618 return 0;
1619#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001620 }
Jerry Yu21092062022-10-10 21:21:31 +08001621#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001622
Gilles Peskine449bd832023-01-11 14:50:10 +01001623 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1624 session)) != 0) {
1625 return ret;
1626 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001627
Paul Bakker0a597072012-09-25 21:55:46 +00001628 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001629
Gilles Peskine449bd832023-01-11 14:50:10 +01001630 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001631}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001632#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001633
Gilles Peskine449bd832023-01-11 14:50:10 +01001634void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1635 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001636{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001637 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001638}
1639
Ronald Cron6f135e12021-12-08 16:57:54 +01001640#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001641void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1642 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001643{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001644 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001645}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001646
1647#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001648void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1649 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001650{
1651 conf->early_data_enabled = early_data_enabled;
1652}
Jerry Yucc4e0072022-11-22 17:22:22 +08001653
1654#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001655void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001656 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001657{
Jerry Yu39da9852022-12-06 16:58:36 +08001658 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001659}
1660#endif /* MBEDTLS_SSL_SRV_C */
1661
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001662#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001663#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001664
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001665#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001666void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1667 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001668{
1669 conf->cert_profile = profile;
1670}
1671
Gilles Peskine449bd832023-01-11 14:50:10 +01001672static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001673{
1674 mbedtls_ssl_key_cert *cur = key_cert, *next;
1675
Gilles Peskine449bd832023-01-11 14:50:10 +01001676 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001677 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001678 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001679 cur = next;
1680 }
1681}
1682
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001683/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001684MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001685static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1686 mbedtls_x509_crt *cert,
1687 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001688{
niisato8ee24222018-06-25 19:05:48 +09001689 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001690
Gilles Peskine449bd832023-01-11 14:50:10 +01001691 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001692 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001693 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001694 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001695 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001696 }
1697
Gilles Peskine449bd832023-01-11 14:50:10 +01001698 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1699 if (new_cert == NULL) {
1700 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1701 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001702
niisato8ee24222018-06-25 19:05:48 +09001703 new_cert->cert = cert;
1704 new_cert->key = key;
1705 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001706
Glenn Strauss36872db2022-01-22 05:06:31 -05001707 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001708 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001709 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001710 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001711 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001713 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001714 }
niisato8ee24222018-06-25 19:05:48 +09001715 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001716 }
1717
Gilles Peskine449bd832023-01-11 14:50:10 +01001718 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001719}
1720
Gilles Peskine449bd832023-01-11 14:50:10 +01001721int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001722 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001723 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001724{
Gilles Peskine449bd832023-01-11 14:50:10 +01001725 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001726}
1727
Gilles Peskine449bd832023-01-11 14:50:10 +01001728void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001729 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001731{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001732 conf->ca_chain = ca_chain;
1733 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001734
1735#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1736 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1737 * cannot be used together. */
1738 conf->f_ca_cb = NULL;
1739 conf->p_ca_cb = NULL;
1740#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001741}
Hanno Becker5adaad92019-03-27 16:54:37 +00001742
1743#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001744void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1745 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1746 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001747{
1748 conf->f_ca_cb = f_ca_cb;
1749 conf->p_ca_cb = p_ca_cb;
1750
1751 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1752 * cannot be used together. */
1753 conf->ca_chain = NULL;
1754 conf->ca_crl = NULL;
1755}
1756#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001757#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001758
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001759#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001760const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1761 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001762{
1763 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001765}
1766
Gilles Peskine449bd832023-01-11 14:50:10 +01001767int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1768 mbedtls_x509_crt *own_cert,
1769 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001770{
Gilles Peskine449bd832023-01-11 14:50:10 +01001771 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1772 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001773}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001774
Gilles Peskine449bd832023-01-11 14:50:10 +01001775void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1776 mbedtls_x509_crt *ca_chain,
1777 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001778{
1779 ssl->handshake->sni_ca_chain = ca_chain;
1780 ssl->handshake->sni_ca_crl = ca_crl;
1781}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001782
Glenn Strauss999ef702022-03-11 01:37:23 -05001783#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001784void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1785 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001786{
1787 ssl->handshake->dn_hints = crt;
1788}
1789#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1790
Gilles Peskine449bd832023-01-11 14:50:10 +01001791void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1792 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001793{
1794 ssl->handshake->sni_authmode = authmode;
1795}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001796#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1797
Hanno Becker8927c832019-04-03 12:52:50 +01001798#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001799void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1800 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1801 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001802{
1803 ssl->f_vrfy = f_vrfy;
1804 ssl->p_vrfy = p_vrfy;
1805}
1806#endif
1807
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001808#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001809
Przemek Stekielfde11282023-03-13 16:06:09 +01001810static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1811static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1812
Valerio Setti016f6822022-12-09 14:17:50 +01001813static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001814 mbedtls_ssl_context *ssl,
1815 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001816{
1817 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001818 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001819 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001820 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001821 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001822 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001823 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1824 psa_pake_cs_set_primitive(&cipher_suite,
1825 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1826 PSA_ECC_FAMILY_SECP_R1,
1827 256));
1828 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001829
Anton Matkin72d60302025-03-19 14:56:57 +01001830 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, pwd, &cipher_suite);
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001832 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001833 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001834
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001836 user = jpake_server_id;
1837 user_len = sizeof(jpake_server_id);
1838 peer = jpake_client_id;
1839 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001840 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001841 user = jpake_client_id;
1842 user_len = sizeof(jpake_client_id);
1843 peer = jpake_server_id;
1844 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001846
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001847 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1848 if (status != PSA_SUCCESS) {
1849 return status;
1850 }
1851
1852 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001854 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 }
Valerio Setti016f6822022-12-09 14:17:50 +01001856
Valerio Setti016f6822022-12-09 14:17:50 +01001857 ssl->handshake->psa_pake_ctx_is_ok = 1;
1858
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001860}
1861
Gilles Peskine449bd832023-01-11 14:50:10 +01001862int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1863 const unsigned char *pw,
1864 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001865{
1866 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1867 psa_status_t status;
1868
Gilles Peskine449bd832023-01-11 14:50:10 +01001869 if (ssl->handshake == NULL || ssl->conf == NULL) {
1870 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001871 }
1872
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 /* Empty password is not valid */
1874 if ((pw == NULL) || (pw_len == 0)) {
1875 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1876 }
1877
1878 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
1879 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
1880 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
1881
1882 status = psa_import_key(&attributes, pw, pw_len,
1883 &ssl->handshake->psa_pake_password);
1884 if (status != PSA_SUCCESS) {
1885 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1886 }
1887
1888 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
1889 ssl->handshake->psa_pake_password);
1890 if (status != PSA_SUCCESS) {
1891 psa_destroy_key(ssl->handshake->psa_pake_password);
1892 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1893 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1894 }
1895
1896 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001897}
Valerio Settia9a97dc2022-11-28 18:26:16 +01001898
Gilles Peskine449bd832023-01-11 14:50:10 +01001899int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
1900 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01001901{
Valerio Settia9a97dc2022-11-28 18:26:16 +01001902 psa_status_t status;
1903
Gilles Peskine449bd832023-01-11 14:50:10 +01001904 if (ssl->handshake == NULL || ssl->conf == NULL) {
1905 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001906 }
1907
Gilles Peskine449bd832023-01-11 14:50:10 +01001908 if (mbedtls_svc_key_id_is_null(pwd)) {
1909 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1910 }
1911
1912 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
1913 if (status != PSA_SUCCESS) {
1914 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1915 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1916 }
1917
1918 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001919}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001920#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001921
Ronald Cron73fe8df2022-10-05 14:31:43 +02001922#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001923int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001924{
Gilles Peskine449bd832023-01-11 14:50:10 +01001925 if (conf->psk_identity == NULL ||
1926 conf->psk_identity_len == 0) {
1927 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02001928 }
1929
Gilles Peskine449bd832023-01-11 14:50:10 +01001930 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
1931 return 1;
1932 }
Ronald Crond29e13e2022-10-19 10:33:48 +02001933
Gilles Peskine449bd832023-01-11 14:50:10 +01001934 if (conf->psk != NULL && conf->psk_len != 0) {
1935 return 1;
1936 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001937
Gilles Peskine449bd832023-01-11 14:50:10 +01001938 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001939}
1940
Gilles Peskine449bd832023-01-11 14:50:10 +01001941static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001942{
1943 /* Remove reference to existing PSK, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001944 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001945 /* The maintenance of the PSK key slot is the
1946 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001947 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001948 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01001950 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001951 conf->psk = NULL;
1952 conf->psk_len = 0;
1953 }
1954
1955 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001956 if (conf->psk_identity != NULL) {
1957 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001958 conf->psk_identity = NULL;
1959 conf->psk_identity_len = 0;
1960 }
1961}
1962
Hanno Becker7390c712018-11-15 13:33:04 +00001963/* This function assumes that PSK identity in the SSL config is unset.
1964 * It checks that the provided identity is well-formed and attempts
1965 * to make a copy of it in the SSL config.
1966 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001967MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001968static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
1969 unsigned char const *psk_identity,
1970 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001971{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001972 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02001974 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001975 (psk_identity_len >> 16) != 0 ||
1976 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
1977 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001978 }
1979
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
1981 if (conf->psk_identity == NULL) {
1982 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1983 }
Paul Bakker6db455e2013-09-18 17:29:31 +02001984
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001985 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02001987
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02001989}
1990
Gilles Peskine449bd832023-01-11 14:50:10 +01001991int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
1992 const unsigned char *psk, size_t psk_len,
1993 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00001994{
Janos Follath865b3eb2019-12-16 11:46:15 +00001995 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001996
1997 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 if (mbedtls_ssl_conf_has_static_psk(conf)) {
1999 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2000 }
Hanno Becker7390c712018-11-15 13:33:04 +00002001
2002 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 if (psk == NULL) {
2004 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2005 }
2006 if (psk_len == 0) {
2007 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2008 }
2009 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2010 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2011 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002012
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2014 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2015 }
Hanno Becker7390c712018-11-15 13:33:04 +00002016 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002018
2019 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002020 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2021 if (ret != 0) {
2022 ssl_conf_remove_psk(conf);
2023 }
Hanno Becker7390c712018-11-15 13:33:04 +00002024
Gilles Peskine449bd832023-01-11 14:50:10 +01002025 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002026}
2027
Gilles Peskine449bd832023-01-11 14:50:10 +01002028static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002029{
Gilles Peskine449bd832023-01-11 14:50:10 +01002030 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002031 /* The maintenance of the external PSK key slot is the
2032 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002033 if (ssl->handshake->psk_opaque_is_internal) {
2034 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002035 ssl->handshake->psk_opaque_is_internal = 0;
2036 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002037 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002038 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002039}
2040
Gilles Peskine449bd832023-01-11 14:50:10 +01002041int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2042 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002043{
Neil Armstrong501c9322022-05-03 09:35:09 +02002044 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002045 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002046 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002047 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002048
Gilles Peskine449bd832023-01-11 14:50:10 +01002049 if (psk == NULL || ssl->handshake == NULL) {
2050 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2051 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002052
Gilles Peskine449bd832023-01-11 14:50:10 +01002053 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2054 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2055 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002056
Gilles Peskine449bd832023-01-11 14:50:10 +01002057 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002058
Jerry Yuccc68a42022-07-26 16:39:20 +08002059#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002060 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2061 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2062 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2063 } else {
2064 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2065 }
2066 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002067 }
2068#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002069
Jerry Yu568ec252022-07-22 21:27:34 +08002070#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002071 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2072 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2073 psa_set_key_usage_flags(&key_attributes,
2074 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002075 }
2076#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2077
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 psa_set_key_algorithm(&key_attributes, alg);
2079 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002080
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2082 if (status != PSA_SUCCESS) {
2083 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2084 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002085
2086 /* Allow calling psa_destroy_key() on psk remove */
2087 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002088 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002089}
2090
Gilles Peskine449bd832023-01-11 14:50:10 +01002091int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2092 mbedtls_svc_key_id_t psk,
2093 const unsigned char *psk_identity,
2094 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002095{
Janos Follath865b3eb2019-12-16 11:46:15 +00002096 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002097
2098 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2100 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2101 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002102
Hanno Becker7390c712018-11-15 13:33:04 +00002103 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 if (mbedtls_svc_key_id_is_null(psk)) {
2105 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2106 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002107 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002108
2109 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2111 psk_identity_len);
2112 if (ret != 0) {
2113 ssl_conf_remove_psk(conf);
2114 }
Hanno Becker7390c712018-11-15 13:33:04 +00002115
Gilles Peskine449bd832023-01-11 14:50:10 +01002116 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002117}
2118
Gilles Peskine449bd832023-01-11 14:50:10 +01002119int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2120 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002121{
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 if ((mbedtls_svc_key_id_is_null(psk)) ||
2123 (ssl->handshake == NULL)) {
2124 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2125 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002126
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002128 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002130}
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002131
Jerry Yu8897c072022-08-12 13:56:53 +08002132#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002133void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2134 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2135 size_t),
2136 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002137{
2138 conf->f_psk = f_psk;
2139 conf->p_psk = p_psk;
2140}
Jerry Yu8897c072022-08-12 13:56:53 +08002141#endif /* MBEDTLS_SSL_SRV_C */
2142
Ronald Cron73fe8df2022-10-05 14:31:43 +02002143#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002144
Gilles Peskine301711e2022-04-26 16:57:05 +02002145static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002146 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002147{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002148#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 if (alg == PSA_ALG_CBC_NO_PADDING) {
2150 return MBEDTLS_SSL_MODE_CBC;
2151 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002152#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 if (PSA_ALG_IS_AEAD(alg)) {
2154 return MBEDTLS_SSL_MODE_AEAD;
2155 }
2156 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002157}
2158
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002159
Gilles Peskinee108d982022-04-26 16:50:40 +02002160static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2161 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002163{
2164#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002165 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2166 base_mode == MBEDTLS_SSL_MODE_CBC) {
2167 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002168 }
2169#else
2170 (void) encrypt_then_mac;
2171#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002173}
2174
Neil Armstrongab555e02022-04-04 11:07:59 +02002175mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002177{
Gilles Peskinee108d982022-04-26 16:50:40 +02002178 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 transform->psa_alg
Gilles Peskinee108d982022-04-26 16:50:40 +02002180 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002181
Gilles Peskinee108d982022-04-26 16:50:40 +02002182 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002183#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002184 encrypt_then_mac = transform->encrypt_then_mac;
2185#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002186 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002187}
2188
Neil Armstrongab555e02022-04-04 11:07:59 +02002189mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002190#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002192#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002194{
Gilles Peskinee108d982022-04-26 16:50:40 +02002195 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2196
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002197 psa_status_t status;
2198 psa_algorithm_t alg;
2199 psa_key_type_t type;
2200 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002201 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2202 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 if (status == PSA_SUCCESS) {
2204 base_mode = mbedtls_ssl_get_base_mode(alg);
2205 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002206
Gilles Peskinee108d982022-04-26 16:50:40 +02002207#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2208 int encrypt_then_mac = 0;
2209#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002210 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002211}
2212
Jerry Yu251a12e2022-07-13 15:15:48 +08002213
Ronald Cron8b592d22024-11-12 18:08:25 +01002214const mbedtls_error_pair_t psa_to_ssl_errors[] =
2215{
2216 { PSA_SUCCESS, 0 },
2217 { PSA_ERROR_INSUFFICIENT_MEMORY, MBEDTLS_ERR_SSL_ALLOC_FAILED },
2218 { PSA_ERROR_NOT_SUPPORTED, MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE },
2219 { PSA_ERROR_INVALID_SIGNATURE, MBEDTLS_ERR_SSL_INVALID_MAC },
2220 { PSA_ERROR_INVALID_ARGUMENT, MBEDTLS_ERR_SSL_BAD_INPUT_DATA },
2221 { PSA_ERROR_BAD_STATE, MBEDTLS_ERR_SSL_INTERNAL_ERROR },
2222 { PSA_ERROR_BUFFER_TOO_SMALL, MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL }
2223};
2224
Gilles Peskine449bd832023-01-11 14:50:10 +01002225psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2226 size_t taglen,
2227 psa_algorithm_t *alg,
2228 psa_key_type_t *key_type,
2229 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002230{
Elena Uziunaitec2561722024-07-05 11:37:33 +01002231#if !defined(PSA_WANT_ALG_CCM)
Yanray Wang19e4dc82023-11-16 18:02:05 +08002232 (void) taglen;
2233#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 switch (mbedtls_cipher_type) {
Elena Uziunaite74342c72024-07-05 11:31:29 +01002235#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002236 case MBEDTLS_CIPHER_AES_128_CBC:
2237 *alg = PSA_ALG_CBC_NO_PADDING;
2238 *key_type = PSA_KEY_TYPE_AES;
2239 *key_size = 128;
2240 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002241#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002242#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002243 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002244 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002245 *key_type = PSA_KEY_TYPE_AES;
2246 *key_size = 128;
2247 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002248#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002249#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002250 case MBEDTLS_CIPHER_AES_128_GCM:
2251 *alg = PSA_ALG_GCM;
2252 *key_type = PSA_KEY_TYPE_AES;
2253 *key_size = 128;
2254 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002255#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002256#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002257 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002259 *key_type = PSA_KEY_TYPE_AES;
2260 *key_size = 192;
2261 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002262#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002263#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002264 case MBEDTLS_CIPHER_AES_192_GCM:
2265 *alg = PSA_ALG_GCM;
2266 *key_type = PSA_KEY_TYPE_AES;
2267 *key_size = 192;
2268 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002269#endif
Elena Uziunaite74342c72024-07-05 11:31:29 +01002270#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002271 case MBEDTLS_CIPHER_AES_256_CBC:
2272 *alg = PSA_ALG_CBC_NO_PADDING;
2273 *key_type = PSA_KEY_TYPE_AES;
2274 *key_size = 256;
2275 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002276#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002277#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002278 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002279 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002280 *key_type = PSA_KEY_TYPE_AES;
2281 *key_size = 256;
2282 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002283#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002284#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002285 case MBEDTLS_CIPHER_AES_256_GCM:
2286 *alg = PSA_ALG_GCM;
2287 *key_type = PSA_KEY_TYPE_AES;
2288 *key_size = 256;
2289 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002290#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002291#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002292 case MBEDTLS_CIPHER_ARIA_128_CBC:
2293 *alg = PSA_ALG_CBC_NO_PADDING;
2294 *key_type = PSA_KEY_TYPE_ARIA;
2295 *key_size = 128;
2296 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002297#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002298#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002299 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002301 *key_type = PSA_KEY_TYPE_ARIA;
2302 *key_size = 128;
2303 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002304#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002305#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002306 case MBEDTLS_CIPHER_ARIA_128_GCM:
2307 *alg = PSA_ALG_GCM;
2308 *key_type = PSA_KEY_TYPE_ARIA;
2309 *key_size = 128;
2310 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002311#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002312#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002313 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002315 *key_type = PSA_KEY_TYPE_ARIA;
2316 *key_size = 192;
2317 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002318#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002319#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002320 case MBEDTLS_CIPHER_ARIA_192_GCM:
2321 *alg = PSA_ALG_GCM;
2322 *key_type = PSA_KEY_TYPE_ARIA;
2323 *key_size = 192;
2324 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002325#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002326#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002327 case MBEDTLS_CIPHER_ARIA_256_CBC:
2328 *alg = PSA_ALG_CBC_NO_PADDING;
2329 *key_type = PSA_KEY_TYPE_ARIA;
2330 *key_size = 256;
2331 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002332#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002333#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002334 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002335 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002336 *key_type = PSA_KEY_TYPE_ARIA;
2337 *key_size = 256;
2338 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002339#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002340#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002341 case MBEDTLS_CIPHER_ARIA_256_GCM:
2342 *alg = PSA_ALG_GCM;
2343 *key_type = PSA_KEY_TYPE_ARIA;
2344 *key_size = 256;
2345 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002346#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002347#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002348 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2349 *alg = PSA_ALG_CBC_NO_PADDING;
2350 *key_type = PSA_KEY_TYPE_CAMELLIA;
2351 *key_size = 128;
2352 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002353#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002354#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002355 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002357 *key_type = PSA_KEY_TYPE_CAMELLIA;
2358 *key_size = 128;
2359 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002360#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002361#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002362 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2363 *alg = PSA_ALG_GCM;
2364 *key_type = PSA_KEY_TYPE_CAMELLIA;
2365 *key_size = 128;
2366 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002367#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002368#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002369 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002371 *key_type = PSA_KEY_TYPE_CAMELLIA;
2372 *key_size = 192;
2373 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002374#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002375#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002376 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2377 *alg = PSA_ALG_GCM;
2378 *key_type = PSA_KEY_TYPE_CAMELLIA;
2379 *key_size = 192;
2380 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002381#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002382#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002383 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2384 *alg = PSA_ALG_CBC_NO_PADDING;
2385 *key_type = PSA_KEY_TYPE_CAMELLIA;
2386 *key_size = 256;
2387 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002388#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002389#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002390 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002392 *key_type = PSA_KEY_TYPE_CAMELLIA;
2393 *key_size = 256;
2394 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002395#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002396#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002397 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2398 *alg = PSA_ALG_GCM;
2399 *key_type = PSA_KEY_TYPE_CAMELLIA;
2400 *key_size = 256;
2401 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002402#endif
Elena Uziunaite5c70c302024-07-05 11:44:44 +01002403#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002404 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2405 *alg = PSA_ALG_CHACHA20_POLY1305;
2406 *key_type = PSA_KEY_TYPE_CHACHA20;
2407 *key_size = 256;
2408 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002409#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002410 case MBEDTLS_CIPHER_NULL:
2411 *alg = MBEDTLS_SSL_NULL_CIPHER;
2412 *key_type = 0;
2413 *key_size = 0;
2414 break;
2415 default:
2416 return PSA_ERROR_NOT_SUPPORTED;
2417 }
2418
2419 return PSA_SUCCESS;
2420}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002421
Ronald Crone68ab4f2022-10-05 12:46:29 +02002422#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002423
Jerry Yuf017ee42022-01-12 15:49:48 +08002424/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002425void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2426 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002427{
Jerry Yuf017ee42022-01-12 15:49:48 +08002428#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2429 conf->sig_hashes = NULL;
2430#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2431 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002432}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002433#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002434
Brett Warrene0edc842021-08-17 09:53:13 +01002435/*
2436 * Set the allowed groups
2437 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002438void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2439 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002440{
Brett Warrene0edc842021-08-17 09:53:13 +01002441 conf->group_list = group_list;
2442}
2443
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002444#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine4ac40082025-02-20 18:13:58 +01002445
2446#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2447/** Whether mbedtls_ssl_set_hostname() has been called.
2448 *
2449 * \param[in] ssl SSL context
2450 *
2451 * \return \c 1 if mbedtls_ssl_set_hostname() has been called on \p ssl
2452 * (including `mbedtls_ssl_set_hostname(ssl, NULL)`),
2453 * otherwise \c 0.
2454 */
2455static int mbedtls_ssl_has_set_hostname_been_called(
2456 const mbedtls_ssl_context *ssl)
2457{
Gilles Peskine434016e2025-02-20 18:49:59 +01002458 return (ssl->flags & MBEDTLS_SSL_CONTEXT_FLAG_HOSTNAME_SET) != 0;
Gilles Peskine4ac40082025-02-20 18:13:58 +01002459}
2460#endif
2461
2462static void mbedtls_ssl_free_hostname(mbedtls_ssl_context *ssl)
2463{
2464 if (ssl->hostname != NULL) {
2465 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
2466 }
2467 ssl->hostname = NULL;
2468}
2469
Gilles Peskine449bd832023-01-11 14:50:10 +01002470int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002471{
Hanno Becker947194e2017-04-07 13:25:49 +01002472 /* Initialize to suppress unnecessary compiler warning */
2473 size_t hostname_len = 0;
2474
2475 /* Check if new hostname is valid before
2476 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002477 if (hostname != NULL) {
2478 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002479
Gilles Peskine449bd832023-01-11 14:50:10 +01002480 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2481 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2482 }
Hanno Becker947194e2017-04-07 13:25:49 +01002483 }
2484
2485 /* Now it's clear that we will overwrite the old hostname,
2486 * so we can free it safely */
Gilles Peskine4ac40082025-02-20 18:13:58 +01002487 mbedtls_ssl_free_hostname(ssl);
Hanno Becker947194e2017-04-07 13:25:49 +01002488
2489 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002490
Gilles Peskine449bd832023-01-11 14:50:10 +01002491 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002492 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002493 } else {
2494 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2495 if (ssl->hostname == NULL) {
2496 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2497 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002498
Gilles Peskine449bd832023-01-11 14:50:10 +01002499 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002500
Hanno Becker947194e2017-04-07 13:25:49 +01002501 ssl->hostname[hostname_len] = '\0';
2502 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002503
Gilles Peskine434016e2025-02-20 18:49:59 +01002504 ssl->flags |= MBEDTLS_SSL_CONTEXT_FLAG_HOSTNAME_SET;
2505
Gilles Peskine449bd832023-01-11 14:50:10 +01002506 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002507}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002508#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002509
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002510#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002511void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2512 int (*f_sni)(void *, mbedtls_ssl_context *,
2513 const unsigned char *, size_t),
2514 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002515{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002516 conf->f_sni = f_sni;
2517 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002518}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002519#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002520
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002521#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskinec4949d12025-05-27 19:45:29 +02002522int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf,
2523 const char *const *protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002524{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002525 size_t cur_len, tot_len;
Gilles Peskinec4949d12025-05-27 19:45:29 +02002526 const char *const *p;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002527
2528 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002529 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2530 * MUST NOT be truncated."
2531 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002532 */
2533 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002534 for (p = protos; *p != NULL; p++) {
2535 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002536 tot_len += cur_len;
2537
Gilles Peskine449bd832023-01-11 14:50:10 +01002538 if ((cur_len == 0) ||
2539 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2540 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2541 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2542 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002543 }
2544
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002545 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002546
Gilles Peskine449bd832023-01-11 14:50:10 +01002547 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002548}
2549
Gilles Peskine449bd832023-01-11 14:50:10 +01002550const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002551{
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002553}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002554#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002555
Johan Pascalb62bb512015-12-03 21:56:45 +01002556#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002557void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2558 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002559{
2560 conf->dtls_srtp_mki_support = support_mki_value;
2561}
2562
Gilles Peskine449bd832023-01-11 14:50:10 +01002563int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2564 unsigned char *mki_value,
2565 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002566{
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2568 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002569 }
Ron Eldor591f1622018-01-22 12:30:04 +02002570
Gilles Peskine449bd832023-01-11 14:50:10 +01002571 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2572 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002573 }
Ron Eldor591f1622018-01-22 12:30:04 +02002574
Gilles Peskine449bd832023-01-11 14:50:10 +01002575 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002576 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002578}
2579
Gilles Peskine449bd832023-01-11 14:50:10 +01002580int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2581 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002582{
Johan Pascal253d0262020-09-22 13:04:45 +02002583 const mbedtls_ssl_srtp_profile *p;
2584 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002585
Johan Pascal253d0262020-09-22 13:04:45 +02002586 /* check the profiles list: all entry must be valid,
2587 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002588 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2589 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2590 p++) {
2591 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002592 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002594 /* unsupported value, stop parsing and set the size to an error value */
2595 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002596 }
2597 }
2598
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2600 conf->dtls_srtp_profile_list = NULL;
2601 conf->dtls_srtp_profile_list_len = 0;
2602 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002603 }
2604
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002605 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002606 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002607
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002609}
2610
Gilles Peskine449bd832023-01-11 14:50:10 +01002611void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2612 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002613{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002614 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2615 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002616 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002617 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002618 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002619 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002620 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2621 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002622 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002623}
Johan Pascalb62bb512015-12-03 21:56:45 +01002624#endif /* MBEDTLS_SSL_DTLS_SRTP */
2625
Janos Follath088ce432017-04-10 12:42:31 +01002626#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002627void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2628 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002629{
2630 conf->cert_req_ca_list = cert_req_ca_list;
2631}
2632#endif
2633
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002634#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002635void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002636{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002637 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002638}
2639#endif
2640
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002641#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002642void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002643{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002644 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002645}
2646#endif
2647
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002648#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002649int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002650{
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2652 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2653 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002654 }
2655
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002656 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002657
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002659}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002660#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002661
Gilles Peskine449bd832023-01-11 14:50:10 +01002662void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002663{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002664 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002665}
2666
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002667#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002668void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002669{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002670 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002671}
2672
Gilles Peskine449bd832023-01-11 14:50:10 +01002673void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002674{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002675 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002676}
2677
Gilles Peskine449bd832023-01-11 14:50:10 +01002678void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2679 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002680{
Gilles Peskine449bd832023-01-11 14:50:10 +01002681 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002682}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002683#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker490ecc82011-10-06 13:04:09 +00002684
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002685#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002686#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002687void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002688{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002689 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002690}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002691#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002692
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002693#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002694
Jerry Yud0766ec2022-09-22 10:46:57 +08002695#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002696void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2697 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002698{
Jerry Yud0766ec2022-09-22 10:46:57 +08002699 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002700}
2701#endif
2702
Gilles Peskine449bd832023-01-11 14:50:10 +01002703void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2704 mbedtls_ssl_ticket_write_t *f_ticket_write,
2705 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2706 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02002707{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002708 conf->f_ticket_write = f_ticket_write;
2709 conf->f_ticket_parse = f_ticket_parse;
2710 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002711}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002712#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002713#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002714
Gilles Peskine449bd832023-01-11 14:50:10 +01002715void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
2716 mbedtls_ssl_export_keys_t *f_export_keys,
2717 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002718{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002719 ssl->f_export_keys = f_export_keys;
2720 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002721}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002722
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002723#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002724void mbedtls_ssl_conf_async_private_cb(
2725 mbedtls_ssl_config *conf,
2726 mbedtls_ssl_async_sign_t *f_async_sign,
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002727 mbedtls_ssl_async_resume_t *f_async_resume,
2728 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01002729 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002730{
2731 conf->f_async_sign_start = f_async_sign;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002732 conf->f_async_resume = f_async_resume;
2733 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002734 conf->p_async_config_data = async_config_data;
2735}
2736
Gilles Peskine449bd832023-01-11 14:50:10 +01002737void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02002738{
Gilles Peskine449bd832023-01-11 14:50:10 +01002739 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02002740}
2741
Gilles Peskine449bd832023-01-11 14:50:10 +01002742void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002743{
Gilles Peskine449bd832023-01-11 14:50:10 +01002744 if (ssl->handshake == NULL) {
2745 return NULL;
2746 } else {
2747 return ssl->handshake->user_async_ctx;
2748 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002749}
2750
Gilles Peskine449bd832023-01-11 14:50:10 +01002751void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2752 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002753{
Gilles Peskine449bd832023-01-11 14:50:10 +01002754 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002755 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01002756 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002757}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002758#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002759
Paul Bakker5121ce52009-01-03 21:22:43 +00002760/*
2761 * SSL get accessors
2762 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002763uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002764{
Gilles Peskine449bd832023-01-11 14:50:10 +01002765 if (ssl->session != NULL) {
2766 return ssl->session->verify_result;
2767 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002768
Gilles Peskine449bd832023-01-11 14:50:10 +01002769 if (ssl->session_negotiate != NULL) {
2770 return ssl->session_negotiate->verify_result;
2771 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002772
Gilles Peskine449bd832023-01-11 14:50:10 +01002773 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00002774}
2775
Gilles Peskine449bd832023-01-11 14:50:10 +01002776int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05002777{
Gilles Peskine449bd832023-01-11 14:50:10 +01002778 if (ssl == NULL || ssl->session == NULL) {
2779 return 0;
2780 }
Glenn Strauss8f526902022-01-13 00:04:49 -05002781
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05002783}
2784
Gilles Peskine449bd832023-01-11 14:50:10 +01002785const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00002786{
Gilles Peskine449bd832023-01-11 14:50:10 +01002787 if (ssl == NULL || ssl->session == NULL) {
2788 return NULL;
2789 }
Paul Bakker926c8e42013-03-06 10:23:34 +01002790
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00002792}
2793
Gilles Peskine449bd832023-01-11 14:50:10 +01002794const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00002795{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002796#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002797 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2798 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002799 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002800 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002801 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002802 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002803 }
2804 }
2805#endif
2806
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002808 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04002810 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01002811 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002812 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002814 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002815}
2816
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002817#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2818
2819size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
2820{
2821 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2822 size_t record_size_limit = max_len;
2823
2824 if (ssl->session != NULL &&
2825 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2826 ssl->session->record_size_limit < max_len) {
2827 record_size_limit = ssl->session->record_size_limit;
2828 }
2829
2830 // TODO: this is currently untested
2831 /* During a handshake, use the value being negotiated */
2832 if (ssl->session_negotiate != NULL &&
2833 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2834 ssl->session_negotiate->record_size_limit < max_len) {
2835 record_size_limit = ssl->session_negotiate->record_size_limit;
2836 }
2837
2838 return record_size_limit;
2839}
2840#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2841
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002842#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002843size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002844{
David Horstmann95d516f2021-05-04 18:36:56 +01002845 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002846 size_t read_mfl;
2847
Jerry Yuddda0502022-12-01 19:43:12 +08002848#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002849 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01002850 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2851 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
2852 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002853 }
Jerry Yuddda0502022-12-01 19:43:12 +08002854#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002855
2856 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002857 if (ssl->session_out != NULL) {
2858 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
2859 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002860 max_len = read_mfl;
2861 }
2862 }
2863
Jerry Yuddda0502022-12-01 19:43:12 +08002864 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 if (ssl->session_negotiate != NULL) {
2866 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
2867 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002868 max_len = read_mfl;
2869 }
2870 }
2871
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002873}
2874
Gilles Peskine449bd832023-01-11 14:50:10 +01002875size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002876{
2877 size_t max_len;
2878
2879 /*
2880 * Assume mfl_code is correct since it was checked when set
2881 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002882 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002883
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002884 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002885 if (ssl->session_out != NULL &&
2886 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
2887 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002888 }
2889
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002890 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002891 if (ssl->session_negotiate != NULL &&
2892 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
2893 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002894 }
2895
Gilles Peskine449bd832023-01-11 14:50:10 +01002896 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002897}
2898#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2899
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002900#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002901size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002902{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002903 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2905 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2906 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
2907 return 0;
2908 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002909
Gilles Peskine449bd832023-01-11 14:50:10 +01002910 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
2911 return ssl->mtu;
2912 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002913
Gilles Peskine449bd832023-01-11 14:50:10 +01002914 if (ssl->mtu == 0) {
2915 return ssl->handshake->mtu;
2916 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002917
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 return ssl->mtu < ssl->handshake->mtu ?
2919 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002920}
2921#endif /* MBEDTLS_SSL_PROTO_DTLS */
2922
Gilles Peskine449bd832023-01-11 14:50:10 +01002923int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002924{
2925 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2926
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002927#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002928 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002929 !defined(MBEDTLS_SSL_PROTO_DTLS)
2930 (void) ssl;
2931#endif
2932
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002933#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002934 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002935
Gilles Peskine449bd832023-01-11 14:50:10 +01002936 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002937 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01002938 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002939#endif
2940
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002941#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2942 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
2943
2944 if (max_len > record_size_limit) {
2945 max_len = record_size_limit;
2946 }
2947#endif
2948
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002949 if (ssl->transform_out != NULL &&
2950 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00002951 /*
2952 * In TLS 1.3 case, when records are protected, `max_len` as computed
2953 * above is the maximum length of the TLSInnerPlaintext structure that
2954 * along the plaintext payload contains the inner content type (one byte)
2955 * and some zero padding. Given the algorithm used for padding
2956 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
2957 * the plaintext payload. Round down to a multiple of
2958 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
2959 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002960 */
2961 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
2962 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
2963 }
2964
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002965#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002966 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
2967 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
2968 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002969 const size_t overhead = (size_t) ret;
2970
Gilles Peskine449bd832023-01-11 14:50:10 +01002971 if (ret < 0) {
2972 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002973 }
2974
Gilles Peskine449bd832023-01-11 14:50:10 +01002975 if (mtu <= overhead) {
2976 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
2977 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2978 }
2979
2980 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002981 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01002982 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002983 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002984#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002985
Hanno Becker0defedb2018-08-10 12:35:02 +01002986#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00002987 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
2988 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01002989 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002990#endif
2991
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002993}
2994
Gilles Peskine449bd832023-01-11 14:50:10 +01002995int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002996{
2997 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2998
2999#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3000 (void) ssl;
3001#endif
3002
3003#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003004 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003005
Gilles Peskine449bd832023-01-11 14:50:10 +01003006 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003007 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003009#endif
3010
Gilles Peskine449bd832023-01-11 14:50:10 +01003011 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003012}
3013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003014#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003015const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003016{
Gilles Peskine449bd832023-01-11 14:50:10 +01003017 if (ssl == NULL || ssl->session == NULL) {
3018 return NULL;
3019 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003020
Hanno Beckere6824572019-02-07 13:18:46 +00003021#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003022 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003023#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003025#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003026}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003027#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003028
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003029#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003030int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3031 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003032{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003033 int ret;
3034
Gilles Peskine449bd832023-01-11 14:50:10 +01003035 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003036 dst == NULL ||
3037 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3039 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003040 }
3041
Hanno Beckere810bbc2021-05-14 16:01:05 +01003042 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3043 * idempotent: Each session can only be exported once.
3044 *
3045 * (This is in preparation for TLS 1.3 support where we will
3046 * need the ability to export multiple sessions (aka tickets),
3047 * which will be achieved by calling mbedtls_ssl_get_session()
3048 * multiple times until it fails.)
3049 *
3050 * Check whether we have already exported the current session,
3051 * and fail if so.
3052 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003053 if (ssl->session->exported == 1) {
3054 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3055 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003056
Gilles Peskine449bd832023-01-11 14:50:10 +01003057 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3058 if (ret != 0) {
3059 return ret;
3060 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003061
3062 /* Remember that we've exported the session. */
3063 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003065}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003066#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003067
David Horstmanncb01b362024-02-29 17:31:46 +00003068#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3069
3070/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003071 *
David Horstmanncb01b362024-02-29 17:31:46 +00003072 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003073 */
3074static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3075 unsigned char *buf,
3076 size_t buf_len)
3077{
3078 unsigned char *p = buf;
3079 size_t used = 0;
3080
3081#if defined(MBEDTLS_HAVE_TIME)
3082 uint64_t start;
3083#endif
3084#if defined(MBEDTLS_X509_CRT_PARSE_C)
3085#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3086 size_t cert_len;
3087#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3088#endif /* MBEDTLS_X509_CRT_PARSE_C */
3089
3090 /*
3091 * Time
3092 */
3093#if defined(MBEDTLS_HAVE_TIME)
3094 used += 8;
3095
3096 if (used <= buf_len) {
3097 start = (uint64_t) session->start;
3098
3099 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3100 p += 8;
3101 }
3102#endif /* MBEDTLS_HAVE_TIME */
3103
3104 /*
3105 * Basic mandatory fields
3106 */
3107 used += 1 /* id_len */
3108 + sizeof(session->id)
3109 + sizeof(session->master)
3110 + 4; /* verify_result */
3111
3112 if (used <= buf_len) {
3113 *p++ = MBEDTLS_BYTE_0(session->id_len);
3114 memcpy(p, session->id, 32);
3115 p += 32;
3116
3117 memcpy(p, session->master, 48);
3118 p += 48;
3119
3120 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3121 p += 4;
3122 }
3123
3124 /*
3125 * Peer's end-entity certificate
3126 */
3127#if defined(MBEDTLS_X509_CRT_PARSE_C)
3128#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3129 if (session->peer_cert == NULL) {
3130 cert_len = 0;
3131 } else {
3132 cert_len = session->peer_cert->raw.len;
3133 }
3134
3135 used += 3 + cert_len;
3136
3137 if (used <= buf_len) {
3138 *p++ = MBEDTLS_BYTE_2(cert_len);
3139 *p++ = MBEDTLS_BYTE_1(cert_len);
3140 *p++ = MBEDTLS_BYTE_0(cert_len);
3141
3142 if (session->peer_cert != NULL) {
3143 memcpy(p, session->peer_cert->raw.p, cert_len);
3144 p += cert_len;
3145 }
3146 }
3147#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3148 if (session->peer_cert_digest != NULL) {
3149 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3150 if (used <= buf_len) {
3151 *p++ = (unsigned char) session->peer_cert_digest_type;
3152 *p++ = (unsigned char) session->peer_cert_digest_len;
3153 memcpy(p, session->peer_cert_digest,
3154 session->peer_cert_digest_len);
3155 p += session->peer_cert_digest_len;
3156 }
3157 } else {
3158 used += 2;
3159 if (used <= buf_len) {
3160 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3161 *p++ = 0;
3162 }
3163 }
3164#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3165#endif /* MBEDTLS_X509_CRT_PARSE_C */
3166
3167 /*
3168 * Session ticket if any, plus associated data
3169 */
3170#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3171#if defined(MBEDTLS_SSL_CLI_C)
3172 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3173 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3174
3175 if (used <= buf_len) {
3176 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3177 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3178 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3179
3180 if (session->ticket != NULL) {
3181 memcpy(p, session->ticket, session->ticket_len);
3182 p += session->ticket_len;
3183 }
3184
3185 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3186 p += 4;
3187 }
3188 }
3189#endif /* MBEDTLS_SSL_CLI_C */
3190#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3191 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3192 used += 8;
3193
3194 if (used <= buf_len) {
3195 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3196 p += 8;
3197 }
3198 }
3199#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3200#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3201
3202 /*
3203 * Misc extension-related info
3204 */
3205#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3206 used += 1;
3207
3208 if (used <= buf_len) {
3209 *p++ = session->mfl_code;
3210 }
3211#endif
3212
3213#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3214 used += 1;
3215
3216 if (used <= buf_len) {
3217 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3218 }
3219#endif
3220
3221 return used;
3222}
3223
3224MBEDTLS_CHECK_RETURN_CRITICAL
3225static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3226 const unsigned char *buf,
3227 size_t len)
3228{
3229#if defined(MBEDTLS_HAVE_TIME)
3230 uint64_t start;
3231#endif
3232#if defined(MBEDTLS_X509_CRT_PARSE_C)
3233#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3234 size_t cert_len;
3235#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3236#endif /* MBEDTLS_X509_CRT_PARSE_C */
3237
3238 const unsigned char *p = buf;
3239 const unsigned char * const end = buf + len;
3240
3241 /*
3242 * Time
3243 */
3244#if defined(MBEDTLS_HAVE_TIME)
3245 if (8 > (size_t) (end - p)) {
3246 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3247 }
3248
3249 start = MBEDTLS_GET_UINT64_BE(p, 0);
3250 p += 8;
3251
3252 session->start = (time_t) start;
3253#endif /* MBEDTLS_HAVE_TIME */
3254
3255 /*
3256 * Basic mandatory fields
3257 */
3258 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3259 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3260 }
3261
3262 session->id_len = *p++;
3263 memcpy(session->id, p, 32);
3264 p += 32;
3265
3266 memcpy(session->master, p, 48);
3267 p += 48;
3268
3269 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3270 p += 4;
3271
3272 /* Immediately clear invalid pointer values that have been read, in case
3273 * we exit early before we replaced them with valid ones. */
3274#if defined(MBEDTLS_X509_CRT_PARSE_C)
3275#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3276 session->peer_cert = NULL;
3277#else
3278 session->peer_cert_digest = NULL;
3279#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3280#endif /* MBEDTLS_X509_CRT_PARSE_C */
3281#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3282 session->ticket = NULL;
3283#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3284
3285 /*
3286 * Peer certificate
3287 */
3288#if defined(MBEDTLS_X509_CRT_PARSE_C)
3289#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3290 /* Deserialize CRT from the end of the ticket. */
3291 if (3 > (size_t) (end - p)) {
3292 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3293 }
3294
3295 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3296 p += 3;
3297
3298 if (cert_len != 0) {
3299 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3300
3301 if (cert_len > (size_t) (end - p)) {
3302 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3303 }
3304
3305 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3306
3307 if (session->peer_cert == NULL) {
3308 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3309 }
3310
3311 mbedtls_x509_crt_init(session->peer_cert);
3312
3313 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3314 p, cert_len)) != 0) {
3315 mbedtls_x509_crt_free(session->peer_cert);
3316 mbedtls_free(session->peer_cert);
3317 session->peer_cert = NULL;
3318 return ret;
3319 }
3320
3321 p += cert_len;
3322 }
3323#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3324 /* Deserialize CRT digest from the end of the ticket. */
3325 if (2 > (size_t) (end - p)) {
3326 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3327 }
3328
3329 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3330 session->peer_cert_digest_len = (size_t) *p++;
3331
3332 if (session->peer_cert_digest_len != 0) {
3333 const mbedtls_md_info_t *md_info =
3334 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3335 if (md_info == NULL) {
3336 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3337 }
3338 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3339 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3340 }
3341
3342 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3343 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3344 }
3345
3346 session->peer_cert_digest =
3347 mbedtls_calloc(1, session->peer_cert_digest_len);
3348 if (session->peer_cert_digest == NULL) {
3349 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3350 }
3351
3352 memcpy(session->peer_cert_digest, p,
3353 session->peer_cert_digest_len);
3354 p += session->peer_cert_digest_len;
3355 }
3356#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3357#endif /* MBEDTLS_X509_CRT_PARSE_C */
3358
3359 /*
3360 * Session ticket and associated data
3361 */
3362#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3363#if defined(MBEDTLS_SSL_CLI_C)
3364 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3365 if (3 > (size_t) (end - p)) {
3366 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3367 }
3368
3369 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3370 p += 3;
3371
3372 if (session->ticket_len != 0) {
3373 if (session->ticket_len > (size_t) (end - p)) {
3374 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3375 }
3376
3377 session->ticket = mbedtls_calloc(1, session->ticket_len);
3378 if (session->ticket == NULL) {
3379 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3380 }
3381
3382 memcpy(session->ticket, p, session->ticket_len);
3383 p += session->ticket_len;
3384 }
3385
3386 if (4 > (size_t) (end - p)) {
3387 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3388 }
3389
3390 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3391 p += 4;
3392 }
3393#endif /* MBEDTLS_SSL_CLI_C */
3394#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3395 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3396 if (8 > (size_t) (end - p)) {
3397 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3398 }
3399 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3400 p += 8;
3401 }
3402#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3403#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3404
3405 /*
3406 * Misc extension-related info
3407 */
3408#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3409 if (1 > (size_t) (end - p)) {
3410 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3411 }
3412
3413 session->mfl_code = *p++;
3414#endif
3415
3416#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3417 if (1 > (size_t) (end - p)) {
3418 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3419 }
3420
3421 session->encrypt_then_mac = *p++;
3422#endif
3423
3424 /* Done, should have consumed entire buffer */
3425 if (p != end) {
3426 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3427 }
3428
3429 return 0;
3430}
3431
3432#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3433
3434#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3435/* Serialization of TLS 1.3 sessions:
3436 *
David Horstmanncb01b362024-02-29 17:31:46 +00003437 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003438 */
3439#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3440MBEDTLS_CHECK_RETURN_CRITICAL
3441static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3442 unsigned char *buf,
3443 size_t buf_len,
3444 size_t *olen)
3445{
3446 unsigned char *p = buf;
3447#if defined(MBEDTLS_SSL_CLI_C) && \
3448 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3449 size_t hostname_len = (session->hostname == NULL) ?
3450 0 : strlen(session->hostname) + 1;
3451#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003452
3453#if defined(MBEDTLS_SSL_SRV_C) && \
3454 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003455 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003456 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003457#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003458 size_t needed = 4 /* ticket_age_add */
3459 + 1 /* ticket_flags */
3460 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003461
David Horstmanne59f9702024-02-29 16:08:57 +00003462 *olen = 0;
3463
3464 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3465 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3466 }
3467 needed += session->resumption_key_len; /* resumption_key */
3468
3469#if defined(MBEDTLS_SSL_EARLY_DATA)
3470 needed += 4; /* max_early_data_size */
3471#endif
3472#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3473 needed += 2; /* record_size_limit */
3474#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3475
3476#if defined(MBEDTLS_HAVE_TIME)
3477 needed += 8; /* ticket_creation_time or ticket_reception_time */
3478#endif
3479
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003480#if defined(MBEDTLS_SSL_SRV_C)
3481 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3482#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003483 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003484 + alpn_len; /* alpn */
3485#endif
3486 }
3487#endif /* MBEDTLS_SSL_SRV_C */
3488
David Horstmanne59f9702024-02-29 16:08:57 +00003489#if defined(MBEDTLS_SSL_CLI_C)
3490 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3491#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3492 needed += 2 /* hostname_len */
3493 + hostname_len; /* hostname */
3494#endif
3495
3496 needed += 4 /* ticket_lifetime */
3497 + 2; /* ticket_len */
3498
3499 /* Check size_t overflow */
3500 if (session->ticket_len > SIZE_MAX - needed) {
3501 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3502 }
3503
3504 needed += session->ticket_len; /* ticket */
3505 }
3506#endif /* MBEDTLS_SSL_CLI_C */
3507
3508 *olen = needed;
3509 if (needed > buf_len) {
3510 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3511 }
3512
3513 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3514 p[4] = session->ticket_flags;
3515
3516 /* save resumption_key */
3517 p[5] = session->resumption_key_len;
3518 p += 6;
3519 memcpy(p, session->resumption_key, session->resumption_key_len);
3520 p += session->resumption_key_len;
3521
3522#if defined(MBEDTLS_SSL_EARLY_DATA)
3523 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3524 p += 4;
3525#endif
3526#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3527 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3528 p += 2;
3529#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3530
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003531#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003532 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003533#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003534 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3535 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003536#endif /* MBEDTLS_HAVE_TIME */
3537
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003538#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003539 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3540 p += 2;
3541
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003542 if (alpn_len > 0) {
3543 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003544 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003545 p += alpn_len;
3546 }
3547#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3548 }
3549#endif /* MBEDTLS_SSL_SRV_C */
3550
David Horstmanne59f9702024-02-29 16:08:57 +00003551#if defined(MBEDTLS_SSL_CLI_C)
3552 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3553#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3554 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3555 p += 2;
3556 if (hostname_len > 0) {
3557 /* save host name */
3558 memcpy(p, session->hostname, hostname_len);
3559 p += hostname_len;
3560 }
3561#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3562
3563#if defined(MBEDTLS_HAVE_TIME)
3564 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3565 p += 8;
3566#endif
3567 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3568 p += 4;
3569
3570 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3571 p += 2;
3572
3573 if (session->ticket != NULL && session->ticket_len > 0) {
3574 memcpy(p, session->ticket, session->ticket_len);
3575 p += session->ticket_len;
3576 }
3577 }
3578#endif /* MBEDTLS_SSL_CLI_C */
3579 return 0;
3580}
3581
3582MBEDTLS_CHECK_RETURN_CRITICAL
3583static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3584 const unsigned char *buf,
3585 size_t len)
3586{
3587 const unsigned char *p = buf;
3588 const unsigned char *end = buf + len;
3589
3590 if (end - p < 6) {
3591 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3592 }
3593 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3594 session->ticket_flags = p[4];
3595
3596 /* load resumption_key */
3597 session->resumption_key_len = p[5];
3598 p += 6;
3599
3600 if (end - p < session->resumption_key_len) {
3601 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3602 }
3603
3604 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3605 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3606 }
3607 memcpy(session->resumption_key, p, session->resumption_key_len);
3608 p += session->resumption_key_len;
3609
3610#if defined(MBEDTLS_SSL_EARLY_DATA)
3611 if (end - p < 4) {
3612 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3613 }
3614 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3615 p += 4;
3616#endif
3617#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3618 if (end - p < 2) {
3619 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3620 }
3621 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3622 p += 2;
3623#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3624
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003625#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003626 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003627#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003628 if (end - p < 8) {
3629 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3630 }
3631 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3632 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003633#endif /* MBEDTLS_HAVE_TIME */
3634
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003635#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003636 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003637
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003638 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003639 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3640 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003641
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003642 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3643 p += 2;
3644
3645 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003646 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3647 }
3648
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003649 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003650 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3651 if (ret != 0) {
3652 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003653 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003654 p += alpn_len;
3655 }
3656#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3657 }
3658#endif /* MBEDTLS_SSL_SRV_C */
3659
David Horstmanne59f9702024-02-29 16:08:57 +00003660#if defined(MBEDTLS_SSL_CLI_C)
3661 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3662#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3663 size_t hostname_len;
3664 /* load host name */
3665 if (end - p < 2) {
3666 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3667 }
3668 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3669 p += 2;
3670
3671 if (end - p < (long int) hostname_len) {
3672 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3673 }
3674 if (hostname_len > 0) {
3675 session->hostname = mbedtls_calloc(1, hostname_len);
3676 if (session->hostname == NULL) {
3677 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3678 }
3679 memcpy(session->hostname, p, hostname_len);
3680 p += hostname_len;
3681 }
3682#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3683
3684#if defined(MBEDTLS_HAVE_TIME)
3685 if (end - p < 8) {
3686 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3687 }
3688 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3689 p += 8;
3690#endif
3691 if (end - p < 4) {
3692 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3693 }
3694 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3695 p += 4;
3696
3697 if (end - p < 2) {
3698 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3699 }
3700 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
3701 p += 2;
3702
3703 if (end - p < (long int) session->ticket_len) {
3704 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3705 }
3706 if (session->ticket_len > 0) {
3707 session->ticket = mbedtls_calloc(1, session->ticket_len);
3708 if (session->ticket == NULL) {
3709 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3710 }
3711 memcpy(session->ticket, p, session->ticket_len);
3712 p += session->ticket_len;
3713 }
3714 }
3715#endif /* MBEDTLS_SSL_CLI_C */
3716
3717 return 0;
3718
3719}
3720#else /* MBEDTLS_SSL_SESSION_TICKETS */
3721MBEDTLS_CHECK_RETURN_CRITICAL
3722static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3723 unsigned char *buf,
3724 size_t buf_len,
3725 size_t *olen)
3726{
3727 ((void) session);
3728 ((void) buf);
3729 ((void) buf_len);
3730 *olen = 0;
3731 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3732}
3733
3734static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01003735 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00003736 size_t buf_len)
3737{
3738 ((void) session);
3739 ((void) buf);
3740 ((void) buf_len);
3741 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3742}
3743#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
3744#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3745
Paul Bakker5121ce52009-01-03 21:22:43 +00003746/*
Hanno Beckera835da52019-05-16 12:39:07 +01003747 * Define ticket header determining Mbed TLS version
3748 * and structure of the ticket.
3749 */
3750
Hanno Becker94ef3b32019-05-16 12:50:45 +01003751/*
Hanno Becker50b59662019-05-28 14:30:45 +01003752 * Define bitflag determining compile-time settings influencing
3753 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003754 */
3755
Hanno Becker50b59662019-05-28 14:30:45 +01003756#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003757#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003758#else
Hanno Becker3e088662019-05-29 11:10:18 +01003759#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003760#endif /* MBEDTLS_HAVE_TIME */
3761
3762#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003763#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003764#else
Hanno Becker3e088662019-05-29 11:10:18 +01003765#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003766#endif /* MBEDTLS_X509_CRT_PARSE_C */
3767
David Horstmann5c5a32f2024-02-13 17:53:35 +00003768#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00003769#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00003770#else
David Horstmannf686f1d2024-03-01 11:20:32 +00003771#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00003772#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3773
Hanno Becker94ef3b32019-05-16 12:50:45 +01003774#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003775#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003776#else
Hanno Becker3e088662019-05-29 11:10:18 +01003777#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003778#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3779
3780#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003781#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003782#else
Hanno Becker3e088662019-05-29 11:10:18 +01003783#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003784#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3785
Hanno Becker94ef3b32019-05-16 12:50:45 +01003786#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003787#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003788#else
Hanno Becker3e088662019-05-29 11:10:18 +01003789#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003790#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3791
Hanno Becker94ef3b32019-05-16 12:50:45 +01003792#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3793#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3794#else
3795#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3796#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3797
David Horstmann92b258b2024-02-13 17:23:34 +00003798#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3799#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
3800#else
3801#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
3802#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3803
3804#if defined(MBEDTLS_SSL_EARLY_DATA)
3805#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
3806#else
3807#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
3808#endif /* MBEDTLS_SSL_EARLY_DATA */
3809
3810#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3811#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
3812#else
3813#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
3814#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3815
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003816#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
3817 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00003818#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
3819#else
3820#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
3821#endif /* MBEDTLS_SSL_ALPN */
3822
Hanno Becker3e088662019-05-29 11:10:18 +01003823#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3824#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3825#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3826#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003827#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3828#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00003829#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00003830#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
3831#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
3832#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00003833#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01003834
Hanno Becker50b59662019-05-28 14:30:45 +01003835#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003836 ((uint16_t) ( \
3837 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3838 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3839 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3840 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3841 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3842 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00003843 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00003844 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
3845 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00003846 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
3847 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
3848 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
3849 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003850 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00003851 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003852 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003853
Chien Wong4e9683e2023-12-28 17:07:43 +08003854static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003855 MBEDTLS_VERSION_MAJOR,
3856 MBEDTLS_VERSION_MINOR,
3857 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003858 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3859 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003860};
Hanno Beckera835da52019-05-16 12:39:07 +01003861
3862/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003863 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003864 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003865 *
David Horstmanncb01b362024-02-29 17:31:46 +00003866 * TLS 1.2 session:
3867 *
3868 * struct {
3869 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
3870 * opaque ticket<0..2^24-1>; // length 0 means no ticket
3871 * uint32 ticket_lifetime;
3872 * #endif
3873 * } ClientOnlyData;
3874 *
3875 * struct {
3876 * #if defined(MBEDTLS_HAVE_TIME)
3877 * uint64 start_time;
3878 * #endif
3879 * uint8 session_id_len; // at most 32
3880 * opaque session_id[32];
3881 * opaque master[48]; // fixed length in the standard
3882 * uint32 verify_result;
3883 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
3884 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
3885 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00003886 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00003887 * opaque peer_cert_digest<0..2^8-1>
3888 * #endif
3889 * select (endpoint) {
3890 * case client: ClientOnlyData;
3891 * case server: uint64 ticket_creation_time;
3892 * };
3893 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3894 * uint8 mfl_code; // up to 255 according to standard
3895 * #endif
3896 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3897 * uint8 encrypt_then_mac; // 0 or 1
3898 * #endif
3899 * } serialized_session_tls12;
3900 *
3901 *
3902 * TLS 1.3 Session:
3903 *
3904 * struct {
3905 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3906 * opaque hostname<0..2^16-1>;
3907 * #endif
3908 * #if defined(MBEDTLS_HAVE_TIME)
3909 * uint64 ticket_reception_time;
3910 * #endif
3911 * uint32 ticket_lifetime;
3912 * opaque ticket<1..2^16-1>;
3913 * } ClientOnlyData;
3914 *
3915 * struct {
3916 * uint32 ticket_age_add;
3917 * uint8 ticket_flags;
3918 * opaque resumption_key<0..255>;
3919 * #if defined(MBEDTLS_SSL_EARLY_DATA)
3920 * uint32 max_early_data_size;
3921 * #endif
3922 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3923 * uint16 record_size_limit;
3924 * #endif
3925 * select ( endpoint ) {
3926 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003927 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00003928 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003929 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00003930 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00003931 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003932 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00003933 * #endif
3934 * };
3935 * } serialized_session_tls13;
3936 *
3937 *
3938 * SSL session:
3939 *
3940 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003941 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003942 * opaque mbedtls_version[3]; // library version: major, minor, patch
3943 * opaque session_format[2]; // library-version specific 16-bit field
3944 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003945 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003946 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003947 * Note: When updating the format, remember to keep
3948 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003949 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003950 * // In this version, `session_format` determines
3951 * // the setting of those compile-time
3952 * // configuration options which influence
3953 * // the structure of mbedtls_ssl_session.
3954 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003955 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003956 * // - TLS 1.2 (0x0303)
3957 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00003958 * uint8_t endpoint;
3959 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003960 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003961 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003962 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003963 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003964 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003965 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003966 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003967 *
3968 * };
3969 *
3970 * } serialized_session;
3971 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003972 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003973
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003974MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003975static int ssl_session_save(const mbedtls_ssl_session *session,
3976 unsigned char omit_header,
3977 unsigned char *buf,
3978 size_t buf_len,
3979 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003980{
3981 unsigned char *p = buf;
3982 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003983 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003984#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3985 size_t out_len;
3986 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3987#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003988 if (session == NULL) {
3989 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3990 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003991
Gilles Peskine449bd832023-01-11 14:50:10 +01003992 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003993 /*
3994 * Add Mbed TLS version identifier
3995 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003996 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003997
Gilles Peskine449bd832023-01-11 14:50:10 +01003998 if (used <= buf_len) {
3999 memcpy(p, ssl_serialized_session_header,
4000 sizeof(ssl_serialized_session_header));
4001 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004002 }
4003 }
4004
4005 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004006 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004007 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004008 used += 1 /* TLS version */
4009 + 1 /* endpoint */
4010 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004011 if (used <= buf_len) {
4012 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004013 *p++ = session->endpoint;
4014 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4015 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004016 }
4017
4018 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004019 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004020 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004021#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004022 case MBEDTLS_SSL_VERSION_TLS1_2:
4023 used += ssl_tls12_session_save(session, p, remaining_len);
4024 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004025#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4026
Jerry Yu251a12e2022-07-13 15:15:48 +08004027#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004028 case MBEDTLS_SSL_VERSION_TLS1_3:
4029 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4030 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4031 return ret;
4032 }
4033 used += out_len;
4034 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004035#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4036
Gilles Peskine449bd832023-01-11 14:50:10 +01004037 default:
4038 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004039 }
4040
4041 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004042 if (used > buf_len) {
4043 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4044 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004045
Gilles Peskine449bd832023-01-11 14:50:10 +01004046 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004047}
4048
4049/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004050 * Public wrapper for ssl_session_save()
4051 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004052int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4053 unsigned char *buf,
4054 size_t buf_len,
4055 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004056{
Gilles Peskine449bd832023-01-11 14:50:10 +01004057 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004058}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004059
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004060/*
4061 * Deserialize session, see mbedtls_ssl_session_save() for format.
4062 *
4063 * This internal version is wrapped by a public function that cleans up in
4064 * case of error, and has an extra option omit_header.
4065 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004066MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004067static int ssl_session_load(mbedtls_ssl_session *session,
4068 unsigned char omit_header,
4069 const unsigned char *buf,
4070 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004071{
4072 const unsigned char *p = buf;
4073 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004074 size_t remaining_len;
4075
4076
Gilles Peskine449bd832023-01-11 14:50:10 +01004077 if (session == NULL) {
4078 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4079 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004080
Gilles Peskine449bd832023-01-11 14:50:10 +01004081 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004082 /*
4083 * Check Mbed TLS version identifier
4084 */
4085
Gilles Peskine449bd832023-01-11 14:50:10 +01004086 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4087 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004088 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004089
4090 if (memcmp(p, ssl_serialized_session_header,
4091 sizeof(ssl_serialized_session_header)) != 0) {
4092 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4093 }
4094 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004095 }
4096
4097 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004098 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004099 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004100 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004101 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4102 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004103 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004104 session->endpoint = *p++;
4105 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4106 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004107
4108 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004109 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004110 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004111#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004112 case MBEDTLS_SSL_VERSION_TLS1_2:
4113 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004114#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4115
Jerry Yu438ddd82022-07-07 06:55:50 +00004116#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004117 case MBEDTLS_SSL_VERSION_TLS1_3:
4118 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004119#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4120
Gilles Peskine449bd832023-01-11 14:50:10 +01004121 default:
4122 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004123 }
4124}
4125
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004126/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004127 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004128 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004129int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4130 const unsigned char *buf,
4131 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004132{
Gilles Peskine449bd832023-01-11 14:50:10 +01004133 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004134
Gilles Peskine449bd832023-01-11 14:50:10 +01004135 if (ret != 0) {
4136 mbedtls_ssl_session_free(session);
4137 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004138
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004140}
4141
4142/*
Paul Bakker1961b702013-01-25 14:49:24 +01004143 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004144 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004145MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004146static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004147{
4148 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4149
Ronald Cron66dbf912022-02-02 15:33:46 +01004150 /*
4151 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004152 * that were written into the output buffer by the previous handshake step,
4153 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004154 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4155 * We proceed to the next handshake step only when all data from the
4156 * previous one have been sent to the peer, thus we make sure that this is
4157 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4158 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4159 * we have to wait before to go ahead.
4160 * In the case of TLS 1.3, handshake step handlers do not send data to the
4161 * peer. Data are only sent here and through
4162 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004163 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004164 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004165 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4166 return ret;
4167 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004168
4169#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004170 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4171 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4172 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4173 return ret;
4174 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004175 }
4176#endif /* MBEDTLS_SSL_PROTO_DTLS */
4177
Gilles Peskine449bd832023-01-11 14:50:10 +01004178 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004179}
4180
Gilles Peskine449bd832023-01-11 14:50:10 +01004181int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004182{
Hanno Becker41934dd2021-08-07 19:13:43 +01004183 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004184
Gilles Peskine449bd832023-01-11 14:50:10 +01004185 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004186 ssl->conf == NULL ||
4187 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004188 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4189 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004190 }
4191
Gilles Peskine449bd832023-01-11 14:50:10 +01004192 ret = ssl_prepare_handshake_step(ssl);
4193 if (ret != 0) {
4194 return ret;
4195 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004196
Gilles Peskine449bd832023-01-11 14:50:10 +01004197 ret = mbedtls_ssl_handle_pending_alert(ssl);
4198 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004199 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004200 }
Jerry Yue7047812021-09-13 19:26:39 +08004201
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004202 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4203 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4204 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4205
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004206#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4208 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004209 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004210
Gilles Peskine449bd832023-01-11 14:50:10 +01004211 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004212 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskinef670ba52025-03-07 15:09:32 +01004213 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004214 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004215 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004216
Ronald Cron9f0fba32022-02-10 16:45:15 +01004217 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004218 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004219 break;
4220
4221 default:
4222#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4224 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4225 } else {
4226 ret = mbedtls_ssl_handshake_client_step(ssl);
4227 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004228#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004229 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004230#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004232#endif
4233 }
Jerry Yub9930e72021-08-06 17:11:51 +08004234 }
Ronald Cron6291b232023-03-08 15:51:25 +01004235#endif /* MBEDTLS_SSL_CLI_C */
4236
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004237#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004238 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004239#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4240 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004241 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004242 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004243 ret = mbedtls_ssl_handshake_server_step(ssl);
4244 }
Ronald Cron6291b232023-03-08 15:51:25 +01004245#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4246 ret = mbedtls_ssl_handshake_server_step(ssl);
4247#else
4248 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004249#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004250 }
4251#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004252
Gilles Peskine449bd832023-01-11 14:50:10 +01004253 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004254 /* handshake_step return error. And it is same
4255 * with alert_reason.
4256 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 if (ssl->send_alert) {
4258 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004259 goto cleanup;
4260 }
4261 }
4262
4263cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004265}
4266
4267/*
4268 * Perform the SSL handshake
4269 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004270int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004271{
4272 int ret = 0;
4273
Hanno Beckera817ea42020-10-20 15:20:23 +01004274 /* Sanity checks */
4275
Gilles Peskine449bd832023-01-11 14:50:10 +01004276 if (ssl == NULL || ssl->conf == NULL) {
4277 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4278 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004279
Hanno Beckera817ea42020-10-20 15:20:23 +01004280#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004281 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4282 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4283 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4284 "mbedtls_ssl_set_timer_cb() for DTLS"));
4285 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004286 }
4287#endif /* MBEDTLS_SSL_PROTO_DTLS */
4288
Gilles Peskine449bd832023-01-11 14:50:10 +01004289 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004290
Hanno Beckera817ea42020-10-20 15:20:23 +01004291 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004292 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4293 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004294
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004296 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004297 }
Paul Bakker1961b702013-01-25 14:49:24 +01004298 }
4299
Gilles Peskine449bd832023-01-11 14:50:10 +01004300 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004301
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004303}
4304
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004305#if defined(MBEDTLS_SSL_RENEGOTIATION)
4306#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004307/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004308 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004309 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004310MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004311static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004312{
Janos Follath865b3eb2019-12-16 11:46:15 +00004313 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004314
Gilles Peskine449bd832023-01-11 14:50:10 +01004315 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004316
4317 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004318 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4319 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004320
Gilles Peskine449bd832023-01-11 14:50:10 +01004321 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4322 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4323 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004324 }
4325
Gilles Peskine449bd832023-01-11 14:50:10 +01004326 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004327
Gilles Peskine449bd832023-01-11 14:50:10 +01004328 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004329}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004330#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004331
4332/*
4333 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004334 * - any side: calling mbedtls_ssl_renegotiate(),
4335 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4336 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004337 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004338 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004339 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004340 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004341int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004342{
Janos Follath865b3eb2019-12-16 11:46:15 +00004343 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004344
Gilles Peskine449bd832023-01-11 14:50:10 +01004345 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004346
Gilles Peskine449bd832023-01-11 14:50:10 +01004347 if ((ret = ssl_handshake_init(ssl)) != 0) {
4348 return ret;
4349 }
Paul Bakker48916f92012-09-16 19:57:18 +00004350
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004351 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4352 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004353#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004354 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4355 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4356 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004357 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004359 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004360 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004361 }
4362#endif
4363
Gilles Peskinef670ba52025-03-07 15:09:32 +01004364 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_REQUEST);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004365 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004366
Gilles Peskine449bd832023-01-11 14:50:10 +01004367 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4368 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4369 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004370 }
4371
Gilles Peskine449bd832023-01-11 14:50:10 +01004372 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004373
Gilles Peskine449bd832023-01-11 14:50:10 +01004374 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004375}
4376
4377/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004378 * Renegotiate current connection on client,
4379 * or request renegotiation on server
4380 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004381int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004382{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004383 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004384
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 if (ssl == NULL || ssl->conf == NULL) {
4386 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4387 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004388
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004389#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004390 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004391 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4392 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4393 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4394 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004395
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004396 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004397
4398 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 if (ssl->out_left != 0) {
4400 return mbedtls_ssl_flush_output(ssl);
4401 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004402
Gilles Peskine449bd832023-01-11 14:50:10 +01004403 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004404 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004405#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004406
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004407#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004408 /*
4409 * On client, either start the renegotiation process or,
4410 * if already in progress, continue the handshake
4411 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004412 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4413 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4414 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004415 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004416
4417 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4418 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4419 return ret;
4420 }
4421 } else {
4422 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4423 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4424 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004425 }
4426 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004427#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004428
Gilles Peskine449bd832023-01-11 14:50:10 +01004429 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004430}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004431#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004432
Gilles Peskine449bd832023-01-11 14:50:10 +01004433void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004434{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004435 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4436
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004438 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004439 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004440
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004441#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Brett Warrene0edc842021-08-17 09:53:13 +01004442#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004443 if (ssl->handshake->group_list_heap_allocated) {
4444 mbedtls_free((void *) handshake->group_list);
4445 }
Brett Warrene0edc842021-08-17 09:53:13 +01004446 handshake->group_list = NULL;
4447#endif /* MBEDTLS_DEPRECATED_REMOVED */
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004448#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Brett Warrene0edc842021-08-17 09:53:13 +01004449
Ronald Crone68ab4f2022-10-05 12:46:29 +02004450#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004451#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004452 if (ssl->handshake->sig_algs_heap_allocated) {
4453 mbedtls_free((void *) handshake->sig_algs);
4454 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004455 handshake->sig_algs = NULL;
4456#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004457#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004458 if (ssl->handshake->certificate_request_context) {
4459 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004460 }
4461#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004462#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004463
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004464#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Ben Taylorcd2660f2025-03-21 13:13:29 +00004465 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
Ben Taylorc12152e2025-03-21 11:03:04 +00004466 ssl->conf->f_async_cancel(ssl);
4467 handshake->async_in_progress = 0;
Ben Taylor1cd1e012025-03-18 11:50:39 +00004468 }
Ben Taylor6ff2da12025-03-17 09:26:20 +00004469
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004470#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4471
Elena Uziunaite0916cd72024-05-23 17:01:07 +01004472#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004474#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01004475#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01004476 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004477#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004478
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004479#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004480 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004481 /*
4482 * Opaque keys are not stored in the handshake's data and it's the user
4483 * responsibility to destroy them. Clear ones, instead, are created by
4484 * the TLS library and should be destroyed at the same level
4485 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004486 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4487 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004488 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004489 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004490#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004491 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004492 handshake->ecjpake_cache = NULL;
4493 handshake->ecjpake_cache_len = 0;
4494#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004495#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004496
Valerio Setti7aeec542023-07-05 18:57:21 +02004497#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004498 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004499 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004500 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004502#endif
4503
Ronald Cron73fe8df2022-10-05 14:31:43 +02004504#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004506 /* The maintenance of the external PSK key slot is the
4507 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 if (ssl->handshake->psk_opaque_is_internal) {
4509 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004510 ssl->handshake->psk_opaque_is_internal = 0;
4511 }
4512 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4513 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02004514#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004515
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004516#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4517 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004518 /*
4519 * Free only the linked list wrapper, not the keys themselves
4520 * since the belong to the SNI callback
4521 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004522 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004523#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004524
Gilles Peskineeccd8882020-03-10 12:19:08 +01004525#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004526 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4527 if (handshake->ecrs_peer_cert != NULL) {
4528 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4529 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004530 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004531#endif
4532
Hanno Becker75173122019-02-06 16:18:31 +00004533#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4534 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004535 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004536#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4537
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004538#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004539 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4540 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004541#endif /* MBEDTLS_SSL_CLI_C &&
4542 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004543
4544#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 mbedtls_ssl_flight_free(handshake->flight);
4546 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004547#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004548
Valerio Settiea59c432023-07-25 11:14:03 +02004549#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004550 if (handshake->xxdh_psa_privkey_is_external == 0) {
4551 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004552 }
Valerio Settiea59c432023-07-25 11:14:03 +02004553#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004554
Ronald Cron6f135e12021-12-08 16:57:54 +01004555#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004556 mbedtls_ssl_transform_free(handshake->transform_handshake);
4557 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004558#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004559 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4560 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004561#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004562#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004563
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004564
4565#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4566 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4567 * processes datagrams and the fact that a datagram is allowed to have
4568 * several records in it, it is possible that the I/O buffers are not
4569 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4571 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004572#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004573
Jerry Yuba9c7272021-10-30 11:54:10 +08004574 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004575 mbedtls_platform_zeroize(handshake,
4576 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004577}
4578
Gilles Peskine449bd832023-01-11 14:50:10 +01004579void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004580{
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004582 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004583 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004584
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004585#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004586 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004587#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004588
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004589#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004590#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4591 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004592 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004593#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004594 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004595#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004596
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004597#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4598 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004599 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004600#endif
4601
Gilles Peskine449bd832023-01-11 14:50:10 +01004602 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004603}
4604
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004605#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004606
4607#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4608#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4609#else
4610#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4611#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4612
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004613#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004614
4615#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4616#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4617#else
4618#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4619#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4620
4621#if defined(MBEDTLS_SSL_ALPN)
4622#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4623#else
4624#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4625#endif /* MBEDTLS_SSL_ALPN */
4626
4627#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4628#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4629#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4630#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4631
4632#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004633 ((uint32_t) ( \
4634 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4635 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4636 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4637 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4638 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4639 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4640 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4641 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004642
Chien Wong4e9683e2023-12-28 17:07:43 +08004643static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004644 MBEDTLS_VERSION_MAJOR,
4645 MBEDTLS_VERSION_MINOR,
4646 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4648 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4649 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4650 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4651 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004652};
4653
Paul Bakker5121ce52009-01-03 21:22:43 +00004654/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004655 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004656 *
4657 * The format of the serialized data is:
4658 * (in the presentation language of TLS, RFC 8446 section 3)
4659 *
4660 * // header
4661 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004662 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004663 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004664 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004665 * Note: When updating the format, remember to keep these
4666 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004667 *
4668 * // session sub-structure
4669 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4670 * // transform sub-structure
4671 * uint8 random[64]; // ServerHello.random+ClientHello.random
4672 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4673 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4674 * // fields from ssl_context
4675 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4676 * uint64 in_window_top; // DTLS: last validated record seq_num
4677 * uint64 in_window; // DTLS: bitmask for replay protection
4678 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4679 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4680 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4681 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4682 *
4683 * Note that many fields of the ssl_context or sub-structures are not
4684 * serialized, as they fall in one of the following categories:
4685 *
4686 * 1. forced value (eg in_left must be 0)
4687 * 2. pointer to dynamically-allocated memory (eg session, transform)
4688 * 3. value can be re-derived from other data (eg session keys from MS)
4689 * 4. value was temporary (eg content of input buffer)
4690 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004691 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004692int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4693 unsigned char *buf,
4694 size_t buf_len,
4695 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004696{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004697 unsigned char *p = buf;
4698 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004699 size_t session_len;
4700 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004701
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004702 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004703 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4704 * this function's documentation.
4705 *
4706 * These are due to assumptions/limitations in the implementation. Some of
4707 * them are likely to stay (no handshake in progress) some might go away
4708 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004709 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004710 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004711 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4712 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4713 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004714 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004715 if (ssl->handshake != NULL) {
4716 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4717 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004718 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004719 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004720 if (ssl->transform == NULL || ssl->session == NULL) {
4721 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4722 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004723 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004724 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 if (mbedtls_ssl_check_pending(ssl) != 0) {
4726 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4727 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004728 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004729 if (ssl->out_left != 0) {
4730 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4731 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004732 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004733 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004734 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4735 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4736 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004737 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004738 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4740 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4741 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004742 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004743 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4745 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4746 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004747 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004748 /* Renegotiation must not be enabled */
4749#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004750 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4751 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4752 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004753 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004754#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004755
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004756 /*
4757 * Version and format identifier
4758 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004760
Gilles Peskine449bd832023-01-11 14:50:10 +01004761 if (used <= buf_len) {
4762 memcpy(p, ssl_serialized_context_header,
4763 sizeof(ssl_serialized_context_header));
4764 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004765 }
4766
4767 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004768 * Session (length + data)
4769 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004770 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4771 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4772 return ret;
4773 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004774
4775 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004776 if (used <= buf_len) {
4777 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004778 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004779
Gilles Peskine449bd832023-01-11 14:50:10 +01004780 ret = ssl_session_save(ssl->session, 1,
4781 p, session_len, &session_len);
4782 if (ret != 0) {
4783 return ret;
4784 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004785
4786 p += session_len;
4787 }
4788
4789 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004790 * Transform
4791 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004792 used += sizeof(ssl->transform->randbytes);
4793 if (used <= buf_len) {
4794 memcpy(p, ssl->transform->randbytes,
4795 sizeof(ssl->transform->randbytes));
4796 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004797 }
4798
4799#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004800 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004801 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004802 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004803 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004804 p += ssl->transform->in_cid_len;
4805
4806 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004807 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004808 p += ssl->transform->out_cid_len;
4809 }
4810#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4811
4812 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004813 * Saved fields from top-level ssl_context structure
4814 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004815 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 if (used <= buf_len) {
4817 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004818 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004819 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004820
4821#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4822 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 if (used <= buf_len) {
4824 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004825 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004826
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004828 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004829 }
4830#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4831
4832#if defined(MBEDTLS_SSL_PROTO_DTLS)
4833 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004835 *p++ = ssl->disable_datagram_packing;
4836 }
4837#endif /* MBEDTLS_SSL_PROTO_DTLS */
4838
Jerry Yuae0b2e22021-10-08 15:21:19 +08004839 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004840 if (used <= buf_len) {
4841 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004842 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004843 }
4844
4845#if defined(MBEDTLS_SSL_PROTO_DTLS)
4846 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004847 if (used <= buf_len) {
4848 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004849 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004850 }
4851#endif /* MBEDTLS_SSL_PROTO_DTLS */
4852
4853#if defined(MBEDTLS_SSL_ALPN)
4854 {
4855 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004857 : 0;
4858
4859 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004861 *p++ = alpn_len;
4862
Gilles Peskine449bd832023-01-11 14:50:10 +01004863 if (ssl->alpn_chosen != NULL) {
4864 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004865 p += alpn_len;
4866 }
4867 }
4868 }
4869#endif /* MBEDTLS_SSL_ALPN */
4870
4871 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004872 * Done
4873 */
4874 *olen = used;
4875
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 if (used > buf_len) {
4877 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4878 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004879
Gilles Peskine449bd832023-01-11 14:50:10 +01004880 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004881
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004883}
4884
4885/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004886 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004887 *
4888 * This internal version is wrapped by a public function that cleans up in
4889 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004890 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004891MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004892static int ssl_context_load(mbedtls_ssl_context *ssl,
4893 const unsigned char *buf,
4894 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004895{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004896 const unsigned char *p = buf;
4897 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004898 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004899 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004900#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004901 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004902#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004903
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004904 /*
4905 * The context should have been freshly setup or reset.
4906 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004907 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004908 * renegotiating, or if the user mistakenly loaded a session first.)
4909 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004910 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4911 ssl->session != NULL) {
4912 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004913 }
4914
4915 /*
4916 * We can't check that the config matches the initial one, but we can at
4917 * least check it matches the requirements for serializing.
4918 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004919 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004920#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004921 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004922#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004923 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4924 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4925 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4926 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004927 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004928 }
4929
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004931
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004932 /*
4933 * Check version identifier
4934 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4936 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004937 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004938
4939 if (memcmp(p, ssl_serialized_context_header,
4940 sizeof(ssl_serialized_context_header)) != 0) {
4941 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4942 }
4943 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004944
4945 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004946 * Session
4947 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004948 if ((size_t) (end - p) < 4) {
4949 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4950 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004951
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004952 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004953 p += 4;
4954
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004955 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004956 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004957 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004958 ssl->session_in = ssl->session;
4959 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004960 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004961
Gilles Peskine449bd832023-01-11 14:50:10 +01004962 if ((size_t) (end - p) < session_len) {
4963 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4964 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004965
Gilles Peskine449bd832023-01-11 14:50:10 +01004966 ret = ssl_session_load(ssl->session, 1, p, session_len);
4967 if (ret != 0) {
4968 mbedtls_ssl_session_free(ssl->session);
4969 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004970 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004971
4972 p += session_len;
4973
4974 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004975 * Transform
4976 */
4977
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004978 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004979 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004980#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004981 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004982 ssl->transform_in = ssl->transform;
4983 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004984 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004985#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004986
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004987#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004988 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4989 if (prf_func == NULL) {
4990 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4991 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004992
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004993 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004994 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4995 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4996 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004997
Gilles Peskine449bd832023-01-11 14:50:10 +01004998 ret = ssl_tls12_populate_transform(ssl->transform,
4999 ssl->session->ciphersuite,
5000 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005001#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005002 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005003#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005004 prf_func,
5005 p, /* currently pointing to randbytes */
5006 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5007 ssl->conf->endpoint,
5008 ssl);
5009 if (ret != 0) {
5010 return ret;
5011 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005012#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005013 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005014
5015#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5016 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005017 if ((size_t) (end - p) < 1) {
5018 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5019 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005020
5021 ssl->transform->in_cid_len = *p++;
5022
Gilles Peskine449bd832023-01-11 14:50:10 +01005023 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5024 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5025 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005026
Gilles Peskine449bd832023-01-11 14:50:10 +01005027 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005028 p += ssl->transform->in_cid_len;
5029
5030 ssl->transform->out_cid_len = *p++;
5031
Gilles Peskine449bd832023-01-11 14:50:10 +01005032 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5033 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5034 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005035
Gilles Peskine449bd832023-01-11 14:50:10 +01005036 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005037 p += ssl->transform->out_cid_len;
5038#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5039
5040 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005041 * Saved fields from top-level ssl_context structure
5042 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005043 if ((size_t) (end - p) < 4) {
5044 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5045 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005046
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005047 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005048 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005049
5050#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005051 if ((size_t) (end - p) < 16) {
5052 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5053 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005054
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005055 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005056 p += 8;
5057
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005058 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005059 p += 8;
5060#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5061
5062#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005063 if ((size_t) (end - p) < 1) {
5064 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5065 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005066
5067 ssl->disable_datagram_packing = *p++;
5068#endif /* MBEDTLS_SSL_PROTO_DTLS */
5069
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5071 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5072 }
5073 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5074 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005075
5076#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 if ((size_t) (end - p) < 2) {
5078 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5079 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005080
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005081 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005082 p += 2;
5083#endif /* MBEDTLS_SSL_PROTO_DTLS */
5084
5085#if defined(MBEDTLS_SSL_ALPN)
5086 {
5087 uint8_t alpn_len;
Gilles Peskinec4949d12025-05-27 19:45:29 +02005088 const char *const *cur;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005089
Gilles Peskine449bd832023-01-11 14:50:10 +01005090 if ((size_t) (end - p) < 1) {
5091 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5092 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005093
5094 alpn_len = *p++;
5095
Gilles Peskine449bd832023-01-11 14:50:10 +01005096 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005097 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005098 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5099 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005100 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005101 ssl->alpn_chosen = *cur;
5102 break;
5103 }
5104 }
5105 }
5106
5107 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5109 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5110 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005111
5112 p += alpn_len;
5113 }
5114#endif /* MBEDTLS_SSL_ALPN */
5115
5116 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005117 * Forced fields from top-level ssl_context structure
5118 *
5119 * Most of them already set to the correct value by mbedtls_ssl_init() and
5120 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5121 */
Gilles Peskinef670ba52025-03-07 15:09:32 +01005122 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Glenn Strauss60bfe602022-03-14 19:04:24 -04005123 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005124
Hanno Becker361b10d2019-08-30 10:42:49 +01005125 /* Adjust pointers for header fields of outgoing records to
5126 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005127 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005128
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005129#if defined(MBEDTLS_SSL_PROTO_DTLS)
5130 ssl->in_epoch = 1;
5131#endif
5132
5133 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5134 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005135 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5136 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005137 if (ssl->handshake != NULL) {
5138 mbedtls_ssl_handshake_free(ssl);
5139 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005140 ssl->handshake = NULL;
5141 }
5142
5143 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005144 * Done - should have consumed entire buffer
5145 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005146 if (p != end) {
5147 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5148 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005149
Gilles Peskine449bd832023-01-11 14:50:10 +01005150 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005151}
5152
5153/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005154 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005155 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005156int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5157 const unsigned char *buf,
5158 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005159{
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005161
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 if (ret != 0) {
5163 mbedtls_ssl_free(context);
5164 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005165
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005167}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005168#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005169
5170/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005171 * Free an SSL context
5172 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005173void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005174{
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005176 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005177 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005178
Gilles Peskine449bd832023-01-11 14:50:10 +01005179 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005180
Gilles Peskine449bd832023-01-11 14:50:10 +01005181 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005182#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5183 size_t out_buf_len = ssl->out_buf_len;
5184#else
5185 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5186#endif
5187
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005188 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005189 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005190 }
5191
Gilles Peskine449bd832023-01-11 14:50:10 +01005192 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005193#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5194 size_t in_buf_len = ssl->in_buf_len;
5195#else
5196 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5197#endif
5198
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005199 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005200 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005201 }
5202
Gilles Peskine449bd832023-01-11 14:50:10 +01005203 if (ssl->transform) {
5204 mbedtls_ssl_transform_free(ssl->transform);
5205 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005206 }
5207
Gilles Peskine449bd832023-01-11 14:50:10 +01005208 if (ssl->handshake) {
5209 mbedtls_ssl_handshake_free(ssl);
5210 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005211
5212#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005213 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5214 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005215#endif
5216
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 mbedtls_ssl_session_free(ssl->session_negotiate);
5218 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005219 }
5220
Ronald Cron6f135e12021-12-08 16:57:54 +01005221#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005222 mbedtls_ssl_transform_free(ssl->transform_application);
5223 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005224#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005225
Gilles Peskine449bd832023-01-11 14:50:10 +01005226 if (ssl->session) {
5227 mbedtls_ssl_session_free(ssl->session);
5228 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005229 }
5230
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005231#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine4ac40082025-02-20 18:13:58 +01005232 mbedtls_ssl_free_hostname(ssl);
Paul Bakker0be444a2013-08-27 21:55:01 +02005233#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005234
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005235#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005236 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005237#endif
5238
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005240
Paul Bakker86f04f42013-02-14 11:20:09 +01005241 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005242 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005243}
5244
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005245/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005246 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005247 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005248void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005249{
Gilles Peskine449bd832023-01-11 14:50:10 +01005250 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005251}
5252
Gilles Peskineae270bf2021-06-02 00:05:29 +02005253/* The selection should be the same as mbedtls_x509_crt_profile_default in
5254 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005255 * curves with a lower resource usage come first.
Manuel Pégourié-Gonnard93d45912025-01-14 11:45:44 +01005256 * See the documentation of mbedtls_ssl_conf_groups() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005257 * about this list.
5258 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005259static const uint16_t ssl_preset_default_groups[] = {
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005260#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Brett Warrene0edc842021-08-17 09:53:13 +01005261 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005262#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005263#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005264 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005265#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005266#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005267 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005268#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005269#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Brett Warrene0edc842021-08-17 09:53:13 +01005270 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005271#endif
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005272#if defined(PSA_WANT_ECC_SECP_R1_521)
Brett Warrene0edc842021-08-17 09:53:13 +01005273 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005274#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005275#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005276 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005277#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005278#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005279 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005280#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005281#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Brett Warrene0edc842021-08-17 09:53:13 +01005282 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005283#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005284#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005285 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5286 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5287 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5288 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5289 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5290#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005291 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005292};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005293
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005294static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005295 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5296 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5297 0
5298};
5299
Ronald Crone68ab4f2022-10-05 12:46:29 +02005300#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005301
Jerry Yu909df7b2022-01-22 11:56:27 +08005302/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005303 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005304 * rules SHOULD be upheld.
5305 * - No duplicate entries.
5306 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005307 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005308 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005309 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005310static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005311
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005312#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005313 defined(PSA_WANT_ALG_SHA_256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005314 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005315 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005316 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5317#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005318
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005319#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005320 defined(PSA_WANT_ALG_SHA_384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005321 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005322 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005323 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5324#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005325
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005326#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Gabor Mezeic15ef932024-06-13 12:53:54 +02005327 defined(PSA_WANT_ALG_SHA_512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005328 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005329 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005330 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5331#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005332
Gabor Mezeic15ef932024-06-13 12:53:54 +02005333#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005334 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005335#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005336
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005337#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005338 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005339#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005340
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005341#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005342 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005343#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005344
Gabor Mezeic15ef932024-06-13 12:53:54 +02005345#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005346 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Gabor Mezeic15ef932024-06-13 12:53:54 +02005347#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005348
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005349#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005350 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005351#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005352
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005353#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005354 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005355#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005356
Gabor Mezei15b95a62022-05-09 16:37:58 +02005357 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005358};
5359
5360/* NOTICE: see above */
5361#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Deomid rojer Ryabkove2d71cc2024-03-18 12:32:30 +00005362static const uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005363
Gabor Mezeic15ef932024-06-13 12:53:54 +02005364#if defined(PSA_WANT_ALG_SHA_512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005365#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005366 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005367#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005368#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5369 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005370#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005371#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005372 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005373#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005374#endif /* PSA_WANT_ALG_SHA_512 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005375
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005376#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005377#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005378 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005379#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005380#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5381 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005382#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005383#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005384 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005385#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005386#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005387
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005388#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005389#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005390 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005391#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005392#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5393 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005394#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005395#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005396 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005397#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005398#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005399
Gabor Mezei15b95a62022-05-09 16:37:58 +02005400 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005401};
5402#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005403
Jerry Yu909df7b2022-01-22 11:56:27 +08005404/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005405static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005406
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005407#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005408 defined(PSA_WANT_ALG_SHA_256) && \
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005409 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005410 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005411 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5412#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005413
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005414#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005415 defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005416 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu53037892022-01-25 11:02:06 +08005417 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005418 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5419#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005420
Gabor Mezei15b95a62022-05-09 16:37:58 +02005421 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005422};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005423
Jerry Yu909df7b2022-01-22 11:56:27 +08005424/* NOTICE: see above */
5425#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Deomid rojer Ryabkov7dddc172024-03-20 00:43:34 +00005426static const uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005427
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005428#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005429#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005431#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005432#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005433
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005434#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005435#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005436 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005437#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005438#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005439
Gabor Mezei15b95a62022-05-09 16:37:58 +02005440 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005441};
Jerry Yu909df7b2022-01-22 11:56:27 +08005442#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5443
Ronald Crone68ab4f2022-10-05 12:46:29 +02005444#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005445
Chien Wong4e9683e2023-12-28 17:07:43 +08005446static const uint16_t ssl_preset_suiteb_groups[] = {
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005447#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005448 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005449#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005450#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005451 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005452#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005453 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005454};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005455
Ronald Crone68ab4f2022-10-05 12:46:29 +02005456#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005457/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005458 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005459MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005460static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005461{
5462 size_t i, j;
5463 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005464
Gilles Peskine449bd832023-01-11 14:50:10 +01005465 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5466 for (j = 0; j < i; j++) {
5467 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005468 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005469 }
5470 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5471 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5472 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005473 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005474 }
5475 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005476 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005477}
5478
Ronald Crone68ab4f2022-10-05 12:46:29 +02005479#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005480
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005481/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005482 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005483 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005484int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5485 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005486{
Ronald Crone68ab4f2022-10-05 12:46:29 +02005487#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005488 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5489 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5490 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005491 }
5492
Gilles Peskine449bd832023-01-11 14:50:10 +01005493 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5494 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5495 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005496 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005497
5498#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005499 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5500 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5501 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005502 }
5503
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5505 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5506 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005507 }
5508#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005509#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005510
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005511 /* Use the functions here so that they are covered in tests,
5512 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 mbedtls_ssl_conf_endpoint(conf, endpoint);
5514 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005515
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005516 /*
5517 * Things that are common to all presets
5518 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005519#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005520 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005521 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5522#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5523 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5524#endif
5525 }
5526#endif
5527
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005528#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5529 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5530#endif
5531
5532#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5533 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5534#endif
5535
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005536#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005537 conf->f_cookie_write = ssl_cookie_write_dummy;
5538 conf->f_cookie_check = ssl_cookie_check_dummy;
5539#endif
5540
5541#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5542 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5543#endif
5544
Janos Follath088ce432017-04-10 12:42:31 +01005545#if defined(MBEDTLS_SSL_SRV_C)
5546 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005547 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005548#endif
5549
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005550#if defined(MBEDTLS_SSL_PROTO_DTLS)
5551 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5552 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5553#endif
5554
5555#if defined(MBEDTLS_SSL_RENEGOTIATION)
5556 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005557 memset(conf->renego_period, 0x00, 2);
5558 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005559#endif
5560
Ronald Cron6f135e12021-12-08 16:57:54 +01005561#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005562
5563#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005564 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005565#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005566 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005567#endif
5568#endif /* MBEDTLS_SSL_EARLY_DATA */
5569
Jerry Yud0766ec2022-09-22 10:46:57 +08005570#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005571 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005572 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005573#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005574 /*
5575 * Allow all TLS 1.3 key exchange modes by default.
5576 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005577 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005578#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005579
Gilles Peskine449bd832023-01-11 14:50:10 +01005580 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005581#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005582 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005583 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005584#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005585 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005586#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005587 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005588#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005589 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5590 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005591#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5592 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5593 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5594#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5595 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5596 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5597#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005598 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005599#endif
5600 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005601
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005602 /*
5603 * Preset-specific defaults
5604 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005605 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005606 /*
5607 * NSA Suite B
5608 */
5609 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005610
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005611 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005612
5613#if defined(MBEDTLS_X509_CRT_PARSE_C)
5614 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005615#endif
5616
Ronald Crone68ab4f2022-10-05 12:46:29 +02005617#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005618#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005619 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005620 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005621 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005622#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005623 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005624#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005625
Brett Warrene0edc842021-08-17 09:53:13 +01005626 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005627 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005628
5629 /*
5630 * Default
5631 */
5632 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005633
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005634 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005635
5636#if defined(MBEDTLS_X509_CRT_PARSE_C)
5637 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5638#endif
5639
Ronald Crone68ab4f2022-10-05 12:46:29 +02005640#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005641#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005642 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005643 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005644 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005645#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005646 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005647#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005648
Brett Warrene0edc842021-08-17 09:53:13 +01005649 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005650 }
5651
Gilles Peskine449bd832023-01-11 14:50:10 +01005652 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005653}
5654
5655/*
5656 * Free mbedtls_ssl_config
5657 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005658void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005659{
Troy-Butlerda73abc2024-04-02 13:37:31 -04005660 if (conf == NULL) {
5661 return;
5662 }
5663
Ronald Cron73fe8df2022-10-05 14:31:43 +02005664#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005665 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005666 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5667 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005668 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005669 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005670 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005671 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005672 }
5673
Gilles Peskine449bd832023-01-11 14:50:10 +01005674 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005675 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005676 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005677 conf->psk_identity_len = 0;
5678 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005679#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005680
5681#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005682 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005683#endif
5684
Gilles Peskine449bd832023-01-11 14:50:10 +01005685 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005686}
5687
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005688#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005689 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005690/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005691 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005692 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005693unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005694{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005695#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005696 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5697 return MBEDTLS_SSL_SIG_RSA;
5698 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005699#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005700#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005701 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5702 return MBEDTLS_SSL_SIG_ECDSA;
5703 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005704#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005705 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005706}
5707
Gilles Peskine449bd832023-01-11 14:50:10 +01005708unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005709{
Gilles Peskine449bd832023-01-11 14:50:10 +01005710 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005711 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005712 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005713 case MBEDTLS_PK_ECDSA:
5714 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005715 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005716 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005717 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005718 }
5719}
5720
Gilles Peskine449bd832023-01-11 14:50:10 +01005721mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005722{
Gilles Peskine449bd832023-01-11 14:50:10 +01005723 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005724#if defined(MBEDTLS_RSA_C)
5725 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005727#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005728#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005729 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005730 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005731#endif
5732 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005733 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005734 }
5735}
Valerio Settie9646ec2023-08-02 20:02:28 +02005736#endif /* MBEDTLS_PK_C &&
5737 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005738
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005739/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005740 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005741 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005742mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005743{
Gilles Peskine449bd832023-01-11 14:50:10 +01005744 switch (hash) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005745#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005746 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005747 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005748#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005749#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005750 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005751 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005752#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005753#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005754 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005755 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005756#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005757#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005758 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005759 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005760#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005761#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005762 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005763 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005764#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005765#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005766 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005767 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005768#endif
5769 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005770 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005771 }
5772}
5773
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005774/*
5775 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5776 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005777unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005778{
Gilles Peskine449bd832023-01-11 14:50:10 +01005779 switch (md) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005780#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005781 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005782 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005783#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005784#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005785 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005786 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005787#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005788#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005789 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005790 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005791#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005792#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005793 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005794 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005795#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005796#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005797 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005798 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005799#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005800#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005801 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005802 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005803#endif
5804 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005805 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005806 }
5807}
5808
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005809/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005810 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005811 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005812 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005813int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005814{
Manuel Pégourié-Gonnard6402c352025-01-14 12:23:56 +01005815 const uint16_t *group_list = ssl->conf->group_list;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005816
Gilles Peskine449bd832023-01-11 14:50:10 +01005817 if (group_list == NULL) {
5818 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005819 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005820
Gilles Peskine449bd832023-01-11 14:50:10 +01005821 for (; *group_list != 0; group_list++) {
5822 if (*group_list == tls_id) {
5823 return 0;
5824 }
5825 }
5826
5827 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005828}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005829
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005830#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005831/*
5832 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5833 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005834int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005835{
Gilles Peskine449bd832023-01-11 14:50:10 +01005836 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005837
Gilles Peskine449bd832023-01-11 14:50:10 +01005838 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005839 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005840 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005841
Gilles Peskine449bd832023-01-11 14:50:10 +01005842 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005843}
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005844#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Valerio Setti67419f02023-01-04 16:12:42 +01005845
Valerio Setti18c9fed2022-12-30 17:44:24 +01005846static const struct {
5847 uint16_t tls_id;
5848 mbedtls_ecp_group_id ecp_group_id;
5849 psa_ecc_family_t psa_family;
5850 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005851} tls_id_match_table[] =
5852{
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005853#if defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02005854 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005855#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005856#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02005857 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005858#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005859#if defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005860 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005861#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005862#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005863 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005864#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005865#if defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005866 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005867#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005868#if defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005869 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005870#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005871#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005872 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005873#endif
Elena Uziunaiteeaa0cf02024-07-04 17:41:25 +01005874#if defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02005875 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005876#endif
Elena Uziunaitea3632862024-07-04 13:52:43 +01005877#if defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005878 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005879#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005880#if defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005881 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005882#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005883#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02005884 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005885#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005886#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005887 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005888#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005889 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005890};
5891
Gilles Peskine449bd832023-01-11 14:50:10 +01005892int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005893 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005894 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005895{
Gilles Peskine449bd832023-01-11 14:50:10 +01005896 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5897 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005898 if (type != NULL) {
5899 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005900 }
5901 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005902 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005903 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005904 return PSA_SUCCESS;
5905 }
5906 }
5907
5908 return PSA_ERROR_NOT_SUPPORTED;
5909}
5910
Gilles Peskine449bd832023-01-11 14:50:10 +01005911mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005912{
Gilles Peskine449bd832023-01-11 14:50:10 +01005913 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5914 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005915 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005916 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005917 }
5918
5919 return MBEDTLS_ECP_DP_NONE;
5920}
5921
Gilles Peskine449bd832023-01-11 14:50:10 +01005922uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005923{
Gilles Peskine449bd832023-01-11 14:50:10 +01005924 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5925 i++) {
5926 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005927 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005928 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005929 }
5930
5931 return 0;
5932}
5933
Valerio Setti67419f02023-01-04 16:12:42 +01005934#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005935static const struct {
5936 uint16_t tls_id;
5937 const char *name;
5938} tls_id_curve_name_table[] =
5939{
Valerio Setti54e23792023-07-07 10:49:27 +02005940 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5941 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5942 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5943 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5944 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5945 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5946 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5947 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5948 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5949 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5950 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5951 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5952 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005953 { 0, NULL },
5954};
5955
Gilles Peskine449bd832023-01-11 14:50:10 +01005956const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005957{
Valerio Settiacd32c02023-06-29 18:06:29 +02005958 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5959 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5960 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005961 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005962 }
5963
5964 return NULL;
5965}
Valerio Setti67419f02023-01-04 16:12:42 +01005966#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005967
Gilles Peskine449bd832023-01-11 14:50:10 +01005968int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5969 const mbedtls_md_type_t md,
5970 unsigned char *dst,
5971 size_t dst_len,
5972 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005973{
Ronald Cronf6893e12022-01-07 22:09:01 +01005974 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5975 psa_hash_operation_t *hash_operation_to_clone;
5976 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5977
Jerry Yu148165c2021-09-24 23:20:59 +08005978 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005979
Gilles Peskine449bd832023-01-11 14:50:10 +01005980 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005981#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005982 case MBEDTLS_MD_SHA384:
5983 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5984 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005985#endif
5986
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005987#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005988 case MBEDTLS_MD_SHA256:
5989 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5990 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005991#endif
5992
Gilles Peskine449bd832023-01-11 14:50:10 +01005993 default:
5994 goto exit;
5995 }
5996
5997 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5998 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005999 goto exit;
6000 }
6001
Gilles Peskine449bd832023-01-11 14:50:10 +01006002 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6003 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006004 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006005 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006006
6007exit:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006008#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006009 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006010 (void) ssl;
6011#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006012 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006013}
Jerry Yu24c0ec32021-09-09 14:21:07 +08006014
Ronald Crone68ab4f2022-10-05 12:46:29 +02006015#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006016/* mbedtls_ssl_parse_sig_alg_ext()
6017 *
6018 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6019 * value (TLS 1.3 RFC8446):
6020 * enum {
6021 * ....
6022 * ecdsa_secp256r1_sha256( 0x0403 ),
6023 * ecdsa_secp384r1_sha384( 0x0503 ),
6024 * ecdsa_secp521r1_sha512( 0x0603 ),
6025 * ....
6026 * } SignatureScheme;
6027 *
6028 * struct {
6029 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6030 * } SignatureSchemeList;
6031 *
6032 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6033 * value (TLS 1.2 RFC5246):
6034 * enum {
6035 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6036 * sha512(6), (255)
6037 * } HashAlgorithm;
6038 *
6039 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6040 * SignatureAlgorithm;
6041 *
6042 * struct {
6043 * HashAlgorithm hash;
6044 * SignatureAlgorithm signature;
6045 * } SignatureAndHashAlgorithm;
6046 *
6047 * SignatureAndHashAlgorithm
6048 * supported_signature_algorithms<2..2^16-2>;
6049 *
6050 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6051 * generalization of the TLS 1.2 signature algorithm extension.
6052 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6053 * `SignatureScheme` field of TLS 1.3
6054 *
6055 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006056int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6057 const unsigned char *buf,
6058 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006059{
6060 const unsigned char *p = buf;
6061 size_t supported_sig_algs_len = 0;
6062 const unsigned char *supported_sig_algs_end;
6063 uint16_t sig_alg;
6064 uint32_t common_idx = 0;
6065
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6067 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006068 p += 2;
6069
Gilles Peskine449bd832023-01-11 14:50:10 +01006070 memset(ssl->handshake->received_sig_algs, 0,
6071 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006072
Gilles Peskine449bd832023-01-11 14:50:10 +01006073 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006074 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006075 while (p < supported_sig_algs_end) {
6076 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6077 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006078 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006079 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6080 sig_alg,
6081 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006082#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006083 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6084 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6085 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006086 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006087 }
6088#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006089
Gilles Peskine449bd832023-01-11 14:50:10 +01006090 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6091 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006092
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006094 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6095 common_idx += 1;
6096 }
6097 }
6098 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 if (p != end) {
6100 MBEDTLS_SSL_DEBUG_MSG(1,
6101 ("Signature algorithms extension length misaligned"));
6102 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6103 MBEDTLS_ERR_SSL_DECODE_ERROR);
6104 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006105 }
6106
Gilles Peskine449bd832023-01-11 14:50:10 +01006107 if (common_idx == 0) {
6108 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6109 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6110 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6111 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006112 }
6113
Gabor Mezei15b95a62022-05-09 16:37:58 +02006114 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006116}
6117
Ronald Crone68ab4f2022-10-05 12:46:29 +02006118#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006119
Jerry Yudc7bd172022-02-17 13:44:15 +08006120#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6121
Jerry Yudc7bd172022-02-17 13:44:15 +08006122
Gilles Peskine449bd832023-01-11 14:50:10 +01006123static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6124 mbedtls_svc_key_id_t key,
6125 psa_algorithm_t alg,
6126 const unsigned char *raw_psk, size_t raw_psk_length,
6127 const unsigned char *seed, size_t seed_length,
6128 const unsigned char *label, size_t label_length,
6129 const unsigned char *other_secret,
6130 size_t other_secret_length,
6131 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006132{
6133 psa_status_t status;
6134
Gilles Peskine449bd832023-01-11 14:50:10 +01006135 status = psa_key_derivation_setup(derivation, alg);
6136 if (status != PSA_SUCCESS) {
6137 return status;
6138 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006139
Gilles Peskine449bd832023-01-11 14:50:10 +01006140 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6141 status = psa_key_derivation_input_bytes(derivation,
6142 PSA_KEY_DERIVATION_INPUT_SEED,
6143 seed, seed_length);
6144 if (status != PSA_SUCCESS) {
6145 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006146 }
6147
Gilles Peskine449bd832023-01-11 14:50:10 +01006148 if (other_secret != NULL) {
6149 status = psa_key_derivation_input_bytes(derivation,
6150 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6151 other_secret, other_secret_length);
6152 if (status != PSA_SUCCESS) {
6153 return status;
6154 }
6155 }
6156
6157 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006158 status = psa_key_derivation_input_bytes(
6159 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006160 raw_psk, raw_psk_length);
6161 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006162 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006163 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006164 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006165 if (status != PSA_SUCCESS) {
6166 return status;
6167 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006168
Gilles Peskine449bd832023-01-11 14:50:10 +01006169 status = psa_key_derivation_input_bytes(derivation,
6170 PSA_KEY_DERIVATION_INPUT_LABEL,
6171 label, label_length);
6172 if (status != PSA_SUCCESS) {
6173 return status;
6174 }
6175 } else {
6176 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006177 }
6178
Gilles Peskine449bd832023-01-11 14:50:10 +01006179 status = psa_key_derivation_set_capacity(derivation, capacity);
6180 if (status != PSA_SUCCESS) {
6181 return status;
6182 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006183
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006185}
6186
Andrzej Kurek57d10632022-10-24 10:32:01 -04006187#if defined(PSA_WANT_ALG_SHA_384) || \
6188 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006189MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006190static int tls_prf_generic(mbedtls_md_type_t md_type,
6191 const unsigned char *secret, size_t slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006192 const char *label, size_t label_len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006193 const unsigned char *random, size_t rlen,
6194 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006195{
6196 psa_status_t status;
6197 psa_algorithm_t alg;
6198 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6199 psa_key_derivation_operation_t derivation =
6200 PSA_KEY_DERIVATION_OPERATION_INIT;
6201
Gilles Peskine449bd832023-01-11 14:50:10 +01006202 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006203 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006204 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006205 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006206 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006207
6208 /* Normally a "secret" should be long enough to be impossible to
6209 * find by brute force, and in particular should not be empty. But
6210 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6211 * and for this use case it makes sense to have a 0-length "secret".
6212 * Since the key API doesn't allow importing a key of length 0,
6213 * keep master_key=0, which setup_psa_key_derivation() understands
6214 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006215 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006216 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006217 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6218 psa_set_key_algorithm(&key_attributes, alg);
6219 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006220
Gilles Peskine449bd832023-01-11 14:50:10 +01006221 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6222 if (status != PSA_SUCCESS) {
6223 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6224 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006225 }
6226
Gilles Peskine449bd832023-01-11 14:50:10 +01006227 status = setup_psa_key_derivation(&derivation,
6228 master_key, alg,
6229 NULL, 0,
6230 random, rlen,
6231 (unsigned char const *) label,
Max Fillingerf2dda152024-10-23 15:47:23 +02006232 label_len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006233 NULL, 0,
6234 dlen);
6235 if (status != PSA_SUCCESS) {
6236 psa_key_derivation_abort(&derivation);
6237 psa_destroy_key(master_key);
6238 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006239 }
6240
Gilles Peskine449bd832023-01-11 14:50:10 +01006241 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6242 if (status != PSA_SUCCESS) {
6243 psa_key_derivation_abort(&derivation);
6244 psa_destroy_key(master_key);
6245 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006246 }
6247
Gilles Peskine449bd832023-01-11 14:50:10 +01006248 status = psa_key_derivation_abort(&derivation);
6249 if (status != PSA_SUCCESS) {
6250 psa_destroy_key(master_key);
6251 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006252 }
6253
Gilles Peskine449bd832023-01-11 14:50:10 +01006254 if (!mbedtls_svc_key_id_is_null(master_key)) {
6255 status = psa_destroy_key(master_key);
6256 }
6257 if (status != PSA_SUCCESS) {
6258 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6259 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006260
Gilles Peskine449bd832023-01-11 14:50:10 +01006261 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006262}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006263#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006264
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006265#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006266MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006267static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6268 const char *label,
6269 const unsigned char *random, size_t rlen,
6270 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006271{
Gilles Peskine449bd832023-01-11 14:50:10 +01006272 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006273 label, strlen(label), random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006274}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006275#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006276
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006277#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006278MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006279static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6280 const char *label,
6281 const unsigned char *random, size_t rlen,
6282 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006283{
Gilles Peskine449bd832023-01-11 14:50:10 +01006284 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006285 label, strlen(label), random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006286}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006287#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006288
Jerry Yuf009d862022-02-17 14:01:37 +08006289/*
6290 * Set appropriate PRF function and other SSL / TLS1.2 functions
6291 *
6292 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006293 * - hash associated with the ciphersuite (only used by TLS 1.2)
6294 *
6295 * Outputs:
6296 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6297 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006298MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006299static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6300 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006301{
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006302#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006303 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006304 handshake->tls_prf = tls_prf_sha384;
6305 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6306 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006307 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006308#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006309#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuf009d862022-02-17 14:01:37 +08006310 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006311 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006312 handshake->tls_prf = tls_prf_sha256;
6313 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6314 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6315 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006316#else
Jerry Yuf009d862022-02-17 14:01:37 +08006317 {
Jerry Yuf009d862022-02-17 14:01:37 +08006318 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006319 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006320 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006321 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006322#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006323
Gilles Peskine449bd832023-01-11 14:50:10 +01006324 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006325}
Jerry Yud6ab2352022-02-17 14:03:43 +08006326
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006327/*
6328 * Compute master secret if needed
6329 *
6330 * Parameters:
6331 * [in/out] handshake
6332 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6333 * (PSA-PSK) ciphersuite_info, psk_opaque
6334 * [out] premaster (cleared)
6335 * [out] master
6336 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6337 * debug: conf->f_dbg, conf->p_dbg
6338 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006339 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006340 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006341MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006342static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6343 unsigned char *master,
6344 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006345{
6346 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6347
6348 /* cf. RFC 5246, Section 8.1:
6349 * "The master secret is always exactly 48 bytes in length." */
6350 size_t const master_secret_len = 48;
6351
6352#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6353 unsigned char session_hash[48];
6354#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6355
6356 /* The label for the KDF used for key expansion.
6357 * This is either "master secret" or "extended master secret"
6358 * depending on whether the Extended Master Secret extension
6359 * is used. */
6360 char const *lbl = "master secret";
6361
Przemek Stekielae4ed302022-04-05 17:15:55 +02006362 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006363 * - If the Extended Master Secret extension is not used,
6364 * this is ClientHello.Random + ServerHello.Random
6365 * (see Sect. 8.1 in RFC 5246).
6366 * - If the Extended Master Secret extension is used,
6367 * this is the transcript of the handshake so far.
6368 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006369 unsigned char const *seed = handshake->randbytes;
6370 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006371
6372#if !defined(MBEDTLS_DEBUG_C) && \
6373 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006374 !defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006375 ssl = NULL; /* make sure we don't use it except for those cases */
6376 (void) ssl;
6377#endif
6378
Gilles Peskine449bd832023-01-11 14:50:10 +01006379 if (handshake->resume != 0) {
6380 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6381 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006382 }
6383
6384#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006385 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006386 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006387 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006388 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6389 if (ret != 0) {
6390 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6391 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006392
Gilles Peskine449bd832023-01-11 14:50:10 +01006393 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6394 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006395 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006396#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006397
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006398#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006399 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006400 /* Perform PSK-to-MS expansion in a single step. */
6401 psa_status_t status;
6402 psa_algorithm_t alg;
6403 mbedtls_svc_key_id_t psk;
6404 psa_key_derivation_operation_t derivation =
6405 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006406 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006407
Gilles Peskine449bd832023-01-11 14:50:10 +01006408 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006409
Gilles Peskine449bd832023-01-11 14:50:10 +01006410 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006411
Gilles Peskine449bd832023-01-11 14:50:10 +01006412 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006413 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006414 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006415 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006416 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006417
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006418 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006419 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006420
Gilles Peskine449bd832023-01-11 14:50:10 +01006421 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006422 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006423 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006424 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006425 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006426 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
6427 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6428 other_secret = handshake->premaster + 2;
6429 break;
6430 default:
6431 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006432 }
6433
Gilles Peskine449bd832023-01-11 14:50:10 +01006434 status = setup_psa_key_derivation(&derivation, psk, alg,
6435 ssl->conf->psk, ssl->conf->psk_len,
6436 seed, seed_len,
6437 (unsigned char const *) lbl,
6438 (size_t) strlen(lbl),
6439 other_secret, other_secret_len,
6440 master_secret_len);
6441 if (status != PSA_SUCCESS) {
6442 psa_key_derivation_abort(&derivation);
6443 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006444 }
6445
Gilles Peskine449bd832023-01-11 14:50:10 +01006446 status = psa_key_derivation_output_bytes(&derivation,
6447 master,
6448 master_secret_len);
6449 if (status != PSA_SUCCESS) {
6450 psa_key_derivation_abort(&derivation);
6451 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006452 }
6453
Gilles Peskine449bd832023-01-11 14:50:10 +01006454 status = psa_key_derivation_abort(&derivation);
6455 if (status != PSA_SUCCESS) {
6456 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6457 }
6458 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006459#endif
6460 {
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006461#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006462 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006463 psa_status_t status;
6464 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6465 psa_key_derivation_operation_t derivation =
6466 PSA_KEY_DERIVATION_OPERATION_INIT;
6467
Gilles Peskine449bd832023-01-11 14:50:10 +01006468 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006469
6470 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6471
Gilles Peskine449bd832023-01-11 14:50:10 +01006472 status = psa_key_derivation_setup(&derivation, alg);
6473 if (status != PSA_SUCCESS) {
6474 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006475 }
6476
Gilles Peskine449bd832023-01-11 14:50:10 +01006477 status = psa_key_derivation_set_capacity(&derivation,
6478 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6479 if (status != PSA_SUCCESS) {
6480 psa_key_derivation_abort(&derivation);
6481 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006482 }
6483
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6485 &derivation);
6486 if (status != PSA_SUCCESS) {
6487 psa_key_derivation_abort(&derivation);
6488 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006489 }
6490
Gilles Peskine449bd832023-01-11 14:50:10 +01006491 status = psa_key_derivation_output_bytes(&derivation,
6492 handshake->premaster,
6493 handshake->pmslen);
6494 if (status != PSA_SUCCESS) {
6495 psa_key_derivation_abort(&derivation);
6496 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6497 }
6498
6499 status = psa_key_derivation_abort(&derivation);
6500 if (status != PSA_SUCCESS) {
6501 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006502 }
6503 }
6504#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006505 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6506 lbl, seed, seed_len,
6507 master,
6508 master_secret_len);
6509 if (ret != 0) {
6510 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6511 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006512 }
6513
Gilles Peskine449bd832023-01-11 14:50:10 +01006514 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6515 handshake->premaster,
6516 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006517
Gilles Peskine449bd832023-01-11 14:50:10 +01006518 mbedtls_platform_zeroize(handshake->premaster,
6519 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006520 }
6521
Gilles Peskine449bd832023-01-11 14:50:10 +01006522 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006523}
6524
Gilles Peskine449bd832023-01-11 14:50:10 +01006525int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006526{
6527 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6528 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6529 ssl->handshake->ciphersuite_info;
6530
Gilles Peskine449bd832023-01-11 14:50:10 +01006531 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006532
6533 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006534 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006535 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006536 if (ret != 0) {
6537 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6538 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006539 }
6540
6541 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 ret = ssl_compute_master(ssl->handshake,
6543 ssl->session_negotiate->master,
6544 ssl);
6545 if (ret != 0) {
6546 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6547 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006548 }
6549
6550 /* Swap the client and server random values:
6551 * - MS derivation wanted client+server (RFC 5246 8.1)
6552 * - key derivation wants server+client (RFC 5246 6.3) */
6553 {
6554 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006555 memcpy(tmp, ssl->handshake->randbytes, 64);
6556 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6557 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6558 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006559 }
6560
6561 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006562 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6563 ssl->session_negotiate->ciphersuite,
6564 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006565#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006566 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006567#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006568 ssl->handshake->tls_prf,
6569 ssl->handshake->randbytes,
6570 ssl->tls_version,
6571 ssl->conf->endpoint,
6572 ssl);
6573 if (ret != 0) {
6574 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6575 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006576 }
6577
6578 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006579 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6580 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006581
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006583
Gilles Peskine449bd832023-01-11 14:50:10 +01006584 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006585}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006586
Gilles Peskine449bd832023-01-11 14:50:10 +01006587int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006588{
Gilles Peskine449bd832023-01-11 14:50:10 +01006589 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006590#if defined(PSA_WANT_ALG_SHA_384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006591 case MBEDTLS_SSL_HASH_SHA384:
6592 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6593 break;
6594#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006595#if defined(PSA_WANT_ALG_SHA_256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006596 case MBEDTLS_SSL_HASH_SHA256:
6597 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6598 break;
6599#endif
6600 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006601 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006602 }
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006603#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006604 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006605 (void) ssl;
6606#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006607 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006608}
6609
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006610static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6611 const psa_hash_operation_t *hs_op,
6612 size_t buffer_size,
6613 unsigned char *hash,
6614 size_t *hlen)
6615{
6616 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006617 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006618
6619#if !defined(MBEDTLS_DEBUG_C)
6620 (void) ssl;
6621#endif
6622 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006623 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006624 if (status != PSA_SUCCESS) {
6625 goto exit;
6626 }
6627
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006628 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006629 if (status != PSA_SUCCESS) {
6630 goto exit;
6631 }
6632
6633 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6634 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6635
6636exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006637 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006638 return mbedtls_md_error_from_psa(status);
6639}
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006640
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006641#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006642int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6643 unsigned char *hash,
6644 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006645{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006646 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6647 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006648}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006649#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006650
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006651#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006652int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6653 unsigned char *hash,
6654 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006655{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006656 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6657 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006658}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006659#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006660
Jerry Yuc2c673d2022-02-17 14:20:39 +08006661#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006662MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006663static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006664
6665#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006666int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006667{
6668 /* If renegotiation is not enforced, retransmit until we would reach max
6669 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006670 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006671 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6672 unsigned char doublings = 1;
6673
Gilles Peskine449bd832023-01-11 14:50:10 +01006674 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006675 ++doublings;
6676 ratio >>= 1;
6677 }
6678
Gilles Peskine449bd832023-01-11 14:50:10 +01006679 if (++ssl->renego_records_seen > doublings) {
6680 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6681 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006682 }
6683 }
6684
Gilles Peskine449bd832023-01-11 14:50:10 +01006685 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006686}
6687#endif
6688#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006689
Jerry Yud9526692022-02-17 14:23:47 +08006690/*
6691 * Handshake functions
6692 */
6693#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6694/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006695int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006696{
6697 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6698 ssl->handshake->ciphersuite_info;
6699
Gilles Peskine449bd832023-01-11 14:50:10 +01006700 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006701
Gilles Peskine449bd832023-01-11 14:50:10 +01006702 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6703 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006704 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006705 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006706 }
6707
Gilles Peskine449bd832023-01-11 14:50:10 +01006708 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6709 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006710}
6711
Gilles Peskine449bd832023-01-11 14:50:10 +01006712int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006713{
6714 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6715 ssl->handshake->ciphersuite_info;
6716
Gilles Peskine449bd832023-01-11 14:50:10 +01006717 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006718
Gilles Peskine449bd832023-01-11 14:50:10 +01006719 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6720 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006721 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006722 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006723 }
6724
Gilles Peskine449bd832023-01-11 14:50:10 +01006725 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6726 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006727}
6728
6729#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6730/* Some certificate support -> implement write and parse */
6731
Gilles Peskine449bd832023-01-11 14:50:10 +01006732int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006733{
6734 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6735 size_t i, n;
6736 const mbedtls_x509_crt *crt;
6737 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6738 ssl->handshake->ciphersuite_info;
6739
Gilles Peskine449bd832023-01-11 14:50:10 +01006740 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006741
Gilles Peskine449bd832023-01-11 14:50:10 +01006742 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6743 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006744 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006745 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006746 }
6747
6748#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006749 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6750 if (ssl->handshake->client_auth == 0) {
6751 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006752 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006753 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006754 }
6755 }
6756#endif /* MBEDTLS_SSL_CLI_C */
6757#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006758 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6759 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006760 /* Should never happen because we shouldn't have picked the
6761 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006762 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006763 }
6764 }
6765#endif
6766
Gilles Peskine449bd832023-01-11 14:50:10 +01006767 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006768
6769 /*
6770 * 0 . 0 handshake type
6771 * 1 . 3 handshake length
6772 * 4 . 6 length of all certs
6773 * 7 . 9 length of cert. 1
6774 * 10 . n-1 peer certificate
6775 * n . n+2 length of cert. 2
6776 * n+3 . ... upper level cert, etc.
6777 */
6778 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006779 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006780
Gilles Peskine449bd832023-01-11 14:50:10 +01006781 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006782 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006783 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6784 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6785 " > %" MBEDTLS_PRINTF_SIZET,
6786 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6787 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006788 }
6789
Gilles Peskine449bd832023-01-11 14:50:10 +01006790 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6791 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6792 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006793
Gilles Peskine449bd832023-01-11 14:50:10 +01006794 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006795 i += n; crt = crt->next;
6796 }
6797
Gilles Peskine449bd832023-01-11 14:50:10 +01006798 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6799 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6800 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006801
6802 ssl->out_msglen = i;
6803 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6804 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6805
Gilles Peskinef670ba52025-03-07 15:09:32 +01006806 mbedtls_ssl_handshake_increment_state(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006807
Gilles Peskine449bd832023-01-11 14:50:10 +01006808 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
6809 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
6810 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006811 }
6812
Gilles Peskine449bd832023-01-11 14:50:10 +01006813 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006814
Gilles Peskine449bd832023-01-11 14:50:10 +01006815 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006816}
6817
6818#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6819
6820#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006821MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006822static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6823 unsigned char *crt_buf,
6824 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006825{
6826 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6827
Gilles Peskine449bd832023-01-11 14:50:10 +01006828 if (peer_crt == NULL) {
6829 return -1;
6830 }
Jerry Yud9526692022-02-17 14:23:47 +08006831
Gilles Peskine449bd832023-01-11 14:50:10 +01006832 if (peer_crt->raw.len != crt_buf_len) {
6833 return -1;
6834 }
Jerry Yud9526692022-02-17 14:23:47 +08006835
Gilles Peskine449bd832023-01-11 14:50:10 +01006836 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08006837}
6838#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006839MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006840static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6841 unsigned char *crt_buf,
6842 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006843{
6844 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6845 unsigned char const * const peer_cert_digest =
6846 ssl->session->peer_cert_digest;
6847 mbedtls_md_type_t const peer_cert_digest_type =
6848 ssl->session->peer_cert_digest_type;
6849 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01006850 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08006851 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6852 size_t digest_len;
6853
Gilles Peskine449bd832023-01-11 14:50:10 +01006854 if (peer_cert_digest == NULL || digest_info == NULL) {
6855 return -1;
6856 }
Jerry Yud9526692022-02-17 14:23:47 +08006857
Gilles Peskine449bd832023-01-11 14:50:10 +01006858 digest_len = mbedtls_md_get_size(digest_info);
6859 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
6860 return -1;
6861 }
Jerry Yud9526692022-02-17 14:23:47 +08006862
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
6864 if (ret != 0) {
6865 return -1;
6866 }
Jerry Yud9526692022-02-17 14:23:47 +08006867
Gilles Peskine449bd832023-01-11 14:50:10 +01006868 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08006869}
6870#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6871#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6872
6873/*
6874 * Once the certificate message is read, parse it into a cert chain and
6875 * perform basic checks, but leave actual verification to the caller
6876 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006877MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006878static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
6879 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08006880{
6881 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6882#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006883 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08006884#endif
6885 size_t i, n;
6886 uint8_t alert;
6887
Gilles Peskine449bd832023-01-11 14:50:10 +01006888 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
6889 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6890 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6891 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6892 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006893 }
6894
Gilles Peskine449bd832023-01-11 14:50:10 +01006895 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
6896 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6897 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6898 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006899 }
6900
Gilles Peskine449bd832023-01-11 14:50:10 +01006901 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
6902 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6903 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6904 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6905 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006906 }
6907
Gilles Peskine449bd832023-01-11 14:50:10 +01006908 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006909
6910 /*
6911 * Same message structure as in mbedtls_ssl_write_certificate()
6912 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006913 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006914
Gilles Peskine449bd832023-01-11 14:50:10 +01006915 if (ssl->in_msg[i] != 0 ||
6916 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
6917 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6918 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6919 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6920 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006921 }
6922
6923 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6924 i += 3;
6925
6926 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006927 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08006928 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006929 if (i + 3 > ssl->in_hslen) {
6930 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6931 mbedtls_ssl_send_alert_message(ssl,
6932 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6933 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6934 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006935 }
6936 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6937 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006938 if (ssl->in_msg[i] != 0) {
6939 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6940 mbedtls_ssl_send_alert_message(ssl,
6941 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6942 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
6943 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08006944 }
6945
6946 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006947 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006948 i += 3;
6949
Gilles Peskine449bd832023-01-11 14:50:10 +01006950 if (n < 128 || i + n > ssl->in_hslen) {
6951 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6952 mbedtls_ssl_send_alert_message(ssl,
6953 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6954 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6955 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006956 }
6957
6958 /* Check if we're handling the first CRT in the chain. */
6959#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006960 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08006961 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01006962 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08006963 /* During client-side renegotiation, check that the server's
6964 * end-CRTs hasn't changed compared to the initial handshake,
6965 * mitigating the triple handshake attack. On success, reuse
6966 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006967 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
6968 if (ssl_check_peer_crt_unchanged(ssl,
6969 &ssl->in_msg[i],
6970 n) != 0) {
6971 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
6972 mbedtls_ssl_send_alert_message(ssl,
6973 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6974 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
6975 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08006976 }
6977
6978 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006979 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08006980 }
6981#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6982
6983 /* Parse the next certificate in the chain. */
6984#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006985 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08006986#else
6987 /* If we don't need to store the CRT chain permanently, parse
6988 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006989 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08006990#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01006991 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08006992 case 0: /*ok*/
Gilles Peskine4c832212025-05-07 23:05:12 +02006993 case MBEDTLS_ERR_X509_UNKNOWN_OID:
Jerry Yud9526692022-02-17 14:23:47 +08006994 /* Ignore certificate with an unknown algorithm: maybe a
6995 prior certificate was already trusted. */
6996 break;
6997
6998 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6999 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7000 goto crt_parse_der_failed;
7001
7002 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7003 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7004 goto crt_parse_der_failed;
7005
7006 default:
7007 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007008crt_parse_der_failed:
7009 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7010 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7011 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007012 }
7013
7014 i += n;
7015 }
7016
Gilles Peskine449bd832023-01-11 14:50:10 +01007017 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7018 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007019}
7020
7021#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007022MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007023static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007024{
Gilles Peskine449bd832023-01-11 14:50:10 +01007025 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7026 return -1;
7027 }
Jerry Yud9526692022-02-17 14:23:47 +08007028
Gilles Peskine449bd832023-01-11 14:50:10 +01007029 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007030 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7031 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007032 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7033 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7034 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007035 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007036 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007037}
7038#endif /* MBEDTLS_SSL_SRV_C */
7039
7040/* Check if a certificate message is expected.
7041 * Return either
7042 * - SSL_CERTIFICATE_EXPECTED, or
7043 * - SSL_CERTIFICATE_SKIP
7044 * indicating whether a Certificate message is expected or not.
7045 */
7046#define SSL_CERTIFICATE_EXPECTED 0
7047#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007048MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007049static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7050 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007051{
7052 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7053 ssl->handshake->ciphersuite_info;
7054
Gilles Peskine449bd832023-01-11 14:50:10 +01007055 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7056 return SSL_CERTIFICATE_SKIP;
7057 }
Jerry Yud9526692022-02-17 14:23:47 +08007058
7059#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007060 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007061 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007062 ssl->session_negotiate->verify_result =
7063 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007064 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007065 }
7066 }
7067#else
7068 ((void) authmode);
7069#endif /* MBEDTLS_SSL_SRV_C */
7070
Gilles Peskine449bd832023-01-11 14:50:10 +01007071 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007072}
7073
Jerry Yud9526692022-02-17 14:23:47 +08007074#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007075MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007076static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7077 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007078{
7079 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7080 /* Remember digest of the peer's end-CRT. */
7081 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007082 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7083 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7084 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7085 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7086 mbedtls_ssl_send_alert_message(ssl,
7087 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7088 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007089
Gilles Peskine449bd832023-01-11 14:50:10 +01007090 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007091 }
7092
Gilles Peskine449bd832023-01-11 14:50:10 +01007093 ret = mbedtls_md(mbedtls_md_info_from_type(
7094 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7095 start, len,
7096 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007097
7098 ssl->session_negotiate->peer_cert_digest_type =
7099 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7100 ssl->session_negotiate->peer_cert_digest_len =
7101 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7102
Gilles Peskine449bd832023-01-11 14:50:10 +01007103 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007104}
7105
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007106MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007107static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7108 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007109{
7110 unsigned char *end = start + len;
7111 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7112
7113 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007114 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7115 ret = mbedtls_pk_parse_subpubkey(&start, end,
7116 &ssl->handshake->peer_pubkey);
7117 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007118 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007119 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007120 }
7121
Gilles Peskine449bd832023-01-11 14:50:10 +01007122 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007123}
7124#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7125
Gilles Peskine449bd832023-01-11 14:50:10 +01007126int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007127{
7128 int ret = 0;
7129 int crt_expected;
Manuel Pégourié-Gonnard58ab9ba2024-08-14 09:47:38 +02007130 /* Authmode: precedence order is SNI if used else configuration */
Jerry Yud9526692022-02-17 14:23:47 +08007131#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7132 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7133 ? ssl->handshake->sni_authmode
7134 : ssl->conf->authmode;
7135#else
7136 const int authmode = ssl->conf->authmode;
7137#endif
7138 void *rs_ctx = NULL;
7139 mbedtls_x509_crt *chain = NULL;
7140
Gilles Peskine449bd832023-01-11 14:50:10 +01007141 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007142
Gilles Peskine449bd832023-01-11 14:50:10 +01007143 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7144 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7145 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007146 goto exit;
7147 }
7148
7149#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007150 if (ssl->handshake->ecrs_enabled &&
7151 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007152 chain = ssl->handshake->ecrs_peer_cert;
7153 ssl->handshake->ecrs_peer_cert = NULL;
7154 goto crt_verify;
7155 }
7156#endif
7157
Gilles Peskine449bd832023-01-11 14:50:10 +01007158 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007159 /* mbedtls_ssl_read_record may have sent an alert already. We
7160 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007161 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007162 goto exit;
7163 }
7164
7165#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007166 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007167 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7168
Gilles Peskine449bd832023-01-11 14:50:10 +01007169 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007170 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007171 }
Jerry Yud9526692022-02-17 14:23:47 +08007172
7173 goto exit;
7174 }
7175#endif /* MBEDTLS_SSL_SRV_C */
7176
7177 /* Clear existing peer CRT structure in case we tried to
7178 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007179 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007180
Gilles Peskine449bd832023-01-11 14:50:10 +01007181 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7182 if (chain == NULL) {
7183 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7184 sizeof(mbedtls_x509_crt)));
7185 mbedtls_ssl_send_alert_message(ssl,
7186 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7187 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007188
7189 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7190 goto exit;
7191 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007192 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007193
Gilles Peskine449bd832023-01-11 14:50:10 +01007194 ret = ssl_parse_certificate_chain(ssl, chain);
7195 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007196 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 }
Jerry Yud9526692022-02-17 14:23:47 +08007198
7199#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007200 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007201 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007202 }
Jerry Yud9526692022-02-17 14:23:47 +08007203
7204crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007205 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007206 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007207 }
Jerry Yud9526692022-02-17 14:23:47 +08007208#endif
7209
Manuel Pégourié-Gonnard19dd9f52024-08-16 11:03:42 +02007210 ret = mbedtls_ssl_verify_certificate(ssl, authmode, chain,
7211 ssl->handshake->ciphersuite_info,
7212 rs_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +01007213 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007214 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007215 }
Jerry Yud9526692022-02-17 14:23:47 +08007216
7217#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7218 {
7219 unsigned char *crt_start, *pk_start;
7220 size_t crt_len, pk_len;
7221
7222 /* We parse the CRT chain without copying, so
7223 * these pointers point into the input buffer,
7224 * and are hence still valid after freeing the
7225 * CRT chain. */
7226
7227 crt_start = chain->raw.p;
7228 crt_len = chain->raw.len;
7229
7230 pk_start = chain->pk_raw.p;
7231 pk_len = chain->pk_raw.len;
7232
7233 /* Free the CRT structures before computing
7234 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007235 mbedtls_x509_crt_free(chain);
7236 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007237 chain = NULL;
7238
Gilles Peskine449bd832023-01-11 14:50:10 +01007239 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7240 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007241 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007242 }
Jerry Yud9526692022-02-17 14:23:47 +08007243
Gilles Peskine449bd832023-01-11 14:50:10 +01007244 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7245 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007246 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007247 }
Jerry Yud9526692022-02-17 14:23:47 +08007248 }
7249#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7250 /* Pass ownership to session structure. */
7251 ssl->session_negotiate->peer_cert = chain;
7252 chain = NULL;
7253#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7254
Gilles Peskine449bd832023-01-11 14:50:10 +01007255 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007256
7257exit:
7258
Gilles Peskine449bd832023-01-11 14:50:10 +01007259 if (ret == 0) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007260 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007261 }
Jerry Yud9526692022-02-17 14:23:47 +08007262
7263#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007264 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007265 ssl->handshake->ecrs_peer_cert = chain;
7266 chain = NULL;
7267 }
7268#endif
7269
Gilles Peskine449bd832023-01-11 14:50:10 +01007270 if (chain != NULL) {
7271 mbedtls_x509_crt_free(chain);
7272 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007273 }
7274
Gilles Peskine449bd832023-01-11 14:50:10 +01007275 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007276}
7277#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7278
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007279static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7280 unsigned char *padbuf, size_t hlen,
7281 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007282{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007283 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007284 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007285 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007286 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007287 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007288 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007289
7290 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007291 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007292 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007293 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007294
Gilles Peskine449bd832023-01-11 14:50:10 +01007295 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007296 ? "client finished"
7297 : "server finished";
7298
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007299 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007300
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007301 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007302 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007303 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007304 }
7305
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007306 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007307 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007308 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007309 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007310 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007311
7312 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7313
Jerry Yu615bd6f2022-02-17 14:25:15 +08007314 /*
7315 * TLSv1.2:
7316 * hash = PRF( master, finished_label,
7317 * Hash( handshake ) )[0.11]
7318 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007319 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007320 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007321
Gilles Peskine449bd832023-01-11 14:50:10 +01007322 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007323
Paul Elliottecb95be2023-08-11 16:41:04 +01007324 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007325
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007326 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007327
7328exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007329 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007330 return mbedtls_md_error_from_psa(status);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007331}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007332
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007333#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007334static int ssl_calc_finished_tls_sha256(
7335 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7336{
7337 unsigned char padbuf[32];
7338 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007339 &ssl->handshake->fin_sha256_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007340 padbuf, sizeof(padbuf),
7341 buf, from);
7342}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007343#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007344
Jerry Yub7ba49e2022-02-17 14:25:53 +08007345
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007346#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007347static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007348 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007349{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007350 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007351 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007352 &ssl->handshake->fin_sha384_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007353 padbuf, sizeof(padbuf),
7354 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007355}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007356#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007357
Gilles Peskine449bd832023-01-11 14:50:10 +01007358void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007359{
Gilles Peskine449bd832023-01-11 14:50:10 +01007360 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007361
7362 /*
7363 * Free our handshake params
7364 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007365 mbedtls_ssl_handshake_free(ssl);
7366 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007367 ssl->handshake = NULL;
7368
7369 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007370 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007371 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007372 if (ssl->transform) {
7373 mbedtls_ssl_transform_free(ssl->transform);
7374 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007375 }
7376 ssl->transform = ssl->transform_negotiate;
7377 ssl->transform_negotiate = NULL;
7378
Gilles Peskine449bd832023-01-11 14:50:10 +01007379 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007380}
7381
Gilles Peskine449bd832023-01-11 14:50:10 +01007382void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007383{
7384 int resume = ssl->handshake->resume;
7385
Gilles Peskine449bd832023-01-11 14:50:10 +01007386 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007387
7388#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007389 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007390 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7391 ssl->renego_records_seen = 0;
7392 }
7393#endif
7394
7395 /*
7396 * Free the previous session and switch in the current one
7397 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007398 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007399#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7400 /* RFC 7366 3.1: keep the EtM state */
7401 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007402 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007403#endif
7404
Gilles Peskine449bd832023-01-11 14:50:10 +01007405 mbedtls_ssl_session_free(ssl->session);
7406 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007407 }
7408 ssl->session = ssl->session_negotiate;
7409 ssl->session_negotiate = NULL;
7410
7411 /*
7412 * Add cache entry
7413 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007414 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007415 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 resume == 0) {
7417 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7418 ssl->session->id,
7419 ssl->session->id_len,
7420 ssl->session) != 0) {
7421 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7422 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007423 }
7424
7425#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007426 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7427 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007428 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007429 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007430
7431 /* Keep last flight around in case we need to resend it:
7432 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007433 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7434 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007435#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007437
Gilles Peskinef670ba52025-03-07 15:09:32 +01007438 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007439
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007441}
7442
Gilles Peskine449bd832023-01-11 14:50:10 +01007443int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007444{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007445 int ret;
7446 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007447
Gilles Peskine449bd832023-01-11 14:50:10 +01007448 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007449
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007451
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007452 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7453 if (ret != 0) {
7454 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
David Horstmann816b7122025-03-07 17:20:59 +00007455 return ret;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007456 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007457
7458 /*
7459 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7460 * may define some other value. Currently (early 2016), no defined
7461 * ciphersuite does this (and this is unlikely to change as activity has
7462 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7463 */
7464 hash_len = 12;
7465
7466#if defined(MBEDTLS_SSL_RENEGOTIATION)
7467 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007468 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007469#endif
7470
7471 ssl->out_msglen = 4 + hash_len;
7472 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7473 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7474
7475 /*
7476 * In case of session resuming, invert the client and server
7477 * ChangeCipherSpec messages order.
7478 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007479 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007480#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007481 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007482 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007484#endif
7485#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007487 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC);
Gilles Peskine449bd832023-01-11 14:50:10 +01007488 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007489#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007490 } else {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007491 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007492 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007493
7494 /*
7495 * Switch to our negotiated transform and session parameters for outbound
7496 * data.
7497 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007498 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007499
7500#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007501 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007502 unsigned char i;
7503
7504 /* Remember current epoch settings for resending */
7505 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007506 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7507 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007508
7509 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007511
7512
7513 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007514 for (i = 2; i > 0; i--) {
7515 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007516 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007517 }
7518 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007519
7520 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007521 if (i == 0) {
7522 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7523 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007524 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007525 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007526#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007527 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007528
7529 ssl->transform_out = ssl->transform_negotiate;
7530 ssl->session_out = ssl->session_negotiate;
7531
7532#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007533 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7534 mbedtls_ssl_send_flight_completed(ssl);
7535 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007536#endif
7537
Gilles Peskine449bd832023-01-11 14:50:10 +01007538 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7539 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7540 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007541 }
7542
7543#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007544 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7545 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7546 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7547 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007548 }
7549#endif
7550
Gilles Peskine449bd832023-01-11 14:50:10 +01007551 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007552
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007554}
7555
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007556#define SSL_MAX_HASH_LEN 12
7557
Gilles Peskine449bd832023-01-11 14:50:10 +01007558int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007559{
7560 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7561 unsigned int hash_len = 12;
7562 unsigned char buf[SSL_MAX_HASH_LEN];
7563
Gilles Peskine449bd832023-01-11 14:50:10 +01007564 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007565
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007566 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7567 if (ret != 0) {
7568 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
David Horstmann816b7122025-03-07 17:20:59 +00007569 return ret;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007570 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007571
Gilles Peskine449bd832023-01-11 14:50:10 +01007572 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7573 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007574 goto exit;
7575 }
7576
Gilles Peskine449bd832023-01-11 14:50:10 +01007577 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7578 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7579 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7580 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007581 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7582 goto exit;
7583 }
7584
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
7586 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7587 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007588 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7589 goto exit;
7590 }
7591
Gilles Peskine449bd832023-01-11 14:50:10 +01007592 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
7593 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7594 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7595 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007596 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7597 goto exit;
7598 }
7599
Gilles Peskine449bd832023-01-11 14:50:10 +01007600 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
7601 buf, hash_len) != 0) {
7602 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7603 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7604 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007605 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7606 goto exit;
7607 }
7608
7609#if defined(MBEDTLS_SSL_RENEGOTIATION)
7610 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007611 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007612#endif
7613
Gilles Peskine449bd832023-01-11 14:50:10 +01007614 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007615#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007617 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC);
Gilles Peskine449bd832023-01-11 14:50:10 +01007618 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007619#endif
7620#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007622 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
Gilles Peskine449bd832023-01-11 14:50:10 +01007623 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007624#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007625 } else {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007626 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007627 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007628
7629#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007630 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7631 mbedtls_ssl_recv_flight_completed(ssl);
7632 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007633#endif
7634
Gilles Peskine449bd832023-01-11 14:50:10 +01007635 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007636
7637exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007638 mbedtls_platform_zeroize(buf, hash_len);
7639 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007640}
7641
Jerry Yu392112c2022-02-17 14:34:10 +08007642#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7643/*
7644 * Helper to get TLS 1.2 PRF from ciphersuite
7645 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7646 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007647static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08007648{
Jerry Yu392112c2022-02-17 14:34:10 +08007649 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007650 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007651#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007652 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
7653 return tls_prf_sha384;
7654 } else
Jerry Yu392112c2022-02-17 14:34:10 +08007655#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007656#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007657 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007658 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
7659 return tls_prf_sha256;
7660 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04007661 }
7662#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007663#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007664 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007665 (void) ciphersuite_info;
7666#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007667
Gilles Peskine449bd832023-01-11 14:50:10 +01007668 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08007669}
7670#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007671
Gilles Peskine449bd832023-01-11 14:50:10 +01007672static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007673{
7674 ((void) tls_prf);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007675#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007676 if (tls_prf == tls_prf_sha384) {
7677 return MBEDTLS_SSL_TLS_PRF_SHA384;
7678 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007679#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007680#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01007681 if (tls_prf == tls_prf_sha256) {
7682 return MBEDTLS_SSL_TLS_PRF_SHA256;
7683 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007684#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007685 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08007686}
7687
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007688/*
7689 * Populate a transform structure with session keys and all the other
7690 * necessary information.
7691 *
7692 * Parameters:
7693 * - [in/out]: transform: structure to populate
7694 * [in] must be just initialised with mbedtls_ssl_transform_init()
7695 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7696 * - [in] ciphersuite
7697 * - [in] master
7698 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007699 * - [in] tls_prf: pointer to PRF to use for key derivation
7700 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007701 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007702 * - [in] endpoint: client or server
7703 * - [in] ssl: used for:
7704 * - ssl->conf->{f,p}_export_keys
7705 * [in] optionally used for:
7706 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7707 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007708MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007709static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
7710 int ciphersuite,
7711 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007712#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007713 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007714#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007715 ssl_tls_prf_t tls_prf,
7716 const unsigned char randbytes[64],
7717 mbedtls_ssl_protocol_version tls_version,
7718 unsigned endpoint,
7719 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007720{
7721 int ret = 0;
7722 unsigned char keyblk[256];
7723 unsigned char *key1;
7724 unsigned char *key2;
7725 unsigned char *mac_enc;
7726 unsigned char *mac_dec;
7727 size_t mac_key_len = 0;
7728 size_t iv_copy_len;
7729 size_t keylen;
7730 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007731 mbedtls_ssl_mode_t ssl_mode;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007732
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007733 psa_key_type_t key_type;
7734 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7735 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007736 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007737 size_t key_bits;
7738 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007739
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007740 /*
7741 * Some data just needs copying into the structure
7742 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007743#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007744 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007745#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007746 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007747
Max Fillinger2fe35f62024-10-25 00:52:24 +02007748#if defined(MBEDTLS_SSL_KEEP_RANDBYTES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007749 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007750#endif
7751
7752#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01007753 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007754 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7755 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007756 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007757 }
7758#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7759
7760 /*
7761 * Get various info structures
7762 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007763 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
7764 if (ciphersuite_info == NULL) {
7765 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
7766 ciphersuite));
7767 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007768 }
7769
Neil Armstrongab555e02022-04-04 11:07:59 +02007770 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007771#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007772 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007773#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007774 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007775
Gilles Peskine449bd832023-01-11 14:50:10 +01007776 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007777 transform->taglen =
7778 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01007779 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007780
Dave Rodgman2eab4622023-10-05 13:30:37 +01007781 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01007782 transform->taglen,
7783 &alg,
7784 &key_type,
7785 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007786 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007787 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007788 goto end;
7789 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007790
Dave Rodgman2eab4622023-10-05 13:30:37 +01007791 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007792 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02007793 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01007794 (unsigned) ciphersuite_info->mac));
7795 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01007796 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007797
7798#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7799 /* Copy own and peer's CID if the use of the CID
7800 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007801 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
7802 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007803
7804 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007805 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
7806 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
7807 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007808
7809 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007810 memcpy(transform->out_cid, ssl->handshake->peer_cid,
7811 ssl->handshake->peer_cid_len);
7812 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
7813 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007814 }
7815#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7816
7817 /*
7818 * Compute key block using the PRF
7819 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007820 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
7821 if (ret != 0) {
7822 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7823 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007824 }
7825
Gilles Peskine449bd832023-01-11 14:50:10 +01007826 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
7827 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
7828 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
7829 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
7830 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007831
7832 /*
7833 * Determine the appropriate key, IV and MAC length.
7834 */
7835
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007836 keylen = PSA_BITS_TO_BYTES(key_bits);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007837
Valerio Settie5707042023-10-11 11:54:42 +02007838#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01007839 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007840 size_t explicit_ivlen;
7841
7842 transform->maclen = 0;
7843 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007844
7845 /* All modes haves 96-bit IVs, but the length of the static parts vary
7846 * with mode and version:
7847 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7848 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7849 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7850 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7851 * sequence number).
7852 */
7853 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01007854
7855 int is_chachapoly = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007856 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
David Horstmann3b2276a2022-10-06 14:49:08 +01007857
Gilles Peskine449bd832023-01-11 14:50:10 +01007858 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007859 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01007860 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007861 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01007862 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007863
7864 /* Minimum length of encrypted record */
7865 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7866 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007867 } else
Valerio Settie5707042023-10-11 11:54:42 +02007868#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007869#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007870 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007871 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01007872 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007873 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007874
Neil Armstronge4512952022-03-08 09:08:22 +01007875 /* Get MAC length */
7876 mac_key_len = PSA_HASH_LENGTH(mac_alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007877 transform->maclen = mac_key_len;
7878
7879 /* IV length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007880 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007881
7882 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007883 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007884 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007885 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007886 /*
7887 * GenericBlockCipher:
7888 * 1. if EtM is in use: one block plus MAC
7889 * otherwise: * first multiple of blocklen greater than maclen
7890 * 2. IV
7891 */
7892#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007893 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007894 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007895 + block_size;
7896 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007897#endif
7898 {
7899 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007900 + block_size
7901 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007902 }
7903
Gilles Peskine449bd832023-01-11 14:50:10 +01007904 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007905 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007906 } else {
7907 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007908 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7909 goto end;
7910 }
7911 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007912 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007913#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7914 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007915 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7916 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007917 }
7918
Gilles Peskine449bd832023-01-11 14:50:10 +01007919 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7920 (unsigned) keylen,
7921 (unsigned) transform->minlen,
7922 (unsigned) transform->ivlen,
7923 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007924
7925 /*
7926 * Finally setup the cipher contexts, IVs and MAC secrets.
7927 */
7928#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007929 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007930 key1 = keyblk + mac_key_len * 2;
7931 key2 = keyblk + mac_key_len * 2 + keylen;
7932
7933 mac_enc = keyblk;
7934 mac_dec = keyblk + mac_key_len;
7935
Gilles Peskine449bd832023-01-11 14:50:10 +01007936 iv_copy_len = (transform->fixed_ivlen) ?
7937 transform->fixed_ivlen : transform->ivlen;
7938 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
7939 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
7940 iv_copy_len);
7941 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007942#endif /* MBEDTLS_SSL_CLI_C */
7943#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007944 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007945 key1 = keyblk + mac_key_len * 2 + keylen;
7946 key2 = keyblk + mac_key_len * 2;
7947
7948 mac_enc = keyblk + mac_key_len;
7949 mac_dec = keyblk;
7950
Gilles Peskine449bd832023-01-11 14:50:10 +01007951 iv_copy_len = (transform->fixed_ivlen) ?
7952 transform->fixed_ivlen : transform->ivlen;
7953 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
7954 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
7955 iv_copy_len);
7956 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007957#endif /* MBEDTLS_SSL_SRV_C */
7958 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007959 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007960 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7961 goto end;
7962 }
7963
Paul Elliott4fb19552023-10-18 12:15:30 +01007964 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007965 ssl->f_export_keys(ssl->p_export_keys,
7966 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7967 master, 48,
7968 randbytes + 32,
7969 randbytes,
7970 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007971 }
7972
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007973 transform->psa_alg = alg;
7974
Gilles Peskine449bd832023-01-11 14:50:10 +01007975 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
7976 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
7977 psa_set_key_algorithm(&attributes, alg);
7978 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007979
Gilles Peskine449bd832023-01-11 14:50:10 +01007980 if ((status = psa_import_key(&attributes,
7981 key1,
7982 PSA_BITS_TO_BYTES(key_bits),
7983 &transform->psa_key_enc)) != PSA_SUCCESS) {
7984 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007985 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007986 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007987 goto end;
7988 }
7989
Gilles Peskine449bd832023-01-11 14:50:10 +01007990 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007991
Gilles Peskine449bd832023-01-11 14:50:10 +01007992 if ((status = psa_import_key(&attributes,
7993 key2,
7994 PSA_BITS_TO_BYTES(key_bits),
7995 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007996 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007997 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007998 goto end;
7999 }
8000 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008001
Neil Armstrong29c0c042022-03-17 17:47:28 +01008002#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8003 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8004 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008005 if (mac_key_len != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008006 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008007
Gilles Peskine449bd832023-01-11 14:50:10 +01008008 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8009 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8010 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008011
Gilles Peskine449bd832023-01-11 14:50:10 +01008012 if ((status = psa_import_key(&attributes,
8013 mac_enc, mac_key_len,
8014 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008015 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008016 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008017 goto end;
8018 }
8019
Gilles Peskine449bd832023-01-11 14:50:10 +01008020 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8021 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008022#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008023 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008024#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008025 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008026 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008027 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8028 PSA_KEY_USAGE_VERIFY_HASH);
8029 } else {
8030 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8031 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008032
Gilles Peskine449bd832023-01-11 14:50:10 +01008033 if ((status = psa_import_key(&attributes,
8034 mac_dec, mac_key_len,
8035 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008036 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008037 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008038 goto end;
8039 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008040 }
8041#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8042
8043 ((void) mac_dec);
8044 ((void) mac_enc);
8045
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008046end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008047 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8048 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008049}
8050
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008051#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008052int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008053 psa_pake_operation_t *pake_ctx,
8054 const unsigned char *buf,
8055 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008056{
8057 psa_status_t status;
8058 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008059 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008060 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8061 * At round two perform a single cycle
8062 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008063 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008064
Gilles Peskine449bd832023-01-11 14:50:10 +01008065 for (; remaining_steps > 0; remaining_steps--) {
8066 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008067 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008068 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008069 /* Length is stored at the first byte */
8070 size_t length = buf[input_offset];
8071 input_offset += 1;
8072
Gilles Peskine449bd832023-01-11 14:50:10 +01008073 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008074 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8075 }
8076
Gilles Peskine449bd832023-01-11 14:50:10 +01008077 status = psa_pake_input(pake_ctx, step,
8078 buf + input_offset, length);
8079 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008080 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008081 }
8082
8083 input_offset += length;
8084 }
8085 }
8086
Gilles Peskine449bd832023-01-11 14:50:10 +01008087 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008088 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008089 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008090
Gilles Peskine449bd832023-01-11 14:50:10 +01008091 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008092}
8093
Valerio Setti6b3dab02022-11-17 17:14:54 +01008094int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008095 psa_pake_operation_t *pake_ctx,
8096 unsigned char *buf,
8097 size_t len, size_t *olen,
8098 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008099{
8100 psa_status_t status;
8101 size_t output_offset = 0;
8102 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008103 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008104 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8105 * At round two perform a single cycle
8106 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008107 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008108
Gilles Peskine449bd832023-01-11 14:50:10 +01008109 for (; remaining_steps > 0; remaining_steps--) {
8110 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8111 step <= PSA_PAKE_STEP_ZK_PROOF;
8112 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008113 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008114 * For each step, prepend 1 byte with the length of the data as
8115 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008116 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008117 status = psa_pake_output(pake_ctx, step,
8118 buf + output_offset + 1,
8119 len - output_offset - 1,
8120 &output_len);
8121 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008122 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008123 }
8124
Valerio Setti99d88c12022-11-22 16:03:43 +01008125 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008126
8127 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008128 }
8129 }
8130
8131 *olen = output_offset;
8132
Gilles Peskine449bd832023-01-11 14:50:10 +01008133 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008134}
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008135#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Valerio Settia08b1a42022-11-17 15:10:02 +01008136
Gilles Peskine449bd832023-01-11 14:50:10 +01008137int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8138 unsigned char *hash, size_t *hashlen,
8139 unsigned char *data, size_t data_len,
8140 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008141{
8142 psa_status_t status;
8143 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008144 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008145
Gilles Peskine449bd832023-01-11 14:50:10 +01008146 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008147
Gilles Peskine449bd832023-01-11 14:50:10 +01008148 if ((status = psa_hash_setup(&hash_operation,
8149 hash_alg)) != PSA_SUCCESS) {
8150 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008151 goto exit;
8152 }
8153
Gilles Peskine449bd832023-01-11 14:50:10 +01008154 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8155 64)) != PSA_SUCCESS) {
8156 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008157 goto exit;
8158 }
8159
Gilles Peskine449bd832023-01-11 14:50:10 +01008160 if ((status = psa_hash_update(&hash_operation,
8161 data, data_len)) != PSA_SUCCESS) {
8162 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008163 goto exit;
8164 }
8165
Gilles Peskine449bd832023-01-11 14:50:10 +01008166 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8167 hashlen)) != PSA_SUCCESS) {
8168 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8169 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008170 }
8171
8172exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008173 if (status != PSA_SUCCESS) {
8174 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8175 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8176 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008177 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008178 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008179 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8180 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008181 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008182 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008183 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008184 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008185 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008186 }
8187 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008188 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008189}
8190
Jerry Yuee40f9d2022-02-17 14:55:16 +08008191
Jerry Yud9d91da2022-02-17 14:57:06 +08008192#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8193
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008194/* Find the preferred hash for a given signature algorithm. */
8195unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008196 mbedtls_ssl_context *ssl,
8197 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008198{
Gabor Mezei078e8032022-04-27 21:17:56 +02008199 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008200 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008201
Gilles Peskine449bd832023-01-11 14:50:10 +01008202 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8203 return MBEDTLS_SSL_HASH_NONE;
8204 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008205
Gilles Peskine449bd832023-01-11 14:50:10 +01008206 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008207 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008208 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8209 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008210 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008211 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8212 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008213
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008214 mbedtls_md_type_t md_alg =
8215 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8216 if (md_alg == MBEDTLS_MD_NONE) {
8217 continue;
8218 }
8219
Gilles Peskine449bd832023-01-11 14:50:10 +01008220 if (sig_alg == sig_alg_received) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008221 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008222 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008223 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008224
Gilles Peskine449bd832023-01-11 14:50:10 +01008225 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8226 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8227 PSA_ALG_ECDSA(psa_hash_alg),
8228 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008229 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008230 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008231
Gilles Peskine449bd832023-01-11 14:50:10 +01008232 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8233 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8234 PSA_ALG_RSA_PKCS1V15_SIGN(
8235 psa_hash_alg),
8236 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008237 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008238 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008239 }
Neil Armstrong96eceb82022-06-30 18:05:05 +02008240
Gilles Peskine449bd832023-01-11 14:50:10 +01008241 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008242 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008243 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008244
Gilles Peskine449bd832023-01-11 14:50:10 +01008245 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008246}
8247
8248#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8249
Jerry Yudc7bd172022-02-17 13:44:15 +08008250#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8251
XiaokangQian75d40ef2022-04-20 11:05:24 +00008252int mbedtls_ssl_validate_ciphersuite(
8253 const mbedtls_ssl_context *ssl,
8254 const mbedtls_ssl_ciphersuite_t *suite_info,
8255 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01008256 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008257{
8258 (void) ssl;
8259
Gilles Peskine449bd832023-01-11 14:50:10 +01008260 if (suite_info == NULL) {
8261 return -1;
8262 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00008263
Gilles Peskine449bd832023-01-11 14:50:10 +01008264 if ((suite_info->min_tls_version > max_tls_version) ||
8265 (suite_info->max_tls_version < min_tls_version)) {
8266 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008267 }
8268
XiaokangQian060d8672022-04-21 09:24:56 +00008269#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008270#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008271 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
Manuel Pégourié-Gonnard88800dd2025-01-23 11:01:35 +01008272 ssl->handshake->psa_pake_ctx_is_ok != 1) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008273 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008274 }
8275#endif
8276
8277 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8278#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008279 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
8280 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
8281 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008282 }
8283#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8284#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8285
Gilles Peskine449bd832023-01-11 14:50:10 +01008286 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008287}
8288
Ronald Crone68ab4f2022-10-05 12:46:29 +02008289#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00008290/*
8291 * Function for writing a signature algorithm extension.
8292 *
8293 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8294 * value (TLS 1.3 RFC8446):
8295 * enum {
8296 * ....
8297 * ecdsa_secp256r1_sha256( 0x0403 ),
8298 * ecdsa_secp384r1_sha384( 0x0503 ),
8299 * ecdsa_secp521r1_sha512( 0x0603 ),
8300 * ....
8301 * } SignatureScheme;
8302 *
8303 * struct {
8304 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8305 * } SignatureSchemeList;
8306 *
8307 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8308 * value (TLS 1.2 RFC5246):
8309 * enum {
8310 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8311 * sha512(6), (255)
8312 * } HashAlgorithm;
8313 *
8314 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8315 * SignatureAlgorithm;
8316 *
8317 * struct {
8318 * HashAlgorithm hash;
8319 * SignatureAlgorithm signature;
8320 * } SignatureAndHashAlgorithm;
8321 *
8322 * SignatureAndHashAlgorithm
8323 * supported_signature_algorithms<2..2^16-2>;
8324 *
8325 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8326 * generalization of the TLS 1.2 signature algorithm extension.
8327 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8328 * `SignatureScheme` field of TLS 1.3
8329 *
8330 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008331int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
8332 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00008333{
8334 unsigned char *p = buf;
8335 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8336 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8337
8338 *out_len = 0;
8339
Gilles Peskine449bd832023-01-11 14:50:10 +01008340 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00008341
8342 /* Check if we have space for header and length field:
8343 * - extension_type (2 bytes)
8344 * - extension_data_length (2 bytes)
8345 * - supported_signature_algorithms_length (2 bytes)
8346 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008347 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00008348 p += 6;
8349
8350 /*
8351 * Write supported_signature_algorithms
8352 */
8353 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01008354 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
8355 if (sig_alg == NULL) {
8356 return MBEDTLS_ERR_SSL_BAD_CONFIG;
8357 }
XiaokangQianeaf36512022-04-24 09:07:44 +00008358
Gilles Peskine449bd832023-01-11 14:50:10 +01008359 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
8360 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
8361 *sig_alg,
8362 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
8363 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00008364 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008365 }
8366 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
8367 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00008368 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008369 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
8370 *sig_alg,
8371 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00008372 }
8373
8374 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008375 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01008376 if (supported_sig_alg_len == 0) {
8377 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
8378 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00008379 }
8380
Gilles Peskine449bd832023-01-11 14:50:10 +01008381 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
8382 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
8383 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00008384
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008385 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00008386
8387#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008388 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00008389#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08008390
Gilles Peskine449bd832023-01-11 14:50:10 +01008391 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00008392}
Ronald Crone68ab4f2022-10-05 12:46:29 +02008393#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00008394
XiaokangQian40a35232022-05-07 09:02:40 +00008395#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008396/*
8397 * mbedtls_ssl_parse_server_name_ext
8398 *
8399 * Structure of server_name extension:
8400 *
8401 * enum {
8402 * host_name(0), (255)
8403 * } NameType;
8404 * opaque HostName<1..2^16-1>;
8405 *
8406 * struct {
8407 * NameType name_type;
8408 * select (name_type) {
8409 * case host_name: HostName;
8410 * } name;
8411 * } ServerName;
8412 * struct {
8413 * ServerName server_name_list<1..2^16-1>
8414 * } ServerNameList;
8415 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008416MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008417int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
8418 const unsigned char *buf,
8419 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00008420{
8421 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8422 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008423 size_t server_name_list_len, hostname_len;
8424 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008425
Gilles Peskine449bd832023-01-11 14:50:10 +01008426 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00008427
Gilles Peskine449bd832023-01-11 14:50:10 +01008428 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
8429 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00008430 p += 2;
8431
Gilles Peskine449bd832023-01-11 14:50:10 +01008432 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00008433 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008434 while (p < server_name_list_end) {
8435 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
8436 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
8437 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
8438 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00008439
Gilles Peskine449bd832023-01-11 14:50:10 +01008440 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008441 /* sni_name is intended to be used only during the parsing of the
8442 * ClientHello message (it is reset to NULL before the end of
8443 * the message parsing). Thus it is ok to just point to the
8444 * reception buffer and not make a copy of it.
8445 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008446 ssl->handshake->sni_name = p + 3;
8447 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008448 if (ssl->conf->f_sni == NULL) {
8449 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008450 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008451 ret = ssl->conf->f_sni(ssl->conf->p_sni,
8452 ssl, p + 3, hostname_len);
8453 if (ret != 0) {
8454 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
8455 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8456 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
8457 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
8458 }
8459 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008460 }
8461
8462 p += hostname_len + 3;
8463 }
8464
Gilles Peskine449bd832023-01-11 14:50:10 +01008465 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008466}
8467#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8468
XiaokangQianacb39922022-06-17 10:18:48 +00008469#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008470MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008471int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
8472 const unsigned char *buf,
8473 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00008474{
8475 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008476 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008477 const unsigned char *protocol_name_list;
8478 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008479 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008480
8481 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01008482 if (ssl->conf->alpn_list == NULL) {
8483 return 0;
8484 }
XiaokangQianacb39922022-06-17 10:18:48 +00008485
8486 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008487 * RFC7301, section 3.1
8488 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008489 *
XiaokangQianc7403452022-06-23 03:24:12 +00008490 * struct {
8491 * ProtocolName protocol_name_list<2..2^16-1>
8492 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008493 */
8494
XiaokangQianc7403452022-06-23 03:24:12 +00008495 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008496 * protocol_name_list_len 2 bytes
8497 * protocol_name_len 1 bytes
8498 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008499 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008500 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00008501
Gilles Peskine449bd832023-01-11 14:50:10 +01008502 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008503 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008504 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00008505 protocol_name_list = p;
8506 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008507
8508 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01008509 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008510 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008511 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
8512 protocol_name_len);
8513 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008514 MBEDTLS_SSL_PEND_FATAL_ALERT(
8515 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01008516 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
8517 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00008518 }
8519
8520 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008521 }
8522
8523 /* Use our order of preference */
Gilles Peskinec4949d12025-05-27 19:45:29 +02008524 for (const char *const *alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008525 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00008526 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01008527 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008528 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008529 if (protocol_name_len == alpn_len &&
8530 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00008531 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01008532 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008533 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008534
8535 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008536 }
8537 }
8538
XiaokangQian95d5f542022-06-24 02:29:26 +00008539 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008540 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01008541 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8542 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
8543 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00008544}
8545
Gilles Peskine449bd832023-01-11 14:50:10 +01008546int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
8547 unsigned char *buf,
8548 unsigned char *end,
8549 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00008550{
8551 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008552 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008553 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008554
Gilles Peskine449bd832023-01-11 14:50:10 +01008555 if (ssl->alpn_chosen == NULL) {
8556 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008557 }
8558
Gilles Peskine449bd832023-01-11 14:50:10 +01008559 protocol_name_len = strlen(ssl->alpn_chosen);
8560 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008561
Gilles Peskine449bd832023-01-11 14:50:10 +01008562 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00008563 /*
8564 * 0 . 1 ext identifier
8565 * 2 . 3 ext length
8566 * 4 . 5 protocol list length
8567 * 6 . 6 protocol name length
8568 * 7 . 7+n protocol name
8569 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008570 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008571
XiaokangQian95d5f542022-06-24 02:29:26 +00008572 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008573
Gilles Peskine449bd832023-01-11 14:50:10 +01008574 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
8575 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00008576 /* Note: the length of the chosen protocol has been checked to be less
8577 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8578 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008579 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008580
Gilles Peskine449bd832023-01-11 14:50:10 +01008581 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08008582
8583#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008584 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08008585#endif
8586
Gilles Peskine449bd832023-01-11 14:50:10 +01008587 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008588}
8589#endif /* MBEDTLS_SSL_ALPN */
8590
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008591#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00008592 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008593 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008594 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008595int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
8596 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008597{
8598 /* Initialize to suppress unnecessary compiler warning */
8599 size_t hostname_len = 0;
8600
8601 /* Check if new hostname is valid before
8602 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008603 if (hostname != NULL) {
8604 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008605
Gilles Peskine449bd832023-01-11 14:50:10 +01008606 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
8607 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8608 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008609 }
8610
8611 /* Now it's clear that we will overwrite the old hostname,
8612 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01008613 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008614 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01008615 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008616 }
8617
8618 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008619 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008620 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01008621 } else {
8622 session->hostname = mbedtls_calloc(1, hostname_len + 1);
8623 if (session->hostname == NULL) {
8624 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8625 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008626
Gilles Peskine449bd832023-01-11 14:50:10 +01008627 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008628 }
8629
Gilles Peskine449bd832023-01-11 14:50:10 +01008630 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008631}
Xiaokang Qian03409292022-10-12 02:49:52 +00008632#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
8633 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008634 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008635 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008636
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008637#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
8638 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008639int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
8640 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008641{
8642 size_t alpn_len = 0;
8643
8644 if (alpn != NULL) {
8645 alpn_len = strlen(alpn);
8646
8647 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
8648 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8649 }
8650 }
8651
8652 if (session->ticket_alpn != NULL) {
8653 mbedtls_zeroize_and_free(session->ticket_alpn,
8654 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008655 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008656 }
8657
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008658 if (alpn != NULL) {
8659 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008660 if (session->ticket_alpn == NULL) {
8661 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8662 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008663 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008664 }
8665
8666 return 0;
8667}
8668#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008669
8670/*
8671 * The following functions are used by 1.2 and 1.3, client and server.
8672 */
8673#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
8674int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
8675 const mbedtls_ssl_ciphersuite_t *ciphersuite,
8676 int recv_endpoint,
8677 mbedtls_ssl_protocol_version tls_version,
8678 uint32_t *flags)
8679{
8680 int ret = 0;
8681 unsigned int usage = 0;
8682 const char *ext_oid;
8683 size_t ext_len;
8684
8685 /*
8686 * keyUsage
8687 */
8688
8689 /* Note: don't guard this with MBEDTLS_SSL_CLI_C because the server wants
8690 * to check what a compliant client will think while choosing which cert
8691 * to send to the client. */
8692#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
8693 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8694 recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8695 /* TLS 1.2 server part of the key exchange */
8696 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008697 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
8698 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
8699 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8700 break;
8701
8702 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
8703 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
8704 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
8705 break;
8706
8707 /* Don't use default: we want warnings when adding new values */
8708 case MBEDTLS_KEY_EXCHANGE_NONE:
8709 case MBEDTLS_KEY_EXCHANGE_PSK:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008710 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
8711 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
8712 usage = 0;
8713 }
8714 } else
8715#endif
8716 {
8717 /* This is either TLS 1.3 authentication, which always uses signatures,
8718 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
8719 * options we implement, both using signatures. */
8720 (void) tls_version;
8721 (void) ciphersuite;
8722 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8723 }
8724
8725 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
8726 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
8727 ret = -1;
8728 }
8729
8730 /*
8731 * extKeyUsage
8732 */
8733
8734 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8735 ext_oid = MBEDTLS_OID_SERVER_AUTH;
8736 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
8737 } else {
8738 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
8739 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
8740 }
8741
8742 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
8743 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
8744 ret = -1;
8745 }
8746
8747 return ret;
8748}
8749
Gilles Peskine4ac40082025-02-20 18:13:58 +01008750static int get_hostname_for_verification(mbedtls_ssl_context *ssl,
8751 const char **hostname)
8752{
8753 if (!mbedtls_ssl_has_set_hostname_been_called(ssl)) {
8754 MBEDTLS_SSL_DEBUG_MSG(1, ("Certificate verification without having set hostname"));
Gilles Peskine488b9192025-02-13 14:39:02 +01008755 if (mbedtls_ssl_conf_get_endpoint(ssl->conf) == MBEDTLS_SSL_IS_CLIENT &&
8756 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8757 return MBEDTLS_ERR_SSL_CERTIFICATE_VERIFICATION_WITHOUT_HOSTNAME;
8758 }
Gilles Peskine4ac40082025-02-20 18:13:58 +01008759 }
8760
8761 *hostname = ssl->hostname;
8762 if (*hostname == NULL) {
8763 MBEDTLS_SSL_DEBUG_MSG(2, ("Certificate verification without CN verification"));
8764 }
8765
8766 return 0;
8767}
8768
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008769int mbedtls_ssl_verify_certificate(mbedtls_ssl_context *ssl,
8770 int authmode,
8771 mbedtls_x509_crt *chain,
8772 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
8773 void *rs_ctx)
8774{
8775 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
8776 return 0;
8777 }
8778
8779 /*
8780 * Primary check: use the appropriate X.509 verification function
8781 */
8782 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
8783 void *p_vrfy;
8784 if (ssl->f_vrfy != NULL) {
8785 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
8786 f_vrfy = ssl->f_vrfy;
8787 p_vrfy = ssl->p_vrfy;
8788 } else {
8789 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
8790 f_vrfy = ssl->conf->f_vrfy;
8791 p_vrfy = ssl->conf->p_vrfy;
8792 }
8793
Gilles Peskine4ac40082025-02-20 18:13:58 +01008794 const char *hostname = "";
8795 int ret = get_hostname_for_verification(ssl, &hostname);
8796 if (ret != 0) {
8797 MBEDTLS_SSL_DEBUG_RET(1, "get_hostname_for_verification", ret);
8798 return ret;
8799 }
8800
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008801 int have_ca_chain_or_callback = 0;
8802#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
8803 if (ssl->conf->f_ca_cb != NULL) {
8804 ((void) rs_ctx);
8805 have_ca_chain_or_callback = 1;
8806
8807 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
8808 ret = mbedtls_x509_crt_verify_with_ca_cb(
8809 chain,
8810 ssl->conf->f_ca_cb,
8811 ssl->conf->p_ca_cb,
8812 ssl->conf->cert_profile,
Gilles Peskine4ac40082025-02-20 18:13:58 +01008813 hostname,
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008814 &ssl->session_negotiate->verify_result,
8815 f_vrfy, p_vrfy);
8816 } else
8817#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
8818 {
8819 mbedtls_x509_crt *ca_chain;
8820 mbedtls_x509_crl *ca_crl;
8821#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8822 if (ssl->handshake->sni_ca_chain != NULL) {
8823 ca_chain = ssl->handshake->sni_ca_chain;
8824 ca_crl = ssl->handshake->sni_ca_crl;
8825 } else
8826#endif
8827 {
8828 ca_chain = ssl->conf->ca_chain;
8829 ca_crl = ssl->conf->ca_crl;
8830 }
8831
8832 if (ca_chain != NULL) {
8833 have_ca_chain_or_callback = 1;
8834 }
8835
8836 ret = mbedtls_x509_crt_verify_restartable(
8837 chain,
8838 ca_chain, ca_crl,
8839 ssl->conf->cert_profile,
Gilles Peskine4ac40082025-02-20 18:13:58 +01008840 hostname,
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008841 &ssl->session_negotiate->verify_result,
8842 f_vrfy, p_vrfy, rs_ctx);
8843 }
8844
8845 if (ret != 0) {
8846 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
8847 }
8848
8849#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
8850 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8851 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8852 }
8853#endif
8854
8855 /*
8856 * Secondary checks: always done, but change 'ret' only if it was 0
8857 */
8858
8859 /* With TLS 1.2 and ECC certs, check that the curve used by the
8860 * certificate is on our list of acceptable curves.
8861 *
8862 * With TLS 1.3 this is not needed because the curve is part of the
8863 * signature algorithm (eg ecdsa_secp256r1_sha256) which is checked when
8864 * we validate the signature made with the key associated to this cert.
8865 */
8866#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
8867 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
8868 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8869 mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY)) {
8870 if (mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
8871 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8872 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
8873 if (ret == 0) {
8874 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8875 }
8876 }
8877 }
8878#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
8879
8880 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
8881 if (mbedtls_ssl_check_cert_usage(chain,
8882 ciphersuite_info,
8883 ssl->conf->endpoint,
8884 ssl->tls_version,
8885 &ssl->session_negotiate->verify_result) != 0) {
8886 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8887 if (ret == 0) {
8888 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8889 }
8890 }
8891
8892 /* With authmode optional, we want to keep going if the certificate was
8893 * unacceptable, but still fail on other errors (out of memory etc),
8894 * including fatal errors from the f_vrfy callback.
8895 *
8896 * The only acceptable errors are:
8897 * - MBEDTLS_ERR_X509_CERT_VERIFY_FAILED: cert rejected by primary check;
8898 * - MBEDTLS_ERR_SSL_BAD_CERTIFICATE: cert rejected by secondary checks.
8899 * Anything else is a fatal error. */
8900 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8901 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8902 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
8903 ret = 0;
8904 }
8905
8906 /* Return a specific error as this is a user error: inconsistent
8907 * configuration - can't verify without trust anchors. */
8908 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8909 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
8910 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8911 }
8912
8913 if (ret != 0) {
8914 uint8_t alert;
8915
8916 /* The certificate may have been rejected for several reasons.
8917 Pick one and send the corresponding alert. Which alert to send
8918 may be a subject of debate in some cases. */
8919 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
8920 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
8921 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
8922 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
8923 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
8924 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8925 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
8926 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8927 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
8928 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8929 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
8930 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8931 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
8932 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
8933 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
8934 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
8935 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
8936 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
8937 } else {
8938 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
8939 }
8940 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8941 alert);
8942 }
8943
8944#if defined(MBEDTLS_DEBUG_C)
8945 if (ssl->session_negotiate->verify_result != 0) {
8946 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8947 (unsigned int) ssl->session_negotiate->verify_result));
8948 } else {
8949 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
8950 }
8951#endif /* MBEDTLS_DEBUG_C */
8952
8953 return ret;
8954}
8955#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
8956
Max Fillinger2fe35f62024-10-25 00:52:24 +02008957#if defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT)
Max Fillinger281fb792024-10-23 18:35:09 +02008958
Max Fillinger29beade2024-09-21 11:06:28 +02008959#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008960static int mbedtls_ssl_tls12_export_keying_material(const mbedtls_ssl_context *ssl,
8961 const mbedtls_md_type_t hash_alg,
Max Fillinger7b722202024-09-21 10:48:57 +02008962 uint8_t *out,
8963 const size_t key_len,
8964 const char *label,
8965 const size_t label_len,
8966 const unsigned char *context,
8967 const size_t context_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008968 const int use_context)
8969{
8970 int ret = 0;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008971 unsigned char *prf_input = NULL;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008972
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008973 /* The input to the PRF is client_random, then server_random.
8974 * If a context is provided, this is then followed by the context length
8975 * as a 16-bit big-endian integer, and then the context itself. */
Max Fillinger155cea02024-10-23 16:32:54 +02008976 const size_t randbytes_len = MBEDTLS_CLIENT_HELLO_RANDOM_LEN + MBEDTLS_SERVER_HELLO_RANDOM_LEN;
8977 size_t prf_input_len = randbytes_len;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008978 if (use_context) {
Max Fillinger155cea02024-10-23 16:32:54 +02008979 if (context_len > UINT16_MAX) {
8980 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8981 }
8982
8983 /* This does not overflow a 32-bit size_t because the current value of
8984 * prf_input_len is 64 (length of client_random + server_random) and
8985 * context_len fits into two bytes (checked above). */
8986 prf_input_len += sizeof(uint16_t) + context_len;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008987 }
Max Fillinger155cea02024-10-23 16:32:54 +02008988
8989 prf_input = mbedtls_calloc(prf_input_len, sizeof(unsigned char));
8990 if (prf_input == NULL) {
8991 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8992 }
8993
8994 memcpy(prf_input,
8995 ssl->transform->randbytes + MBEDTLS_SERVER_HELLO_RANDOM_LEN,
8996 MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
8997 memcpy(prf_input + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
8998 ssl->transform->randbytes,
8999 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
9000 if (use_context) {
9001 MBEDTLS_PUT_UINT16_BE(context_len, prf_input, randbytes_len);
9002 memcpy(prf_input + randbytes_len + sizeof(uint16_t), context, context_len);
9003 }
9004 ret = tls_prf_generic(hash_alg, ssl->session->master, sizeof(ssl->session->master),
Max Fillingerf2dda152024-10-23 15:47:23 +02009005 label, label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009006 prf_input, prf_input_len,
9007 out, key_len);
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009008 mbedtls_free(prf_input);
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009009 return ret;
9010}
Max Fillinger281fb792024-10-23 18:35:09 +02009011#endif /* defined(MBEDTLS_SSL_PROTO_TLS1_2) */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009012
Max Fillinger29beade2024-09-21 11:06:28 +02009013#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009014static int mbedtls_ssl_tls13_export_keying_material(mbedtls_ssl_context *ssl,
9015 const mbedtls_md_type_t hash_alg,
Max Fillinger7b722202024-09-21 10:48:57 +02009016 uint8_t *out,
9017 const size_t key_len,
9018 const char *label,
9019 const size_t label_len,
9020 const unsigned char *context,
9021 const size_t context_len)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009022{
9023 const psa_algorithm_t psa_hash_alg = mbedtls_md_psa_alg_from_type(hash_alg);
9024 const size_t hash_len = PSA_HASH_LENGTH(hash_alg);
9025 const unsigned char *secret = ssl->session->app_secrets.exporter_master_secret;
9026
Max Fillinger9c5bae52024-11-21 12:33:46 +01009027 /* The length of the label must be at most 249 bytes to fit into the HkdfLabel
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009028 * struct as defined in RFC 8446, Section 7.1.
Max Fillinger3e129182024-10-29 19:18:54 +01009029 *
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009030 * The length of the context is unlimited even though the context field in the
Max Fillinger9c5bae52024-11-21 12:33:46 +01009031 * struct can only hold up to 255 bytes. This is because we place a *hash* of
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009032 * the context in the field. */
Max Fillinger9c5bae52024-11-21 12:33:46 +01009033 if (label_len > 249) {
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009034 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9035 }
9036
9037 return mbedtls_ssl_tls13_exporter(psa_hash_alg, secret, hash_len,
Max Fillinger7b722202024-09-21 10:48:57 +02009038 (const unsigned char *) label, label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009039 context, context_len, out, key_len);
9040}
Max Fillinger281fb792024-10-23 18:35:09 +02009041#endif /* defined(MBEDTLS_SSL_PROTO_TLS1_3) */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009042
9043int mbedtls_ssl_export_keying_material(mbedtls_ssl_context *ssl,
Max Fillinger9c9989f2024-08-14 16:44:50 +02009044 uint8_t *out, const size_t key_len,
9045 const char *label, const size_t label_len,
9046 const unsigned char *context, const size_t context_len,
9047 const int use_context)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009048{
9049 if (!mbedtls_ssl_is_handshake_over(ssl)) {
Max Fillinger53d91682024-11-18 18:22:51 +01009050 /* TODO: Change this to a more appropriate error code when one is available. */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009051 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9052 }
9053
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009054 if (key_len > MBEDTLS_SSL_EXPORT_MAX_KEY_LEN) {
9055 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9056 }
9057
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009058 int ciphersuite_id = mbedtls_ssl_get_ciphersuite_id_from_ssl(ssl);
9059 const mbedtls_ssl_ciphersuite_t *ciphersuite = mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
9060 const mbedtls_md_type_t hash_alg = ciphersuite->mac;
9061
9062 switch (mbedtls_ssl_get_version_number(ssl)) {
Max Fillinger29beade2024-09-21 11:06:28 +02009063#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009064 case MBEDTLS_SSL_VERSION_TLS1_2:
9065 return mbedtls_ssl_tls12_export_keying_material(ssl, hash_alg, out, key_len,
9066 label, label_len,
9067 context, context_len, use_context);
Max Fillinger29beade2024-09-21 11:06:28 +02009068#endif
9069#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009070 case MBEDTLS_SSL_VERSION_TLS1_3:
Max Fillinger7b722202024-09-21 10:48:57 +02009071 return mbedtls_ssl_tls13_export_keying_material(ssl,
9072 hash_alg,
9073 out,
9074 key_len,
9075 label,
9076 label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009077 use_context ? context : NULL,
9078 use_context ? context_len : 0);
Max Fillinger29beade2024-09-21 11:06:28 +02009079#endif
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009080 default:
9081 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
9082 }
9083}
9084
Max Fillinger2fe35f62024-10-25 00:52:24 +02009085#endif /* defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT) */
Max Fillinger281fb792024-10-23 18:35:09 +02009086
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009087#endif /* MBEDTLS_SSL_TLS_C */