blob: ecc9187af230787416870ad26f8b5d66192a028b [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)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002423#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002424/*
2425 * Set allowed/preferred hashes for handshake signatures
2426 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002427void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2428 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002429{
2430 conf->sig_hashes = hashes;
2431}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002432#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002433
Jerry Yuf017ee42022-01-12 15:49:48 +08002434/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002435void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2436 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002437{
Jerry Yuf017ee42022-01-12 15:49:48 +08002438#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2439 conf->sig_hashes = NULL;
2440#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2441 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002442}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002443#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002444
Brett Warrene0edc842021-08-17 09:53:13 +01002445/*
2446 * Set the allowed groups
2447 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002448void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2449 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002450{
Brett Warrene0edc842021-08-17 09:53:13 +01002451 conf->group_list = group_list;
2452}
2453
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002454#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine4ac40082025-02-20 18:13:58 +01002455
2456#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2457/** Whether mbedtls_ssl_set_hostname() has been called.
2458 *
2459 * \param[in] ssl SSL context
2460 *
2461 * \return \c 1 if mbedtls_ssl_set_hostname() has been called on \p ssl
2462 * (including `mbedtls_ssl_set_hostname(ssl, NULL)`),
2463 * otherwise \c 0.
2464 */
2465static int mbedtls_ssl_has_set_hostname_been_called(
2466 const mbedtls_ssl_context *ssl)
2467{
Gilles Peskine434016e2025-02-20 18:49:59 +01002468 return (ssl->flags & MBEDTLS_SSL_CONTEXT_FLAG_HOSTNAME_SET) != 0;
Gilles Peskine4ac40082025-02-20 18:13:58 +01002469}
2470#endif
2471
2472static void mbedtls_ssl_free_hostname(mbedtls_ssl_context *ssl)
2473{
2474 if (ssl->hostname != NULL) {
2475 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
2476 }
2477 ssl->hostname = NULL;
2478}
2479
Gilles Peskine449bd832023-01-11 14:50:10 +01002480int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002481{
Hanno Becker947194e2017-04-07 13:25:49 +01002482 /* Initialize to suppress unnecessary compiler warning */
2483 size_t hostname_len = 0;
2484
2485 /* Check if new hostname is valid before
2486 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002487 if (hostname != NULL) {
2488 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002489
Gilles Peskine449bd832023-01-11 14:50:10 +01002490 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2491 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2492 }
Hanno Becker947194e2017-04-07 13:25:49 +01002493 }
2494
2495 /* Now it's clear that we will overwrite the old hostname,
2496 * so we can free it safely */
Gilles Peskine4ac40082025-02-20 18:13:58 +01002497 mbedtls_ssl_free_hostname(ssl);
Hanno Becker947194e2017-04-07 13:25:49 +01002498
2499 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002500
Gilles Peskine449bd832023-01-11 14:50:10 +01002501 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002502 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002503 } else {
2504 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2505 if (ssl->hostname == NULL) {
2506 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2507 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002508
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002510
Hanno Becker947194e2017-04-07 13:25:49 +01002511 ssl->hostname[hostname_len] = '\0';
2512 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002513
Gilles Peskine434016e2025-02-20 18:49:59 +01002514 ssl->flags |= MBEDTLS_SSL_CONTEXT_FLAG_HOSTNAME_SET;
2515
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002517}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002518#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002519
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002520#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002521void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2522 int (*f_sni)(void *, mbedtls_ssl_context *,
2523 const unsigned char *, size_t),
2524 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002525{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002526 conf->f_sni = f_sni;
2527 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002528}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002529#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002530
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002531#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskinec4949d12025-05-27 19:45:29 +02002532int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf,
2533 const char *const *protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002534{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002535 size_t cur_len, tot_len;
Gilles Peskinec4949d12025-05-27 19:45:29 +02002536 const char *const *p;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002537
2538 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002539 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2540 * MUST NOT be truncated."
2541 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002542 */
2543 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002544 for (p = protos; *p != NULL; p++) {
2545 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002546 tot_len += cur_len;
2547
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 if ((cur_len == 0) ||
2549 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2550 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2551 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2552 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002553 }
2554
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002555 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002556
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002558}
2559
Gilles Peskine449bd832023-01-11 14:50:10 +01002560const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002561{
Gilles Peskine449bd832023-01-11 14:50:10 +01002562 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002563}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002564#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002565
Johan Pascalb62bb512015-12-03 21:56:45 +01002566#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002567void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2568 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002569{
2570 conf->dtls_srtp_mki_support = support_mki_value;
2571}
2572
Gilles Peskine449bd832023-01-11 14:50:10 +01002573int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2574 unsigned char *mki_value,
2575 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002576{
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2578 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002579 }
Ron Eldor591f1622018-01-22 12:30:04 +02002580
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2582 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002583 }
Ron Eldor591f1622018-01-22 12:30:04 +02002584
Gilles Peskine449bd832023-01-11 14:50:10 +01002585 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002586 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002588}
2589
Gilles Peskine449bd832023-01-11 14:50:10 +01002590int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2591 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002592{
Johan Pascal253d0262020-09-22 13:04:45 +02002593 const mbedtls_ssl_srtp_profile *p;
2594 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002595
Johan Pascal253d0262020-09-22 13:04:45 +02002596 /* check the profiles list: all entry must be valid,
2597 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002598 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2599 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2600 p++) {
2601 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002602 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002603 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002604 /* unsupported value, stop parsing and set the size to an error value */
2605 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002606 }
2607 }
2608
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2610 conf->dtls_srtp_profile_list = NULL;
2611 conf->dtls_srtp_profile_list_len = 0;
2612 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002613 }
2614
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002615 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002616 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002617
Gilles Peskine449bd832023-01-11 14:50:10 +01002618 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002619}
2620
Gilles Peskine449bd832023-01-11 14:50:10 +01002621void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2622 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002623{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002624 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2625 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002626 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002627 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002628 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002629 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2631 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002632 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002633}
Johan Pascalb62bb512015-12-03 21:56:45 +01002634#endif /* MBEDTLS_SSL_DTLS_SRTP */
2635
Janos Follath088ce432017-04-10 12:42:31 +01002636#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002637void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2638 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002639{
2640 conf->cert_req_ca_list = cert_req_ca_list;
2641}
2642#endif
2643
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002644#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002645void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002646{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002647 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002648}
2649#endif
2650
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002651#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002652void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002653{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002654 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002655}
2656#endif
2657
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002658#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002659int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002660{
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2662 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2663 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002664 }
2665
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002666 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002667
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002669}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002670#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002671
Gilles Peskine449bd832023-01-11 14:50:10 +01002672void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002673{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002674 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002675}
2676
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002677#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002678void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002679{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002680 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002681}
2682
Gilles Peskine449bd832023-01-11 14:50:10 +01002683void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002684{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002685 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002686}
2687
Gilles Peskine449bd832023-01-11 14:50:10 +01002688void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2689 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002690{
Gilles Peskine449bd832023-01-11 14:50:10 +01002691 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002692}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002693#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker490ecc82011-10-06 13:04:09 +00002694
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002695#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002696#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002697void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002698{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002699 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002700}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002701#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002702
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002703#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002704
Jerry Yud0766ec2022-09-22 10:46:57 +08002705#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002706void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2707 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002708{
Jerry Yud0766ec2022-09-22 10:46:57 +08002709 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002710}
2711#endif
2712
Gilles Peskine449bd832023-01-11 14:50:10 +01002713void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2714 mbedtls_ssl_ticket_write_t *f_ticket_write,
2715 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2716 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02002717{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002718 conf->f_ticket_write = f_ticket_write;
2719 conf->f_ticket_parse = f_ticket_parse;
2720 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002721}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002722#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002723#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002724
Gilles Peskine449bd832023-01-11 14:50:10 +01002725void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
2726 mbedtls_ssl_export_keys_t *f_export_keys,
2727 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002728{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002729 ssl->f_export_keys = f_export_keys;
2730 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002731}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002732
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002733#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002734void mbedtls_ssl_conf_async_private_cb(
2735 mbedtls_ssl_config *conf,
2736 mbedtls_ssl_async_sign_t *f_async_sign,
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002737 mbedtls_ssl_async_resume_t *f_async_resume,
2738 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01002739 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002740{
2741 conf->f_async_sign_start = f_async_sign;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002742 conf->f_async_resume = f_async_resume;
2743 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002744 conf->p_async_config_data = async_config_data;
2745}
2746
Gilles Peskine449bd832023-01-11 14:50:10 +01002747void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02002748{
Gilles Peskine449bd832023-01-11 14:50:10 +01002749 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02002750}
2751
Gilles Peskine449bd832023-01-11 14:50:10 +01002752void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002753{
Gilles Peskine449bd832023-01-11 14:50:10 +01002754 if (ssl->handshake == NULL) {
2755 return NULL;
2756 } else {
2757 return ssl->handshake->user_async_ctx;
2758 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002759}
2760
Gilles Peskine449bd832023-01-11 14:50:10 +01002761void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2762 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002763{
Gilles Peskine449bd832023-01-11 14:50:10 +01002764 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002765 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01002766 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002767}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002768#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002769
Paul Bakker5121ce52009-01-03 21:22:43 +00002770/*
2771 * SSL get accessors
2772 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002773uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002774{
Gilles Peskine449bd832023-01-11 14:50:10 +01002775 if (ssl->session != NULL) {
2776 return ssl->session->verify_result;
2777 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002778
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 if (ssl->session_negotiate != NULL) {
2780 return ssl->session_negotiate->verify_result;
2781 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002782
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00002784}
2785
Gilles Peskine449bd832023-01-11 14:50:10 +01002786int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05002787{
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 if (ssl == NULL || ssl->session == NULL) {
2789 return 0;
2790 }
Glenn Strauss8f526902022-01-13 00:04:49 -05002791
Gilles Peskine449bd832023-01-11 14:50:10 +01002792 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05002793}
2794
Gilles Peskine449bd832023-01-11 14:50:10 +01002795const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00002796{
Gilles Peskine449bd832023-01-11 14:50:10 +01002797 if (ssl == NULL || ssl->session == NULL) {
2798 return NULL;
2799 }
Paul Bakker926c8e42013-03-06 10:23:34 +01002800
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00002802}
2803
Gilles Peskine449bd832023-01-11 14:50:10 +01002804const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00002805{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002806#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2808 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002809 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002810 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002811 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002813 }
2814 }
2815#endif
2816
Gilles Peskine449bd832023-01-11 14:50:10 +01002817 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002818 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002819 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04002820 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002822 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002824 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002825}
2826
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002827#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2828
2829size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
2830{
2831 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2832 size_t record_size_limit = max_len;
2833
2834 if (ssl->session != NULL &&
2835 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2836 ssl->session->record_size_limit < max_len) {
2837 record_size_limit = ssl->session->record_size_limit;
2838 }
2839
2840 // TODO: this is currently untested
2841 /* During a handshake, use the value being negotiated */
2842 if (ssl->session_negotiate != NULL &&
2843 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2844 ssl->session_negotiate->record_size_limit < max_len) {
2845 record_size_limit = ssl->session_negotiate->record_size_limit;
2846 }
2847
2848 return record_size_limit;
2849}
2850#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2851
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002852#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002853size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002854{
David Horstmann95d516f2021-05-04 18:36:56 +01002855 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002856 size_t read_mfl;
2857
Jerry Yuddda0502022-12-01 19:43:12 +08002858#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002859 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2861 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
2862 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002863 }
Jerry Yuddda0502022-12-01 19:43:12 +08002864#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002865
2866 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 if (ssl->session_out != NULL) {
2868 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
2869 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002870 max_len = read_mfl;
2871 }
2872 }
2873
Jerry Yuddda0502022-12-01 19:43:12 +08002874 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 if (ssl->session_negotiate != NULL) {
2876 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
2877 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002878 max_len = read_mfl;
2879 }
2880 }
2881
Gilles Peskine449bd832023-01-11 14:50:10 +01002882 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002883}
2884
Gilles Peskine449bd832023-01-11 14:50:10 +01002885size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002886{
2887 size_t max_len;
2888
2889 /*
2890 * Assume mfl_code is correct since it was checked when set
2891 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002892 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002893
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002894 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002895 if (ssl->session_out != NULL &&
2896 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
2897 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002898 }
2899
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002900 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002901 if (ssl->session_negotiate != NULL &&
2902 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
2903 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002904 }
2905
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002907}
2908#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2909
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002910#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002911size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002912{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002913 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002914 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2915 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2916 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
2917 return 0;
2918 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002919
Gilles Peskine449bd832023-01-11 14:50:10 +01002920 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
2921 return ssl->mtu;
2922 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002923
Gilles Peskine449bd832023-01-11 14:50:10 +01002924 if (ssl->mtu == 0) {
2925 return ssl->handshake->mtu;
2926 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002927
Gilles Peskine449bd832023-01-11 14:50:10 +01002928 return ssl->mtu < ssl->handshake->mtu ?
2929 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002930}
2931#endif /* MBEDTLS_SSL_PROTO_DTLS */
2932
Gilles Peskine449bd832023-01-11 14:50:10 +01002933int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002934{
2935 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2936
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002937#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002938 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002939 !defined(MBEDTLS_SSL_PROTO_DTLS)
2940 (void) ssl;
2941#endif
2942
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002943#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002944 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002945
Gilles Peskine449bd832023-01-11 14:50:10 +01002946 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002947 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01002948 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002949#endif
2950
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002951#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2952 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
2953
2954 if (max_len > record_size_limit) {
2955 max_len = record_size_limit;
2956 }
2957#endif
2958
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002959 if (ssl->transform_out != NULL &&
2960 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00002961 /*
2962 * In TLS 1.3 case, when records are protected, `max_len` as computed
2963 * above is the maximum length of the TLSInnerPlaintext structure that
2964 * along the plaintext payload contains the inner content type (one byte)
2965 * and some zero padding. Given the algorithm used for padding
2966 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
2967 * the plaintext payload. Round down to a multiple of
2968 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
2969 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002970 */
2971 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
2972 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
2973 }
2974
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002975#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
2977 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
2978 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002979 const size_t overhead = (size_t) ret;
2980
Gilles Peskine449bd832023-01-11 14:50:10 +01002981 if (ret < 0) {
2982 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002983 }
2984
Gilles Peskine449bd832023-01-11 14:50:10 +01002985 if (mtu <= overhead) {
2986 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
2987 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2988 }
2989
2990 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002991 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002993 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002994#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002995
Hanno Becker0defedb2018-08-10 12:35:02 +01002996#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00002997 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
2998 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01002999 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003000#endif
3001
Gilles Peskine449bd832023-01-11 14:50:10 +01003002 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003003}
3004
Gilles Peskine449bd832023-01-11 14:50:10 +01003005int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003006{
3007 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3008
3009#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3010 (void) ssl;
3011#endif
3012
3013#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003015
Gilles Peskine449bd832023-01-11 14:50:10 +01003016 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003017 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003018 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003019#endif
3020
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003022}
3023
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003024#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003025const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003026{
Gilles Peskine449bd832023-01-11 14:50:10 +01003027 if (ssl == NULL || ssl->session == NULL) {
3028 return NULL;
3029 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003030
Hanno Beckere6824572019-02-07 13:18:46 +00003031#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003033#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003034 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003035#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003036}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003037#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003038
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003039#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003040int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3041 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003042{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003043 int ret;
3044
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003046 dst == NULL ||
3047 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003048 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3049 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003050 }
3051
Hanno Beckere810bbc2021-05-14 16:01:05 +01003052 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3053 * idempotent: Each session can only be exported once.
3054 *
3055 * (This is in preparation for TLS 1.3 support where we will
3056 * need the ability to export multiple sessions (aka tickets),
3057 * which will be achieved by calling mbedtls_ssl_get_session()
3058 * multiple times until it fails.)
3059 *
3060 * Check whether we have already exported the current session,
3061 * and fail if so.
3062 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003063 if (ssl->session->exported == 1) {
3064 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3065 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003066
Gilles Peskine449bd832023-01-11 14:50:10 +01003067 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3068 if (ret != 0) {
3069 return ret;
3070 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003071
3072 /* Remember that we've exported the session. */
3073 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003074 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003075}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003076#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003077
David Horstmanncb01b362024-02-29 17:31:46 +00003078#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3079
3080/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003081 *
David Horstmanncb01b362024-02-29 17:31:46 +00003082 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003083 */
3084static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3085 unsigned char *buf,
3086 size_t buf_len)
3087{
3088 unsigned char *p = buf;
3089 size_t used = 0;
3090
3091#if defined(MBEDTLS_HAVE_TIME)
3092 uint64_t start;
3093#endif
3094#if defined(MBEDTLS_X509_CRT_PARSE_C)
3095#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3096 size_t cert_len;
3097#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3098#endif /* MBEDTLS_X509_CRT_PARSE_C */
3099
3100 /*
3101 * Time
3102 */
3103#if defined(MBEDTLS_HAVE_TIME)
3104 used += 8;
3105
3106 if (used <= buf_len) {
3107 start = (uint64_t) session->start;
3108
3109 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3110 p += 8;
3111 }
3112#endif /* MBEDTLS_HAVE_TIME */
3113
3114 /*
3115 * Basic mandatory fields
3116 */
3117 used += 1 /* id_len */
3118 + sizeof(session->id)
3119 + sizeof(session->master)
3120 + 4; /* verify_result */
3121
3122 if (used <= buf_len) {
3123 *p++ = MBEDTLS_BYTE_0(session->id_len);
3124 memcpy(p, session->id, 32);
3125 p += 32;
3126
3127 memcpy(p, session->master, 48);
3128 p += 48;
3129
3130 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3131 p += 4;
3132 }
3133
3134 /*
3135 * Peer's end-entity certificate
3136 */
3137#if defined(MBEDTLS_X509_CRT_PARSE_C)
3138#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3139 if (session->peer_cert == NULL) {
3140 cert_len = 0;
3141 } else {
3142 cert_len = session->peer_cert->raw.len;
3143 }
3144
3145 used += 3 + cert_len;
3146
3147 if (used <= buf_len) {
3148 *p++ = MBEDTLS_BYTE_2(cert_len);
3149 *p++ = MBEDTLS_BYTE_1(cert_len);
3150 *p++ = MBEDTLS_BYTE_0(cert_len);
3151
3152 if (session->peer_cert != NULL) {
3153 memcpy(p, session->peer_cert->raw.p, cert_len);
3154 p += cert_len;
3155 }
3156 }
3157#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3158 if (session->peer_cert_digest != NULL) {
3159 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3160 if (used <= buf_len) {
3161 *p++ = (unsigned char) session->peer_cert_digest_type;
3162 *p++ = (unsigned char) session->peer_cert_digest_len;
3163 memcpy(p, session->peer_cert_digest,
3164 session->peer_cert_digest_len);
3165 p += session->peer_cert_digest_len;
3166 }
3167 } else {
3168 used += 2;
3169 if (used <= buf_len) {
3170 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3171 *p++ = 0;
3172 }
3173 }
3174#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3175#endif /* MBEDTLS_X509_CRT_PARSE_C */
3176
3177 /*
3178 * Session ticket if any, plus associated data
3179 */
3180#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3181#if defined(MBEDTLS_SSL_CLI_C)
3182 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3183 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3184
3185 if (used <= buf_len) {
3186 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3187 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3188 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3189
3190 if (session->ticket != NULL) {
3191 memcpy(p, session->ticket, session->ticket_len);
3192 p += session->ticket_len;
3193 }
3194
3195 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3196 p += 4;
3197 }
3198 }
3199#endif /* MBEDTLS_SSL_CLI_C */
3200#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3201 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3202 used += 8;
3203
3204 if (used <= buf_len) {
3205 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3206 p += 8;
3207 }
3208 }
3209#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3210#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3211
3212 /*
3213 * Misc extension-related info
3214 */
3215#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3216 used += 1;
3217
3218 if (used <= buf_len) {
3219 *p++ = session->mfl_code;
3220 }
3221#endif
3222
3223#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3224 used += 1;
3225
3226 if (used <= buf_len) {
3227 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3228 }
3229#endif
3230
3231 return used;
3232}
3233
3234MBEDTLS_CHECK_RETURN_CRITICAL
3235static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3236 const unsigned char *buf,
3237 size_t len)
3238{
3239#if defined(MBEDTLS_HAVE_TIME)
3240 uint64_t start;
3241#endif
3242#if defined(MBEDTLS_X509_CRT_PARSE_C)
3243#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3244 size_t cert_len;
3245#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3246#endif /* MBEDTLS_X509_CRT_PARSE_C */
3247
3248 const unsigned char *p = buf;
3249 const unsigned char * const end = buf + len;
3250
3251 /*
3252 * Time
3253 */
3254#if defined(MBEDTLS_HAVE_TIME)
3255 if (8 > (size_t) (end - p)) {
3256 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3257 }
3258
3259 start = MBEDTLS_GET_UINT64_BE(p, 0);
3260 p += 8;
3261
3262 session->start = (time_t) start;
3263#endif /* MBEDTLS_HAVE_TIME */
3264
3265 /*
3266 * Basic mandatory fields
3267 */
3268 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3269 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3270 }
3271
3272 session->id_len = *p++;
3273 memcpy(session->id, p, 32);
3274 p += 32;
3275
3276 memcpy(session->master, p, 48);
3277 p += 48;
3278
3279 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3280 p += 4;
3281
3282 /* Immediately clear invalid pointer values that have been read, in case
3283 * we exit early before we replaced them with valid ones. */
3284#if defined(MBEDTLS_X509_CRT_PARSE_C)
3285#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3286 session->peer_cert = NULL;
3287#else
3288 session->peer_cert_digest = NULL;
3289#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3290#endif /* MBEDTLS_X509_CRT_PARSE_C */
3291#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3292 session->ticket = NULL;
3293#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3294
3295 /*
3296 * Peer certificate
3297 */
3298#if defined(MBEDTLS_X509_CRT_PARSE_C)
3299#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3300 /* Deserialize CRT from the end of the ticket. */
3301 if (3 > (size_t) (end - p)) {
3302 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3303 }
3304
3305 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3306 p += 3;
3307
3308 if (cert_len != 0) {
3309 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3310
3311 if (cert_len > (size_t) (end - p)) {
3312 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3313 }
3314
3315 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3316
3317 if (session->peer_cert == NULL) {
3318 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3319 }
3320
3321 mbedtls_x509_crt_init(session->peer_cert);
3322
3323 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3324 p, cert_len)) != 0) {
3325 mbedtls_x509_crt_free(session->peer_cert);
3326 mbedtls_free(session->peer_cert);
3327 session->peer_cert = NULL;
3328 return ret;
3329 }
3330
3331 p += cert_len;
3332 }
3333#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3334 /* Deserialize CRT digest from the end of the ticket. */
3335 if (2 > (size_t) (end - p)) {
3336 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3337 }
3338
3339 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3340 session->peer_cert_digest_len = (size_t) *p++;
3341
3342 if (session->peer_cert_digest_len != 0) {
3343 const mbedtls_md_info_t *md_info =
3344 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3345 if (md_info == NULL) {
3346 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3347 }
3348 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3349 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3350 }
3351
3352 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3353 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3354 }
3355
3356 session->peer_cert_digest =
3357 mbedtls_calloc(1, session->peer_cert_digest_len);
3358 if (session->peer_cert_digest == NULL) {
3359 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3360 }
3361
3362 memcpy(session->peer_cert_digest, p,
3363 session->peer_cert_digest_len);
3364 p += session->peer_cert_digest_len;
3365 }
3366#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3367#endif /* MBEDTLS_X509_CRT_PARSE_C */
3368
3369 /*
3370 * Session ticket and associated data
3371 */
3372#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3373#if defined(MBEDTLS_SSL_CLI_C)
3374 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3375 if (3 > (size_t) (end - p)) {
3376 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3377 }
3378
3379 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3380 p += 3;
3381
3382 if (session->ticket_len != 0) {
3383 if (session->ticket_len > (size_t) (end - p)) {
3384 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3385 }
3386
3387 session->ticket = mbedtls_calloc(1, session->ticket_len);
3388 if (session->ticket == NULL) {
3389 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3390 }
3391
3392 memcpy(session->ticket, p, session->ticket_len);
3393 p += session->ticket_len;
3394 }
3395
3396 if (4 > (size_t) (end - p)) {
3397 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3398 }
3399
3400 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3401 p += 4;
3402 }
3403#endif /* MBEDTLS_SSL_CLI_C */
3404#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3405 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3406 if (8 > (size_t) (end - p)) {
3407 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3408 }
3409 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3410 p += 8;
3411 }
3412#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3413#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3414
3415 /*
3416 * Misc extension-related info
3417 */
3418#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3419 if (1 > (size_t) (end - p)) {
3420 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3421 }
3422
3423 session->mfl_code = *p++;
3424#endif
3425
3426#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3427 if (1 > (size_t) (end - p)) {
3428 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3429 }
3430
3431 session->encrypt_then_mac = *p++;
3432#endif
3433
3434 /* Done, should have consumed entire buffer */
3435 if (p != end) {
3436 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3437 }
3438
3439 return 0;
3440}
3441
3442#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3443
3444#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3445/* Serialization of TLS 1.3 sessions:
3446 *
David Horstmanncb01b362024-02-29 17:31:46 +00003447 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003448 */
3449#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3450MBEDTLS_CHECK_RETURN_CRITICAL
3451static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3452 unsigned char *buf,
3453 size_t buf_len,
3454 size_t *olen)
3455{
3456 unsigned char *p = buf;
3457#if defined(MBEDTLS_SSL_CLI_C) && \
3458 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3459 size_t hostname_len = (session->hostname == NULL) ?
3460 0 : strlen(session->hostname) + 1;
3461#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003462
3463#if defined(MBEDTLS_SSL_SRV_C) && \
3464 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003465 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003466 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003467#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003468 size_t needed = 4 /* ticket_age_add */
3469 + 1 /* ticket_flags */
3470 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003471
David Horstmanne59f9702024-02-29 16:08:57 +00003472 *olen = 0;
3473
3474 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3475 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3476 }
3477 needed += session->resumption_key_len; /* resumption_key */
3478
3479#if defined(MBEDTLS_SSL_EARLY_DATA)
3480 needed += 4; /* max_early_data_size */
3481#endif
3482#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3483 needed += 2; /* record_size_limit */
3484#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3485
3486#if defined(MBEDTLS_HAVE_TIME)
3487 needed += 8; /* ticket_creation_time or ticket_reception_time */
3488#endif
3489
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003490#if defined(MBEDTLS_SSL_SRV_C)
3491 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3492#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003493 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003494 + alpn_len; /* alpn */
3495#endif
3496 }
3497#endif /* MBEDTLS_SSL_SRV_C */
3498
David Horstmanne59f9702024-02-29 16:08:57 +00003499#if defined(MBEDTLS_SSL_CLI_C)
3500 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3501#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3502 needed += 2 /* hostname_len */
3503 + hostname_len; /* hostname */
3504#endif
3505
3506 needed += 4 /* ticket_lifetime */
3507 + 2; /* ticket_len */
3508
3509 /* Check size_t overflow */
3510 if (session->ticket_len > SIZE_MAX - needed) {
3511 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3512 }
3513
3514 needed += session->ticket_len; /* ticket */
3515 }
3516#endif /* MBEDTLS_SSL_CLI_C */
3517
3518 *olen = needed;
3519 if (needed > buf_len) {
3520 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3521 }
3522
3523 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3524 p[4] = session->ticket_flags;
3525
3526 /* save resumption_key */
3527 p[5] = session->resumption_key_len;
3528 p += 6;
3529 memcpy(p, session->resumption_key, session->resumption_key_len);
3530 p += session->resumption_key_len;
3531
3532#if defined(MBEDTLS_SSL_EARLY_DATA)
3533 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3534 p += 4;
3535#endif
3536#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3537 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3538 p += 2;
3539#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3540
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003541#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003542 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003543#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003544 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3545 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003546#endif /* MBEDTLS_HAVE_TIME */
3547
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003548#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003549 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3550 p += 2;
3551
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003552 if (alpn_len > 0) {
3553 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003554 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003555 p += alpn_len;
3556 }
3557#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3558 }
3559#endif /* MBEDTLS_SSL_SRV_C */
3560
David Horstmanne59f9702024-02-29 16:08:57 +00003561#if defined(MBEDTLS_SSL_CLI_C)
3562 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3563#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3564 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3565 p += 2;
3566 if (hostname_len > 0) {
3567 /* save host name */
3568 memcpy(p, session->hostname, hostname_len);
3569 p += hostname_len;
3570 }
3571#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3572
3573#if defined(MBEDTLS_HAVE_TIME)
3574 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3575 p += 8;
3576#endif
3577 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3578 p += 4;
3579
3580 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3581 p += 2;
3582
3583 if (session->ticket != NULL && session->ticket_len > 0) {
3584 memcpy(p, session->ticket, session->ticket_len);
3585 p += session->ticket_len;
3586 }
3587 }
3588#endif /* MBEDTLS_SSL_CLI_C */
3589 return 0;
3590}
3591
3592MBEDTLS_CHECK_RETURN_CRITICAL
3593static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3594 const unsigned char *buf,
3595 size_t len)
3596{
3597 const unsigned char *p = buf;
3598 const unsigned char *end = buf + len;
3599
3600 if (end - p < 6) {
3601 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3602 }
3603 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3604 session->ticket_flags = p[4];
3605
3606 /* load resumption_key */
3607 session->resumption_key_len = p[5];
3608 p += 6;
3609
3610 if (end - p < session->resumption_key_len) {
3611 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3612 }
3613
3614 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3615 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3616 }
3617 memcpy(session->resumption_key, p, session->resumption_key_len);
3618 p += session->resumption_key_len;
3619
3620#if defined(MBEDTLS_SSL_EARLY_DATA)
3621 if (end - p < 4) {
3622 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3623 }
3624 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3625 p += 4;
3626#endif
3627#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3628 if (end - p < 2) {
3629 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3630 }
3631 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3632 p += 2;
3633#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3634
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003635#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003636 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003637#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003638 if (end - p < 8) {
3639 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3640 }
3641 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3642 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003643#endif /* MBEDTLS_HAVE_TIME */
3644
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003645#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003646 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003647
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003648 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003649 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3650 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003651
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003652 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3653 p += 2;
3654
3655 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003656 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3657 }
3658
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003659 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003660 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3661 if (ret != 0) {
3662 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003663 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003664 p += alpn_len;
3665 }
3666#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3667 }
3668#endif /* MBEDTLS_SSL_SRV_C */
3669
David Horstmanne59f9702024-02-29 16:08:57 +00003670#if defined(MBEDTLS_SSL_CLI_C)
3671 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3672#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3673 size_t hostname_len;
3674 /* load host name */
3675 if (end - p < 2) {
3676 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3677 }
3678 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3679 p += 2;
3680
3681 if (end - p < (long int) hostname_len) {
3682 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3683 }
3684 if (hostname_len > 0) {
3685 session->hostname = mbedtls_calloc(1, hostname_len);
3686 if (session->hostname == NULL) {
3687 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3688 }
3689 memcpy(session->hostname, p, hostname_len);
3690 p += hostname_len;
3691 }
3692#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3693
3694#if defined(MBEDTLS_HAVE_TIME)
3695 if (end - p < 8) {
3696 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3697 }
3698 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3699 p += 8;
3700#endif
3701 if (end - p < 4) {
3702 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3703 }
3704 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3705 p += 4;
3706
3707 if (end - p < 2) {
3708 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3709 }
3710 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
3711 p += 2;
3712
3713 if (end - p < (long int) session->ticket_len) {
3714 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3715 }
3716 if (session->ticket_len > 0) {
3717 session->ticket = mbedtls_calloc(1, session->ticket_len);
3718 if (session->ticket == NULL) {
3719 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3720 }
3721 memcpy(session->ticket, p, session->ticket_len);
3722 p += session->ticket_len;
3723 }
3724 }
3725#endif /* MBEDTLS_SSL_CLI_C */
3726
3727 return 0;
3728
3729}
3730#else /* MBEDTLS_SSL_SESSION_TICKETS */
3731MBEDTLS_CHECK_RETURN_CRITICAL
3732static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3733 unsigned char *buf,
3734 size_t buf_len,
3735 size_t *olen)
3736{
3737 ((void) session);
3738 ((void) buf);
3739 ((void) buf_len);
3740 *olen = 0;
3741 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3742}
3743
3744static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01003745 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00003746 size_t buf_len)
3747{
3748 ((void) session);
3749 ((void) buf);
3750 ((void) buf_len);
3751 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3752}
3753#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
3754#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3755
Paul Bakker5121ce52009-01-03 21:22:43 +00003756/*
Hanno Beckera835da52019-05-16 12:39:07 +01003757 * Define ticket header determining Mbed TLS version
3758 * and structure of the ticket.
3759 */
3760
Hanno Becker94ef3b32019-05-16 12:50:45 +01003761/*
Hanno Becker50b59662019-05-28 14:30:45 +01003762 * Define bitflag determining compile-time settings influencing
3763 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003764 */
3765
Hanno Becker50b59662019-05-28 14:30:45 +01003766#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003767#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003768#else
Hanno Becker3e088662019-05-29 11:10:18 +01003769#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003770#endif /* MBEDTLS_HAVE_TIME */
3771
3772#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003773#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003774#else
Hanno Becker3e088662019-05-29 11:10:18 +01003775#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003776#endif /* MBEDTLS_X509_CRT_PARSE_C */
3777
David Horstmann5c5a32f2024-02-13 17:53:35 +00003778#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00003779#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00003780#else
David Horstmannf686f1d2024-03-01 11:20:32 +00003781#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00003782#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3783
Hanno Becker94ef3b32019-05-16 12:50:45 +01003784#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003785#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003786#else
Hanno Becker3e088662019-05-29 11:10:18 +01003787#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003788#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3789
3790#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003791#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003792#else
Hanno Becker3e088662019-05-29 11:10:18 +01003793#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003794#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3795
Hanno Becker94ef3b32019-05-16 12:50:45 +01003796#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003797#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003798#else
Hanno Becker3e088662019-05-29 11:10:18 +01003799#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003800#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3801
Hanno Becker94ef3b32019-05-16 12:50:45 +01003802#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3803#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3804#else
3805#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3806#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3807
David Horstmann92b258b2024-02-13 17:23:34 +00003808#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3809#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
3810#else
3811#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
3812#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3813
3814#if defined(MBEDTLS_SSL_EARLY_DATA)
3815#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
3816#else
3817#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
3818#endif /* MBEDTLS_SSL_EARLY_DATA */
3819
3820#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3821#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
3822#else
3823#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
3824#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3825
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003826#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
3827 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00003828#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
3829#else
3830#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
3831#endif /* MBEDTLS_SSL_ALPN */
3832
Hanno Becker3e088662019-05-29 11:10:18 +01003833#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3834#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3835#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3836#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003837#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3838#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00003839#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00003840#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
3841#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
3842#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00003843#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01003844
Hanno Becker50b59662019-05-28 14:30:45 +01003845#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003846 ((uint16_t) ( \
3847 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3848 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3849 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3850 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3851 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3852 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00003853 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00003854 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
3855 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00003856 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
3857 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
3858 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
3859 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003860 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00003861 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003862 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003863
Chien Wong4e9683e2023-12-28 17:07:43 +08003864static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003865 MBEDTLS_VERSION_MAJOR,
3866 MBEDTLS_VERSION_MINOR,
3867 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003868 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3869 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003870};
Hanno Beckera835da52019-05-16 12:39:07 +01003871
3872/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003873 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003874 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003875 *
David Horstmanncb01b362024-02-29 17:31:46 +00003876 * TLS 1.2 session:
3877 *
3878 * struct {
3879 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
3880 * opaque ticket<0..2^24-1>; // length 0 means no ticket
3881 * uint32 ticket_lifetime;
3882 * #endif
3883 * } ClientOnlyData;
3884 *
3885 * struct {
3886 * #if defined(MBEDTLS_HAVE_TIME)
3887 * uint64 start_time;
3888 * #endif
3889 * uint8 session_id_len; // at most 32
3890 * opaque session_id[32];
3891 * opaque master[48]; // fixed length in the standard
3892 * uint32 verify_result;
3893 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
3894 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
3895 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00003896 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00003897 * opaque peer_cert_digest<0..2^8-1>
3898 * #endif
3899 * select (endpoint) {
3900 * case client: ClientOnlyData;
3901 * case server: uint64 ticket_creation_time;
3902 * };
3903 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3904 * uint8 mfl_code; // up to 255 according to standard
3905 * #endif
3906 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3907 * uint8 encrypt_then_mac; // 0 or 1
3908 * #endif
3909 * } serialized_session_tls12;
3910 *
3911 *
3912 * TLS 1.3 Session:
3913 *
3914 * struct {
3915 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3916 * opaque hostname<0..2^16-1>;
3917 * #endif
3918 * #if defined(MBEDTLS_HAVE_TIME)
3919 * uint64 ticket_reception_time;
3920 * #endif
3921 * uint32 ticket_lifetime;
3922 * opaque ticket<1..2^16-1>;
3923 * } ClientOnlyData;
3924 *
3925 * struct {
3926 * uint32 ticket_age_add;
3927 * uint8 ticket_flags;
3928 * opaque resumption_key<0..255>;
3929 * #if defined(MBEDTLS_SSL_EARLY_DATA)
3930 * uint32 max_early_data_size;
3931 * #endif
3932 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3933 * uint16 record_size_limit;
3934 * #endif
3935 * select ( endpoint ) {
3936 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003937 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00003938 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003939 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00003940 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00003941 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003942 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00003943 * #endif
3944 * };
3945 * } serialized_session_tls13;
3946 *
3947 *
3948 * SSL session:
3949 *
3950 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003951 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003952 * opaque mbedtls_version[3]; // library version: major, minor, patch
3953 * opaque session_format[2]; // library-version specific 16-bit field
3954 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003955 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003956 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003957 * Note: When updating the format, remember to keep
3958 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003959 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003960 * // In this version, `session_format` determines
3961 * // the setting of those compile-time
3962 * // configuration options which influence
3963 * // the structure of mbedtls_ssl_session.
3964 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003965 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003966 * // - TLS 1.2 (0x0303)
3967 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00003968 * uint8_t endpoint;
3969 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003970 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003971 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003972 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003973 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003974 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003975 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003976 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003977 *
3978 * };
3979 *
3980 * } serialized_session;
3981 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003982 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003983
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003984MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003985static int ssl_session_save(const mbedtls_ssl_session *session,
3986 unsigned char omit_header,
3987 unsigned char *buf,
3988 size_t buf_len,
3989 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003990{
3991 unsigned char *p = buf;
3992 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003993 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003994#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3995 size_t out_len;
3996 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3997#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003998 if (session == NULL) {
3999 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4000 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004001
Gilles Peskine449bd832023-01-11 14:50:10 +01004002 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004003 /*
4004 * Add Mbed TLS version identifier
4005 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004006 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004007
Gilles Peskine449bd832023-01-11 14:50:10 +01004008 if (used <= buf_len) {
4009 memcpy(p, ssl_serialized_session_header,
4010 sizeof(ssl_serialized_session_header));
4011 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004012 }
4013 }
4014
4015 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004016 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004017 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004018 used += 1 /* TLS version */
4019 + 1 /* endpoint */
4020 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004021 if (used <= buf_len) {
4022 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004023 *p++ = session->endpoint;
4024 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4025 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004026 }
4027
4028 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004029 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004030 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004031#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004032 case MBEDTLS_SSL_VERSION_TLS1_2:
4033 used += ssl_tls12_session_save(session, p, remaining_len);
4034 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004035#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4036
Jerry Yu251a12e2022-07-13 15:15:48 +08004037#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004038 case MBEDTLS_SSL_VERSION_TLS1_3:
4039 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4040 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4041 return ret;
4042 }
4043 used += out_len;
4044 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004045#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4046
Gilles Peskine449bd832023-01-11 14:50:10 +01004047 default:
4048 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004049 }
4050
4051 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004052 if (used > buf_len) {
4053 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4054 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004055
Gilles Peskine449bd832023-01-11 14:50:10 +01004056 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004057}
4058
4059/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004060 * Public wrapper for ssl_session_save()
4061 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004062int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4063 unsigned char *buf,
4064 size_t buf_len,
4065 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004066{
Gilles Peskine449bd832023-01-11 14:50:10 +01004067 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004068}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004069
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004070/*
4071 * Deserialize session, see mbedtls_ssl_session_save() for format.
4072 *
4073 * This internal version is wrapped by a public function that cleans up in
4074 * case of error, and has an extra option omit_header.
4075 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004076MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004077static int ssl_session_load(mbedtls_ssl_session *session,
4078 unsigned char omit_header,
4079 const unsigned char *buf,
4080 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004081{
4082 const unsigned char *p = buf;
4083 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004084 size_t remaining_len;
4085
4086
Gilles Peskine449bd832023-01-11 14:50:10 +01004087 if (session == NULL) {
4088 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4089 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004090
Gilles Peskine449bd832023-01-11 14:50:10 +01004091 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004092 /*
4093 * Check Mbed TLS version identifier
4094 */
4095
Gilles Peskine449bd832023-01-11 14:50:10 +01004096 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4097 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004098 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004099
4100 if (memcmp(p, ssl_serialized_session_header,
4101 sizeof(ssl_serialized_session_header)) != 0) {
4102 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4103 }
4104 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004105 }
4106
4107 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004108 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004109 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004110 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004111 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4112 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004113 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004114 session->endpoint = *p++;
4115 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4116 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004117
4118 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004119 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004120 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004121#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004122 case MBEDTLS_SSL_VERSION_TLS1_2:
4123 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004124#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4125
Jerry Yu438ddd82022-07-07 06:55:50 +00004126#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004127 case MBEDTLS_SSL_VERSION_TLS1_3:
4128 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004129#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4130
Gilles Peskine449bd832023-01-11 14:50:10 +01004131 default:
4132 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004133 }
4134}
4135
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004136/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004137 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004138 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004139int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4140 const unsigned char *buf,
4141 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004142{
Gilles Peskine449bd832023-01-11 14:50:10 +01004143 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004144
Gilles Peskine449bd832023-01-11 14:50:10 +01004145 if (ret != 0) {
4146 mbedtls_ssl_session_free(session);
4147 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004148
Gilles Peskine449bd832023-01-11 14:50:10 +01004149 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004150}
4151
4152/*
Paul Bakker1961b702013-01-25 14:49:24 +01004153 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004154 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004155MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004156static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004157{
4158 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4159
Ronald Cron66dbf912022-02-02 15:33:46 +01004160 /*
4161 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004162 * that were written into the output buffer by the previous handshake step,
4163 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004164 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4165 * We proceed to the next handshake step only when all data from the
4166 * previous one have been sent to the peer, thus we make sure that this is
4167 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4168 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4169 * we have to wait before to go ahead.
4170 * In the case of TLS 1.3, handshake step handlers do not send data to the
4171 * peer. Data are only sent here and through
4172 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004173 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004174 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004175 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4176 return ret;
4177 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004178
4179#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004180 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4181 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4182 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4183 return ret;
4184 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004185 }
4186#endif /* MBEDTLS_SSL_PROTO_DTLS */
4187
Gilles Peskine449bd832023-01-11 14:50:10 +01004188 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004189}
4190
Gilles Peskine449bd832023-01-11 14:50:10 +01004191int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004192{
Hanno Becker41934dd2021-08-07 19:13:43 +01004193 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004194
Gilles Peskine449bd832023-01-11 14:50:10 +01004195 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004196 ssl->conf == NULL ||
4197 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004198 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4199 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004200 }
4201
Gilles Peskine449bd832023-01-11 14:50:10 +01004202 ret = ssl_prepare_handshake_step(ssl);
4203 if (ret != 0) {
4204 return ret;
4205 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004206
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 ret = mbedtls_ssl_handle_pending_alert(ssl);
4208 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004209 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004210 }
Jerry Yue7047812021-09-13 19:26:39 +08004211
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004212 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4213 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4214 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4215
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004216#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004217 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4218 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004219 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004220
Gilles Peskine449bd832023-01-11 14:50:10 +01004221 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004222 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskinef670ba52025-03-07 15:09:32 +01004223 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004224 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004225 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004226
Ronald Cron9f0fba32022-02-10 16:45:15 +01004227 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004228 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004229 break;
4230
4231 default:
4232#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004233 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4234 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4235 } else {
4236 ret = mbedtls_ssl_handshake_client_step(ssl);
4237 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004238#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004239 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004240#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004241 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004242#endif
4243 }
Jerry Yub9930e72021-08-06 17:11:51 +08004244 }
Ronald Cron6291b232023-03-08 15:51:25 +01004245#endif /* MBEDTLS_SSL_CLI_C */
4246
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004247#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004248 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004249#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4250 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004251 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004252 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004253 ret = mbedtls_ssl_handshake_server_step(ssl);
4254 }
Ronald Cron6291b232023-03-08 15:51:25 +01004255#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4256 ret = mbedtls_ssl_handshake_server_step(ssl);
4257#else
4258 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004259#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004260 }
4261#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004262
Gilles Peskine449bd832023-01-11 14:50:10 +01004263 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004264 /* handshake_step return error. And it is same
4265 * with alert_reason.
4266 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004267 if (ssl->send_alert) {
4268 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004269 goto cleanup;
4270 }
4271 }
4272
4273cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004274 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004275}
4276
4277/*
4278 * Perform the SSL handshake
4279 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004280int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004281{
4282 int ret = 0;
4283
Hanno Beckera817ea42020-10-20 15:20:23 +01004284 /* Sanity checks */
4285
Gilles Peskine449bd832023-01-11 14:50:10 +01004286 if (ssl == NULL || ssl->conf == NULL) {
4287 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4288 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004289
Hanno Beckera817ea42020-10-20 15:20:23 +01004290#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004291 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4292 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4293 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4294 "mbedtls_ssl_set_timer_cb() for DTLS"));
4295 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004296 }
4297#endif /* MBEDTLS_SSL_PROTO_DTLS */
4298
Gilles Peskine449bd832023-01-11 14:50:10 +01004299 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004300
Hanno Beckera817ea42020-10-20 15:20:23 +01004301 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4303 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004304
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004306 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004307 }
Paul Bakker1961b702013-01-25 14:49:24 +01004308 }
4309
Gilles Peskine449bd832023-01-11 14:50:10 +01004310 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004311
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004313}
4314
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004315#if defined(MBEDTLS_SSL_RENEGOTIATION)
4316#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004317/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004318 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004319 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004320MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004321static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004322{
Janos Follath865b3eb2019-12-16 11:46:15 +00004323 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004324
Gilles Peskine449bd832023-01-11 14:50:10 +01004325 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004326
4327 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004328 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4329 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004330
Gilles Peskine449bd832023-01-11 14:50:10 +01004331 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4332 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4333 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004334 }
4335
Gilles Peskine449bd832023-01-11 14:50:10 +01004336 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004337
Gilles Peskine449bd832023-01-11 14:50:10 +01004338 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004339}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004340#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004341
4342/*
4343 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004344 * - any side: calling mbedtls_ssl_renegotiate(),
4345 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4346 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004347 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004348 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004349 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004350 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004351int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004352{
Janos Follath865b3eb2019-12-16 11:46:15 +00004353 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004354
Gilles Peskine449bd832023-01-11 14:50:10 +01004355 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004356
Gilles Peskine449bd832023-01-11 14:50:10 +01004357 if ((ret = ssl_handshake_init(ssl)) != 0) {
4358 return ret;
4359 }
Paul Bakker48916f92012-09-16 19:57:18 +00004360
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004361 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4362 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004363#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004364 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4365 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4366 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004367 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004368 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004369 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004370 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004371 }
4372#endif
4373
Gilles Peskinef670ba52025-03-07 15:09:32 +01004374 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_REQUEST);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004375 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004376
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4378 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4379 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004380 }
4381
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004383
Gilles Peskine449bd832023-01-11 14:50:10 +01004384 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004385}
4386
4387/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004388 * Renegotiate current connection on client,
4389 * or request renegotiation on server
4390 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004391int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004392{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004393 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004394
Gilles Peskine449bd832023-01-11 14:50:10 +01004395 if (ssl == NULL || ssl->conf == NULL) {
4396 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4397 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004398
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004399#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004400 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004401 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4402 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4403 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4404 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004405
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004406 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004407
4408 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004409 if (ssl->out_left != 0) {
4410 return mbedtls_ssl_flush_output(ssl);
4411 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004412
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004414 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004415#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004416
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004417#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004418 /*
4419 * On client, either start the renegotiation process or,
4420 * if already in progress, continue the handshake
4421 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004422 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4423 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4424 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004425 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004426
4427 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4428 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4429 return ret;
4430 }
4431 } else {
4432 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4433 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4434 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004435 }
4436 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004437#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004438
Gilles Peskine449bd832023-01-11 14:50:10 +01004439 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004440}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004441#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004442
Gilles Peskine449bd832023-01-11 14:50:10 +01004443void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004444{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004445 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4446
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004448 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004449 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004450
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004451#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Brett Warrene0edc842021-08-17 09:53:13 +01004452#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004453 if (ssl->handshake->group_list_heap_allocated) {
4454 mbedtls_free((void *) handshake->group_list);
4455 }
Brett Warrene0edc842021-08-17 09:53:13 +01004456 handshake->group_list = NULL;
4457#endif /* MBEDTLS_DEPRECATED_REMOVED */
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004458#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Brett Warrene0edc842021-08-17 09:53:13 +01004459
Ronald Crone68ab4f2022-10-05 12:46:29 +02004460#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004461#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004462 if (ssl->handshake->sig_algs_heap_allocated) {
4463 mbedtls_free((void *) handshake->sig_algs);
4464 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004465 handshake->sig_algs = NULL;
4466#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004467#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 if (ssl->handshake->certificate_request_context) {
4469 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004470 }
4471#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004472#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004473
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004474#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Ben Taylorcd2660f2025-03-21 13:13:29 +00004475 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
Ben Taylorc12152e2025-03-21 11:03:04 +00004476 ssl->conf->f_async_cancel(ssl);
4477 handshake->async_in_progress = 0;
Ben Taylor1cd1e012025-03-18 11:50:39 +00004478 }
Ben Taylor6ff2da12025-03-17 09:26:20 +00004479
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004480#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4481
Elena Uziunaite0916cd72024-05-23 17:01:07 +01004482#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01004483 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004484#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01004485#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01004486 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004487#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004488
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004489#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004491 /*
4492 * Opaque keys are not stored in the handshake's data and it's the user
4493 * responsibility to destroy them. Clear ones, instead, are created by
4494 * the TLS library and should be destroyed at the same level
4495 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004496 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4497 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004498 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004499 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004500#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004502 handshake->ecjpake_cache = NULL;
4503 handshake->ecjpake_cache_len = 0;
4504#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004505#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004506
Valerio Setti7aeec542023-07-05 18:57:21 +02004507#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004508 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004509 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004510 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004511 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004512#endif
4513
Ronald Cron73fe8df2022-10-05 14:31:43 +02004514#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004516 /* The maintenance of the external PSK key slot is the
4517 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004518 if (ssl->handshake->psk_opaque_is_internal) {
4519 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004520 ssl->handshake->psk_opaque_is_internal = 0;
4521 }
4522 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4523 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02004524#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004525
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004526#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4527 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004528 /*
4529 * Free only the linked list wrapper, not the keys themselves
4530 * since the belong to the SNI callback
4531 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004533#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004534
Gilles Peskineeccd8882020-03-10 12:19:08 +01004535#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004536 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4537 if (handshake->ecrs_peer_cert != NULL) {
4538 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4539 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004540 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004541#endif
4542
Hanno Becker75173122019-02-06 16:18:31 +00004543#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4544 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004546#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4547
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004548#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4550 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004551#endif /* MBEDTLS_SSL_CLI_C &&
4552 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004553
4554#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004555 mbedtls_ssl_flight_free(handshake->flight);
4556 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004557#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004558
Valerio Settiea59c432023-07-25 11:14:03 +02004559#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004560 if (handshake->xxdh_psa_privkey_is_external == 0) {
4561 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 }
Valerio Settiea59c432023-07-25 11:14:03 +02004563#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004564
Ronald Cron6f135e12021-12-08 16:57:54 +01004565#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004566 mbedtls_ssl_transform_free(handshake->transform_handshake);
4567 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004568#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004569 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4570 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004571#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004572#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004573
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004574
4575#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4576 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4577 * processes datagrams and the fact that a datagram is allowed to have
4578 * several records in it, it is possible that the I/O buffers are not
4579 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4581 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004582#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004583
Jerry Yuba9c7272021-10-30 11:54:10 +08004584 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004585 mbedtls_platform_zeroize(handshake,
4586 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004587}
4588
Gilles Peskine449bd832023-01-11 14:50:10 +01004589void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004590{
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004592 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004594
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004595#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004596 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004597#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004598
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004599#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004600#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4601 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004602 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004603#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004604 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004605#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004606
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004607#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4608 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004609 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004610#endif
4611
Gilles Peskine449bd832023-01-11 14:50:10 +01004612 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004613}
4614
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004615#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004616
4617#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4618#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4619#else
4620#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4621#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4622
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004623#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004624
4625#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4626#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4627#else
4628#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4629#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4630
4631#if defined(MBEDTLS_SSL_ALPN)
4632#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4633#else
4634#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4635#endif /* MBEDTLS_SSL_ALPN */
4636
4637#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4638#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4639#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4640#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4641
4642#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004643 ((uint32_t) ( \
4644 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4645 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4646 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4647 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4648 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4649 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4650 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4651 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004652
Chien Wong4e9683e2023-12-28 17:07:43 +08004653static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004654 MBEDTLS_VERSION_MAJOR,
4655 MBEDTLS_VERSION_MINOR,
4656 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4658 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4659 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4660 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4661 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004662};
4663
Paul Bakker5121ce52009-01-03 21:22:43 +00004664/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004665 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004666 *
4667 * The format of the serialized data is:
4668 * (in the presentation language of TLS, RFC 8446 section 3)
4669 *
4670 * // header
4671 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004672 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004673 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004674 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004675 * Note: When updating the format, remember to keep these
4676 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004677 *
4678 * // session sub-structure
4679 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4680 * // transform sub-structure
4681 * uint8 random[64]; // ServerHello.random+ClientHello.random
4682 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4683 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4684 * // fields from ssl_context
4685 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4686 * uint64 in_window_top; // DTLS: last validated record seq_num
4687 * uint64 in_window; // DTLS: bitmask for replay protection
4688 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4689 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4690 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4691 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4692 *
4693 * Note that many fields of the ssl_context or sub-structures are not
4694 * serialized, as they fall in one of the following categories:
4695 *
4696 * 1. forced value (eg in_left must be 0)
4697 * 2. pointer to dynamically-allocated memory (eg session, transform)
4698 * 3. value can be re-derived from other data (eg session keys from MS)
4699 * 4. value was temporary (eg content of input buffer)
4700 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004701 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004702int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4703 unsigned char *buf,
4704 size_t buf_len,
4705 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004706{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004707 unsigned char *p = buf;
4708 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004709 size_t session_len;
4710 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004711
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004712 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004713 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4714 * this function's documentation.
4715 *
4716 * These are due to assumptions/limitations in the implementation. Some of
4717 * them are likely to stay (no handshake in progress) some might go away
4718 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004719 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004720 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004721 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4722 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4723 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004724 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 if (ssl->handshake != NULL) {
4726 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4727 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004728 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004729 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004730 if (ssl->transform == NULL || ssl->session == NULL) {
4731 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4732 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004733 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004734 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004735 if (mbedtls_ssl_check_pending(ssl) != 0) {
4736 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4737 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004738 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 if (ssl->out_left != 0) {
4740 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4741 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004742 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004743 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4745 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is 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 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004749 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4750 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4751 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004752 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004753 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004754 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4755 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4756 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004757 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004758 /* Renegotiation must not be enabled */
4759#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004760 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4761 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4762 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004763 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004764#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004765
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004766 /*
4767 * Version and format identifier
4768 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004770
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 if (used <= buf_len) {
4772 memcpy(p, ssl_serialized_context_header,
4773 sizeof(ssl_serialized_context_header));
4774 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004775 }
4776
4777 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004778 * Session (length + data)
4779 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004780 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4781 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4782 return ret;
4783 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004784
4785 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004786 if (used <= buf_len) {
4787 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004788 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004789
Gilles Peskine449bd832023-01-11 14:50:10 +01004790 ret = ssl_session_save(ssl->session, 1,
4791 p, session_len, &session_len);
4792 if (ret != 0) {
4793 return ret;
4794 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004795
4796 p += session_len;
4797 }
4798
4799 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004800 * Transform
4801 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 used += sizeof(ssl->transform->randbytes);
4803 if (used <= buf_len) {
4804 memcpy(p, ssl->transform->randbytes,
4805 sizeof(ssl->transform->randbytes));
4806 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004807 }
4808
4809#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004810 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004811 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004812 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004814 p += ssl->transform->in_cid_len;
4815
4816 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004818 p += ssl->transform->out_cid_len;
4819 }
4820#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4821
4822 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004823 * Saved fields from top-level ssl_context structure
4824 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004825 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 if (used <= buf_len) {
4827 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004828 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004829 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004830
4831#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4832 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 if (used <= buf_len) {
4834 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004835 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004836
Gilles Peskine449bd832023-01-11 14:50:10 +01004837 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004838 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004839 }
4840#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4841
4842#if defined(MBEDTLS_SSL_PROTO_DTLS)
4843 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004844 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004845 *p++ = ssl->disable_datagram_packing;
4846 }
4847#endif /* MBEDTLS_SSL_PROTO_DTLS */
4848
Jerry Yuae0b2e22021-10-08 15:21:19 +08004849 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 if (used <= buf_len) {
4851 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004852 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004853 }
4854
4855#if defined(MBEDTLS_SSL_PROTO_DTLS)
4856 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004857 if (used <= buf_len) {
4858 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004859 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004860 }
4861#endif /* MBEDTLS_SSL_PROTO_DTLS */
4862
4863#if defined(MBEDTLS_SSL_ALPN)
4864 {
4865 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004867 : 0;
4868
4869 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004870 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004871 *p++ = alpn_len;
4872
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 if (ssl->alpn_chosen != NULL) {
4874 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004875 p += alpn_len;
4876 }
4877 }
4878 }
4879#endif /* MBEDTLS_SSL_ALPN */
4880
4881 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004882 * Done
4883 */
4884 *olen = used;
4885
Gilles Peskine449bd832023-01-11 14:50:10 +01004886 if (used > buf_len) {
4887 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4888 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004889
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004891
Gilles Peskine449bd832023-01-11 14:50:10 +01004892 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004893}
4894
4895/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004896 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004897 *
4898 * This internal version is wrapped by a public function that cleans up in
4899 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004900 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004901MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004902static int ssl_context_load(mbedtls_ssl_context *ssl,
4903 const unsigned char *buf,
4904 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004905{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004906 const unsigned char *p = buf;
4907 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004908 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004909 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004910#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004911 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004912#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004913
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004914 /*
4915 * The context should have been freshly setup or reset.
4916 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004917 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004918 * renegotiating, or if the user mistakenly loaded a session first.)
4919 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004920 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4921 ssl->session != NULL) {
4922 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004923 }
4924
4925 /*
4926 * We can't check that the config matches the initial one, but we can at
4927 * least check it matches the requirements for serializing.
4928 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004929 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004930#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004931 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004932#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004933 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4934 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4935 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4936 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004937 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004938 }
4939
Gilles Peskine449bd832023-01-11 14:50:10 +01004940 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004941
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004942 /*
4943 * Check version identifier
4944 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004945 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4946 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004947 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004948
4949 if (memcmp(p, ssl_serialized_context_header,
4950 sizeof(ssl_serialized_context_header)) != 0) {
4951 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4952 }
4953 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004954
4955 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004956 * Session
4957 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004958 if ((size_t) (end - p) < 4) {
4959 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4960 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004961
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004962 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004963 p += 4;
4964
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004965 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004966 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004967 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004968 ssl->session_in = ssl->session;
4969 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004970 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004971
Gilles Peskine449bd832023-01-11 14:50:10 +01004972 if ((size_t) (end - p) < session_len) {
4973 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4974 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004975
Gilles Peskine449bd832023-01-11 14:50:10 +01004976 ret = ssl_session_load(ssl->session, 1, p, session_len);
4977 if (ret != 0) {
4978 mbedtls_ssl_session_free(ssl->session);
4979 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004980 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004981
4982 p += session_len;
4983
4984 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004985 * Transform
4986 */
4987
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004988 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004989 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004990#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004991 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004992 ssl->transform_in = ssl->transform;
4993 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004994 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004995#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004996
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004997#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004998 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4999 if (prf_func == NULL) {
5000 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5001 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005002
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005003 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005004 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5005 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5006 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005007
Gilles Peskine449bd832023-01-11 14:50:10 +01005008 ret = ssl_tls12_populate_transform(ssl->transform,
5009 ssl->session->ciphersuite,
5010 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005011#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005012 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005013#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005014 prf_func,
5015 p, /* currently pointing to randbytes */
5016 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5017 ssl->conf->endpoint,
5018 ssl);
5019 if (ret != 0) {
5020 return ret;
5021 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005022#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005023 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005024
5025#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5026 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005027 if ((size_t) (end - p) < 1) {
5028 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5029 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005030
5031 ssl->transform->in_cid_len = *p++;
5032
Gilles Peskine449bd832023-01-11 14:50:10 +01005033 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5034 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5035 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005036
Gilles Peskine449bd832023-01-11 14:50:10 +01005037 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005038 p += ssl->transform->in_cid_len;
5039
5040 ssl->transform->out_cid_len = *p++;
5041
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5043 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5044 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005045
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005047 p += ssl->transform->out_cid_len;
5048#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5049
5050 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005051 * Saved fields from top-level ssl_context structure
5052 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005053 if ((size_t) (end - p) < 4) {
5054 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5055 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005056
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005057 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005058 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005059
5060#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005061 if ((size_t) (end - p) < 16) {
5062 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5063 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005064
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005065 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005066 p += 8;
5067
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005068 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005069 p += 8;
5070#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5071
5072#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 if ((size_t) (end - p) < 1) {
5074 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5075 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005076
5077 ssl->disable_datagram_packing = *p++;
5078#endif /* MBEDTLS_SSL_PROTO_DTLS */
5079
Gilles Peskine449bd832023-01-11 14:50:10 +01005080 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5081 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5082 }
5083 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5084 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005085
5086#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005087 if ((size_t) (end - p) < 2) {
5088 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5089 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005090
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005091 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005092 p += 2;
5093#endif /* MBEDTLS_SSL_PROTO_DTLS */
5094
5095#if defined(MBEDTLS_SSL_ALPN)
5096 {
5097 uint8_t alpn_len;
Gilles Peskinec4949d12025-05-27 19:45:29 +02005098 const char *const *cur;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005099
Gilles Peskine449bd832023-01-11 14:50:10 +01005100 if ((size_t) (end - p) < 1) {
5101 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5102 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005103
5104 alpn_len = *p++;
5105
Gilles Peskine449bd832023-01-11 14:50:10 +01005106 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005107 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5109 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005110 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005111 ssl->alpn_chosen = *cur;
5112 break;
5113 }
5114 }
5115 }
5116
5117 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005118 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5119 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5120 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005121
5122 p += alpn_len;
5123 }
5124#endif /* MBEDTLS_SSL_ALPN */
5125
5126 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005127 * Forced fields from top-level ssl_context structure
5128 *
5129 * Most of them already set to the correct value by mbedtls_ssl_init() and
5130 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5131 */
Gilles Peskinef670ba52025-03-07 15:09:32 +01005132 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Glenn Strauss60bfe602022-03-14 19:04:24 -04005133 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005134
Hanno Becker361b10d2019-08-30 10:42:49 +01005135 /* Adjust pointers for header fields of outgoing records to
5136 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005137 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005138
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005139#if defined(MBEDTLS_SSL_PROTO_DTLS)
5140 ssl->in_epoch = 1;
5141#endif
5142
5143 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5144 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005145 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5146 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005147 if (ssl->handshake != NULL) {
5148 mbedtls_ssl_handshake_free(ssl);
5149 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005150 ssl->handshake = NULL;
5151 }
5152
5153 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005154 * Done - should have consumed entire buffer
5155 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005156 if (p != end) {
5157 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5158 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005159
Gilles Peskine449bd832023-01-11 14:50:10 +01005160 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005161}
5162
5163/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005164 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005165 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005166int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5167 const unsigned char *buf,
5168 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005169{
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005171
Gilles Peskine449bd832023-01-11 14:50:10 +01005172 if (ret != 0) {
5173 mbedtls_ssl_free(context);
5174 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005175
Gilles Peskine449bd832023-01-11 14:50:10 +01005176 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005177}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005178#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005179
5180/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005181 * Free an SSL context
5182 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005183void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005184{
Gilles Peskine449bd832023-01-11 14:50:10 +01005185 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005186 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005187 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005188
Gilles Peskine449bd832023-01-11 14:50:10 +01005189 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005190
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005192#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5193 size_t out_buf_len = ssl->out_buf_len;
5194#else
5195 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5196#endif
5197
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005198 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005199 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005200 }
5201
Gilles Peskine449bd832023-01-11 14:50:10 +01005202 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005203#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5204 size_t in_buf_len = ssl->in_buf_len;
5205#else
5206 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5207#endif
5208
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005209 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005210 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005211 }
5212
Gilles Peskine449bd832023-01-11 14:50:10 +01005213 if (ssl->transform) {
5214 mbedtls_ssl_transform_free(ssl->transform);
5215 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005216 }
5217
Gilles Peskine449bd832023-01-11 14:50:10 +01005218 if (ssl->handshake) {
5219 mbedtls_ssl_handshake_free(ssl);
5220 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005221
5222#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005223 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5224 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005225#endif
5226
Gilles Peskine449bd832023-01-11 14:50:10 +01005227 mbedtls_ssl_session_free(ssl->session_negotiate);
5228 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005229 }
5230
Ronald Cron6f135e12021-12-08 16:57:54 +01005231#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005232 mbedtls_ssl_transform_free(ssl->transform_application);
5233 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005234#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005235
Gilles Peskine449bd832023-01-11 14:50:10 +01005236 if (ssl->session) {
5237 mbedtls_ssl_session_free(ssl->session);
5238 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005239 }
5240
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005241#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine4ac40082025-02-20 18:13:58 +01005242 mbedtls_ssl_free_hostname(ssl);
Paul Bakker0be444a2013-08-27 21:55:01 +02005243#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005244
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005245#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005246 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005247#endif
5248
Gilles Peskine449bd832023-01-11 14:50:10 +01005249 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005250
Paul Bakker86f04f42013-02-14 11:20:09 +01005251 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005252 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005253}
5254
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005255/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005256 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005257 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005258void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005259{
Gilles Peskine449bd832023-01-11 14:50:10 +01005260 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005261}
5262
Gilles Peskineae270bf2021-06-02 00:05:29 +02005263/* The selection should be the same as mbedtls_x509_crt_profile_default in
5264 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005265 * curves with a lower resource usage come first.
Manuel Pégourié-Gonnard93d45912025-01-14 11:45:44 +01005266 * See the documentation of mbedtls_ssl_conf_groups() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005267 * about this list.
5268 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005269static const uint16_t ssl_preset_default_groups[] = {
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005270#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Brett Warrene0edc842021-08-17 09:53:13 +01005271 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005272#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005273#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005274 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005275#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005276#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005277 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005278#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005279#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Brett Warrene0edc842021-08-17 09:53:13 +01005280 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005281#endif
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005282#if defined(PSA_WANT_ECC_SECP_R1_521)
Brett Warrene0edc842021-08-17 09:53:13 +01005283 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005284#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005285#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005286 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005287#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005288#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005289 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005290#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005291#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Brett Warrene0edc842021-08-17 09:53:13 +01005292 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005293#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005294#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005295 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5296 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5297 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5298 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5299 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5300#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005301 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005302};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005303
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005304static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005305 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5306 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5307 0
5308};
5309
Ronald Crone68ab4f2022-10-05 12:46:29 +02005310#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005311
Jerry Yu909df7b2022-01-22 11:56:27 +08005312/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005313 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005314 * rules SHOULD be upheld.
5315 * - No duplicate entries.
5316 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005317 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005318 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005319 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005320static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005321
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005322#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005323 defined(PSA_WANT_ALG_SHA_256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005324 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005325 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005326 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5327#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005328
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005329#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005330 defined(PSA_WANT_ALG_SHA_384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005331 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005332 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005333 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5334#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005335
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005336#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Gabor Mezeic15ef932024-06-13 12:53:54 +02005337 defined(PSA_WANT_ALG_SHA_512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005338 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005339 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005340 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5341#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005342
Gabor Mezeic15ef932024-06-13 12:53:54 +02005343#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005344 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005345#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005346
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005347#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005348 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005349#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005350
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005351#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005352 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005353#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005354
Gabor Mezeic15ef932024-06-13 12:53:54 +02005355#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005356 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Gabor Mezeic15ef932024-06-13 12:53:54 +02005357#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005358
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005359#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005360 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005361#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005362
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005363#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005364 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005365#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005366
Gabor Mezei15b95a62022-05-09 16:37:58 +02005367 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005368};
5369
5370/* NOTICE: see above */
5371#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Deomid rojer Ryabkove2d71cc2024-03-18 12:32:30 +00005372static const uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005373
Gabor Mezeic15ef932024-06-13 12:53:54 +02005374#if defined(PSA_WANT_ALG_SHA_512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005375#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005377#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005378#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5379 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005380#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005381#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005383#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005384#endif /* PSA_WANT_ALG_SHA_512 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005385
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005386#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005387#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005389#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005390#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5391 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005392#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005393#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005394 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005395#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005396#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005397
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005398#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005399#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005400 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005401#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005402#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5403 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005404#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005405#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005406 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005407#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005408#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005409
Gabor Mezei15b95a62022-05-09 16:37:58 +02005410 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005411};
5412#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005413
Jerry Yu909df7b2022-01-22 11:56:27 +08005414/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005415static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005416
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005417#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005418 defined(PSA_WANT_ALG_SHA_256) && \
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005419 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005420 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005421 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5422#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005423
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005424#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005425 defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005426 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu53037892022-01-25 11:02:06 +08005427 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005428 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5429#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005430
Gabor Mezei15b95a62022-05-09 16:37:58 +02005431 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005432};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005433
Jerry Yu909df7b2022-01-22 11:56:27 +08005434/* NOTICE: see above */
5435#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Deomid rojer Ryabkov7dddc172024-03-20 00:43:34 +00005436static const uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005437
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005438#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005439#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005441#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005442#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005443
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005444#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005445#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005446 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005447#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005448#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005449
Gabor Mezei15b95a62022-05-09 16:37:58 +02005450 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005451};
Jerry Yu909df7b2022-01-22 11:56:27 +08005452#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5453
Ronald Crone68ab4f2022-10-05 12:46:29 +02005454#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005455
Chien Wong4e9683e2023-12-28 17:07:43 +08005456static const uint16_t ssl_preset_suiteb_groups[] = {
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005457#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005458 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005459#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005460#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005461 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005462#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005463 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005464};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005465
Ronald Crone68ab4f2022-10-05 12:46:29 +02005466#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005467/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005468 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005469MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005470static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005471{
5472 size_t i, j;
5473 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005474
Gilles Peskine449bd832023-01-11 14:50:10 +01005475 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5476 for (j = 0; j < i; j++) {
5477 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005478 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005479 }
5480 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5481 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5482 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005483 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005484 }
5485 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005486 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005487}
5488
Ronald Crone68ab4f2022-10-05 12:46:29 +02005489#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005490
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005491/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005492 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005493 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005494int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5495 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005496{
Ronald Crone68ab4f2022-10-05 12:46:29 +02005497#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5499 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5500 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005501 }
5502
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5504 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5505 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005506 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005507
5508#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005509 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5510 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5511 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005512 }
5513
Gilles Peskine449bd832023-01-11 14:50:10 +01005514 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5515 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5516 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005517 }
5518#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005519#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005520
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005521 /* Use the functions here so that they are covered in tests,
5522 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 mbedtls_ssl_conf_endpoint(conf, endpoint);
5524 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005525
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005526 /*
5527 * Things that are common to all presets
5528 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005529#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005530 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005531 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5532#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5533 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5534#endif
5535 }
5536#endif
5537
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005538#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5539 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5540#endif
5541
5542#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5543 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5544#endif
5545
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005546#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005547 conf->f_cookie_write = ssl_cookie_write_dummy;
5548 conf->f_cookie_check = ssl_cookie_check_dummy;
5549#endif
5550
5551#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5552 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5553#endif
5554
Janos Follath088ce432017-04-10 12:42:31 +01005555#if defined(MBEDTLS_SSL_SRV_C)
5556 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005557 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005558#endif
5559
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005560#if defined(MBEDTLS_SSL_PROTO_DTLS)
5561 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5562 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5563#endif
5564
5565#if defined(MBEDTLS_SSL_RENEGOTIATION)
5566 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005567 memset(conf->renego_period, 0x00, 2);
5568 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005569#endif
5570
Ronald Cron6f135e12021-12-08 16:57:54 +01005571#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005572
5573#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005574 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005575#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005576 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005577#endif
5578#endif /* MBEDTLS_SSL_EARLY_DATA */
5579
Jerry Yud0766ec2022-09-22 10:46:57 +08005580#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005581 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005583#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005584 /*
5585 * Allow all TLS 1.3 key exchange modes by default.
5586 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005587 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005588#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005589
Gilles Peskine449bd832023-01-11 14:50:10 +01005590 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005591#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005592 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005593 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005594#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005595 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005596#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005597 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005598#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005599 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5600 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005601#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5602 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5603 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5604#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5605 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5606 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5607#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005608 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005609#endif
5610 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005611
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005612 /*
5613 * Preset-specific defaults
5614 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005615 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005616 /*
5617 * NSA Suite B
5618 */
5619 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005620
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005621 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005622
5623#if defined(MBEDTLS_X509_CRT_PARSE_C)
5624 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005625#endif
5626
Ronald Crone68ab4f2022-10-05 12:46:29 +02005627#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005628#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005629 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005630 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005631 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005632#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005633 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005634#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005635
Brett Warrene0edc842021-08-17 09:53:13 +01005636 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005637 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005638
5639 /*
5640 * Default
5641 */
5642 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005643
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005644 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005645
5646#if defined(MBEDTLS_X509_CRT_PARSE_C)
5647 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5648#endif
5649
Ronald Crone68ab4f2022-10-05 12:46:29 +02005650#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005651#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005652 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005653 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005654 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005655#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005656 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005657#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005658
Brett Warrene0edc842021-08-17 09:53:13 +01005659 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005660 }
5661
Gilles Peskine449bd832023-01-11 14:50:10 +01005662 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005663}
5664
5665/*
5666 * Free mbedtls_ssl_config
5667 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005668void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005669{
Troy-Butlerda73abc2024-04-02 13:37:31 -04005670 if (conf == NULL) {
5671 return;
5672 }
5673
Ronald Cron73fe8df2022-10-05 14:31:43 +02005674#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005675 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005676 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5677 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005678 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005679 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005680 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005681 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005682 }
5683
Gilles Peskine449bd832023-01-11 14:50:10 +01005684 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005685 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005686 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005687 conf->psk_identity_len = 0;
5688 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005689#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005690
5691#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005692 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005693#endif
5694
Gilles Peskine449bd832023-01-11 14:50:10 +01005695 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005696}
5697
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005698#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005699 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005700/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005701 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005702 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005703unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005704{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005705#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005706 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5707 return MBEDTLS_SSL_SIG_RSA;
5708 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005709#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005710#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005711 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5712 return MBEDTLS_SSL_SIG_ECDSA;
5713 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005714#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005715 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005716}
5717
Gilles Peskine449bd832023-01-11 14:50:10 +01005718unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005719{
Gilles Peskine449bd832023-01-11 14:50:10 +01005720 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005721 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005722 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005723 case MBEDTLS_PK_ECDSA:
5724 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005725 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005726 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005728 }
5729}
5730
Gilles Peskine449bd832023-01-11 14:50:10 +01005731mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005732{
Gilles Peskine449bd832023-01-11 14:50:10 +01005733 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005734#if defined(MBEDTLS_RSA_C)
5735 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005736 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005737#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005738#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005739 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005740 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005741#endif
5742 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005743 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005744 }
5745}
Valerio Settie9646ec2023-08-02 20:02:28 +02005746#endif /* MBEDTLS_PK_C &&
5747 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005748
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005749/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005750 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005751 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005752mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005753{
Gilles Peskine449bd832023-01-11 14:50:10 +01005754 switch (hash) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005755#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005756 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005757 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005758#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005759#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005760 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005761 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005762#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005763#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005764 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005765 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005766#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005767#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005768 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005770#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005771#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005772 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005773 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005774#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005775#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005776 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005777 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005778#endif
5779 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005780 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005781 }
5782}
5783
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005784/*
5785 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5786 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005787unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005788{
Gilles Peskine449bd832023-01-11 14:50:10 +01005789 switch (md) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005790#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005791 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005792 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005793#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005794#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005795 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005796 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005797#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005798#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005799 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005800 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005801#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005802#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005803 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005804 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005805#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005806#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005807 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005808 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005809#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005810#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005811 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005812 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005813#endif
5814 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005815 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005816 }
5817}
5818
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005819/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005820 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005821 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005822 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005823int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005824{
Manuel Pégourié-Gonnard6402c352025-01-14 12:23:56 +01005825 const uint16_t *group_list = ssl->conf->group_list;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005826
Gilles Peskine449bd832023-01-11 14:50:10 +01005827 if (group_list == NULL) {
5828 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005829 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005830
Gilles Peskine449bd832023-01-11 14:50:10 +01005831 for (; *group_list != 0; group_list++) {
5832 if (*group_list == tls_id) {
5833 return 0;
5834 }
5835 }
5836
5837 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005838}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005839
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005840#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005841/*
5842 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5843 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005844int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005845{
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005847
Gilles Peskine449bd832023-01-11 14:50:10 +01005848 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005849 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005850 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005851
Gilles Peskine449bd832023-01-11 14:50:10 +01005852 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005853}
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005854#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Valerio Setti67419f02023-01-04 16:12:42 +01005855
Valerio Setti18c9fed2022-12-30 17:44:24 +01005856static const struct {
5857 uint16_t tls_id;
5858 mbedtls_ecp_group_id ecp_group_id;
5859 psa_ecc_family_t psa_family;
5860 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005861} tls_id_match_table[] =
5862{
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005863#if defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02005864 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005865#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005866#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02005867 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005868#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005869#if defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005870 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005871#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005872#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005873 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005874#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005875#if defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005876 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005877#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005878#if defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005879 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005880#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005881#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005882 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005883#endif
Elena Uziunaiteeaa0cf02024-07-04 17:41:25 +01005884#if defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02005885 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005886#endif
Elena Uziunaitea3632862024-07-04 13:52:43 +01005887#if defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005888 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005889#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005890#if defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005891 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005892#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005893#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02005894 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005895#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005896#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005897 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005898#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005899 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005900};
5901
Gilles Peskine449bd832023-01-11 14:50:10 +01005902int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005903 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005904 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005905{
Gilles Peskine449bd832023-01-11 14:50:10 +01005906 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5907 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005908 if (type != NULL) {
5909 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005910 }
5911 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005912 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005913 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005914 return PSA_SUCCESS;
5915 }
5916 }
5917
5918 return PSA_ERROR_NOT_SUPPORTED;
5919}
5920
Gilles Peskine449bd832023-01-11 14:50:10 +01005921mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005922{
Gilles Peskine449bd832023-01-11 14:50:10 +01005923 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5924 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005925 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005926 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005927 }
5928
5929 return MBEDTLS_ECP_DP_NONE;
5930}
5931
Gilles Peskine449bd832023-01-11 14:50:10 +01005932uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005933{
Gilles Peskine449bd832023-01-11 14:50:10 +01005934 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5935 i++) {
5936 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005937 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005939 }
5940
5941 return 0;
5942}
5943
Valerio Setti67419f02023-01-04 16:12:42 +01005944#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005945static const struct {
5946 uint16_t tls_id;
5947 const char *name;
5948} tls_id_curve_name_table[] =
5949{
Valerio Setti54e23792023-07-07 10:49:27 +02005950 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5951 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5952 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5953 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5954 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5955 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5956 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5957 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5958 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5959 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5960 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5961 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5962 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005963 { 0, NULL },
5964};
5965
Gilles Peskine449bd832023-01-11 14:50:10 +01005966const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005967{
Valerio Settiacd32c02023-06-29 18:06:29 +02005968 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5969 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5970 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005971 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005972 }
5973
5974 return NULL;
5975}
Valerio Setti67419f02023-01-04 16:12:42 +01005976#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005977
Gilles Peskine449bd832023-01-11 14:50:10 +01005978int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5979 const mbedtls_md_type_t md,
5980 unsigned char *dst,
5981 size_t dst_len,
5982 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005983{
Ronald Cronf6893e12022-01-07 22:09:01 +01005984 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5985 psa_hash_operation_t *hash_operation_to_clone;
5986 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5987
Jerry Yu148165c2021-09-24 23:20:59 +08005988 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005989
Gilles Peskine449bd832023-01-11 14:50:10 +01005990 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005991#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005992 case MBEDTLS_MD_SHA384:
5993 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5994 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005995#endif
5996
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005997#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005998 case MBEDTLS_MD_SHA256:
5999 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6000 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006001#endif
6002
Gilles Peskine449bd832023-01-11 14:50:10 +01006003 default:
6004 goto exit;
6005 }
6006
6007 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6008 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006009 goto exit;
6010 }
6011
Gilles Peskine449bd832023-01-11 14:50:10 +01006012 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6013 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006014 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006015 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006016
6017exit:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006018#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006019 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006020 (void) ssl;
6021#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006022 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006023}
Jerry Yu24c0ec32021-09-09 14:21:07 +08006024
Ronald Crone68ab4f2022-10-05 12:46:29 +02006025#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006026/* mbedtls_ssl_parse_sig_alg_ext()
6027 *
6028 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6029 * value (TLS 1.3 RFC8446):
6030 * enum {
6031 * ....
6032 * ecdsa_secp256r1_sha256( 0x0403 ),
6033 * ecdsa_secp384r1_sha384( 0x0503 ),
6034 * ecdsa_secp521r1_sha512( 0x0603 ),
6035 * ....
6036 * } SignatureScheme;
6037 *
6038 * struct {
6039 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6040 * } SignatureSchemeList;
6041 *
6042 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6043 * value (TLS 1.2 RFC5246):
6044 * enum {
6045 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6046 * sha512(6), (255)
6047 * } HashAlgorithm;
6048 *
6049 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6050 * SignatureAlgorithm;
6051 *
6052 * struct {
6053 * HashAlgorithm hash;
6054 * SignatureAlgorithm signature;
6055 * } SignatureAndHashAlgorithm;
6056 *
6057 * SignatureAndHashAlgorithm
6058 * supported_signature_algorithms<2..2^16-2>;
6059 *
6060 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6061 * generalization of the TLS 1.2 signature algorithm extension.
6062 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6063 * `SignatureScheme` field of TLS 1.3
6064 *
6065 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006066int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6067 const unsigned char *buf,
6068 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006069{
6070 const unsigned char *p = buf;
6071 size_t supported_sig_algs_len = 0;
6072 const unsigned char *supported_sig_algs_end;
6073 uint16_t sig_alg;
6074 uint32_t common_idx = 0;
6075
Gilles Peskine449bd832023-01-11 14:50:10 +01006076 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6077 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006078 p += 2;
6079
Gilles Peskine449bd832023-01-11 14:50:10 +01006080 memset(ssl->handshake->received_sig_algs, 0,
6081 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006082
Gilles Peskine449bd832023-01-11 14:50:10 +01006083 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006084 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006085 while (p < supported_sig_algs_end) {
6086 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6087 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006088 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006089 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6090 sig_alg,
6091 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006092#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6094 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6095 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006096 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006097 }
6098#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006099
Gilles Peskine449bd832023-01-11 14:50:10 +01006100 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6101 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006102
Gilles Peskine449bd832023-01-11 14:50:10 +01006103 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006104 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6105 common_idx += 1;
6106 }
6107 }
6108 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006109 if (p != end) {
6110 MBEDTLS_SSL_DEBUG_MSG(1,
6111 ("Signature algorithms extension length misaligned"));
6112 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6113 MBEDTLS_ERR_SSL_DECODE_ERROR);
6114 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006115 }
6116
Gilles Peskine449bd832023-01-11 14:50:10 +01006117 if (common_idx == 0) {
6118 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6119 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6120 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6121 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006122 }
6123
Gabor Mezei15b95a62022-05-09 16:37:58 +02006124 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006125 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006126}
6127
Ronald Crone68ab4f2022-10-05 12:46:29 +02006128#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006129
Jerry Yudc7bd172022-02-17 13:44:15 +08006130#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6131
Jerry Yudc7bd172022-02-17 13:44:15 +08006132
Gilles Peskine449bd832023-01-11 14:50:10 +01006133static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6134 mbedtls_svc_key_id_t key,
6135 psa_algorithm_t alg,
6136 const unsigned char *raw_psk, size_t raw_psk_length,
6137 const unsigned char *seed, size_t seed_length,
6138 const unsigned char *label, size_t label_length,
6139 const unsigned char *other_secret,
6140 size_t other_secret_length,
6141 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006142{
6143 psa_status_t status;
6144
Gilles Peskine449bd832023-01-11 14:50:10 +01006145 status = psa_key_derivation_setup(derivation, alg);
6146 if (status != PSA_SUCCESS) {
6147 return status;
6148 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006149
Gilles Peskine449bd832023-01-11 14:50:10 +01006150 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6151 status = psa_key_derivation_input_bytes(derivation,
6152 PSA_KEY_DERIVATION_INPUT_SEED,
6153 seed, seed_length);
6154 if (status != PSA_SUCCESS) {
6155 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006156 }
6157
Gilles Peskine449bd832023-01-11 14:50:10 +01006158 if (other_secret != NULL) {
6159 status = psa_key_derivation_input_bytes(derivation,
6160 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6161 other_secret, other_secret_length);
6162 if (status != PSA_SUCCESS) {
6163 return status;
6164 }
6165 }
6166
6167 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006168 status = psa_key_derivation_input_bytes(
6169 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006170 raw_psk, raw_psk_length);
6171 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006172 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006173 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006174 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006175 if (status != PSA_SUCCESS) {
6176 return status;
6177 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006178
Gilles Peskine449bd832023-01-11 14:50:10 +01006179 status = psa_key_derivation_input_bytes(derivation,
6180 PSA_KEY_DERIVATION_INPUT_LABEL,
6181 label, label_length);
6182 if (status != PSA_SUCCESS) {
6183 return status;
6184 }
6185 } else {
6186 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006187 }
6188
Gilles Peskine449bd832023-01-11 14:50:10 +01006189 status = psa_key_derivation_set_capacity(derivation, capacity);
6190 if (status != PSA_SUCCESS) {
6191 return status;
6192 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006193
Gilles Peskine449bd832023-01-11 14:50:10 +01006194 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006195}
6196
Andrzej Kurek57d10632022-10-24 10:32:01 -04006197#if defined(PSA_WANT_ALG_SHA_384) || \
6198 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006199MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006200static int tls_prf_generic(mbedtls_md_type_t md_type,
6201 const unsigned char *secret, size_t slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006202 const char *label, size_t label_len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006203 const unsigned char *random, size_t rlen,
6204 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006205{
6206 psa_status_t status;
6207 psa_algorithm_t alg;
6208 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6209 psa_key_derivation_operation_t derivation =
6210 PSA_KEY_DERIVATION_OPERATION_INIT;
6211
Gilles Peskine449bd832023-01-11 14:50:10 +01006212 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006213 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006214 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006215 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006216 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006217
6218 /* Normally a "secret" should be long enough to be impossible to
6219 * find by brute force, and in particular should not be empty. But
6220 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6221 * and for this use case it makes sense to have a 0-length "secret".
6222 * Since the key API doesn't allow importing a key of length 0,
6223 * keep master_key=0, which setup_psa_key_derivation() understands
6224 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006225 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006226 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006227 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6228 psa_set_key_algorithm(&key_attributes, alg);
6229 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006230
Gilles Peskine449bd832023-01-11 14:50:10 +01006231 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6232 if (status != PSA_SUCCESS) {
6233 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6234 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006235 }
6236
Gilles Peskine449bd832023-01-11 14:50:10 +01006237 status = setup_psa_key_derivation(&derivation,
6238 master_key, alg,
6239 NULL, 0,
6240 random, rlen,
6241 (unsigned char const *) label,
Max Fillingerf2dda152024-10-23 15:47:23 +02006242 label_len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 NULL, 0,
6244 dlen);
6245 if (status != PSA_SUCCESS) {
6246 psa_key_derivation_abort(&derivation);
6247 psa_destroy_key(master_key);
6248 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006249 }
6250
Gilles Peskine449bd832023-01-11 14:50:10 +01006251 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6252 if (status != PSA_SUCCESS) {
6253 psa_key_derivation_abort(&derivation);
6254 psa_destroy_key(master_key);
6255 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006256 }
6257
Gilles Peskine449bd832023-01-11 14:50:10 +01006258 status = psa_key_derivation_abort(&derivation);
6259 if (status != PSA_SUCCESS) {
6260 psa_destroy_key(master_key);
6261 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006262 }
6263
Gilles Peskine449bd832023-01-11 14:50:10 +01006264 if (!mbedtls_svc_key_id_is_null(master_key)) {
6265 status = psa_destroy_key(master_key);
6266 }
6267 if (status != PSA_SUCCESS) {
6268 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6269 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006270
Gilles Peskine449bd832023-01-11 14:50:10 +01006271 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006272}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006273#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006274
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006275#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006276MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006277static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6278 const char *label,
6279 const unsigned char *random, size_t rlen,
6280 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006281{
Gilles Peskine449bd832023-01-11 14:50:10 +01006282 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006283 label, strlen(label), random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006284}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006285#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006286
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006287#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006288MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006289static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6290 const char *label,
6291 const unsigned char *random, size_t rlen,
6292 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006293{
Gilles Peskine449bd832023-01-11 14:50:10 +01006294 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006295 label, strlen(label), random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006296}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006297#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006298
Jerry Yuf009d862022-02-17 14:01:37 +08006299/*
6300 * Set appropriate PRF function and other SSL / TLS1.2 functions
6301 *
6302 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006303 * - hash associated with the ciphersuite (only used by TLS 1.2)
6304 *
6305 * Outputs:
6306 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6307 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006308MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006309static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6310 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006311{
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006312#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006313 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006314 handshake->tls_prf = tls_prf_sha384;
6315 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6316 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006317 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006318#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006319#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuf009d862022-02-17 14:01:37 +08006320 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006321 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006322 handshake->tls_prf = tls_prf_sha256;
6323 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6324 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6325 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006326#else
Jerry Yuf009d862022-02-17 14:01:37 +08006327 {
Jerry Yuf009d862022-02-17 14:01:37 +08006328 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006329 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006330 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006331 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006332#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006333
Gilles Peskine449bd832023-01-11 14:50:10 +01006334 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006335}
Jerry Yud6ab2352022-02-17 14:03:43 +08006336
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006337/*
6338 * Compute master secret if needed
6339 *
6340 * Parameters:
6341 * [in/out] handshake
6342 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6343 * (PSA-PSK) ciphersuite_info, psk_opaque
6344 * [out] premaster (cleared)
6345 * [out] master
6346 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6347 * debug: conf->f_dbg, conf->p_dbg
6348 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006349 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006350 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006351MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006352static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6353 unsigned char *master,
6354 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006355{
6356 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6357
6358 /* cf. RFC 5246, Section 8.1:
6359 * "The master secret is always exactly 48 bytes in length." */
6360 size_t const master_secret_len = 48;
6361
6362#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6363 unsigned char session_hash[48];
6364#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6365
6366 /* The label for the KDF used for key expansion.
6367 * This is either "master secret" or "extended master secret"
6368 * depending on whether the Extended Master Secret extension
6369 * is used. */
6370 char const *lbl = "master secret";
6371
Przemek Stekielae4ed302022-04-05 17:15:55 +02006372 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006373 * - If the Extended Master Secret extension is not used,
6374 * this is ClientHello.Random + ServerHello.Random
6375 * (see Sect. 8.1 in RFC 5246).
6376 * - If the Extended Master Secret extension is used,
6377 * this is the transcript of the handshake so far.
6378 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006379 unsigned char const *seed = handshake->randbytes;
6380 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006381
6382#if !defined(MBEDTLS_DEBUG_C) && \
6383 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006384 !defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006385 ssl = NULL; /* make sure we don't use it except for those cases */
6386 (void) ssl;
6387#endif
6388
Gilles Peskine449bd832023-01-11 14:50:10 +01006389 if (handshake->resume != 0) {
6390 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6391 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006392 }
6393
6394#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006395 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006396 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006397 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006398 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6399 if (ret != 0) {
6400 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6401 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006402
Gilles Peskine449bd832023-01-11 14:50:10 +01006403 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6404 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006405 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006406#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006407
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006408#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006409 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006410 /* Perform PSK-to-MS expansion in a single step. */
6411 psa_status_t status;
6412 psa_algorithm_t alg;
6413 mbedtls_svc_key_id_t psk;
6414 psa_key_derivation_operation_t derivation =
6415 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006416 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006417
Gilles Peskine449bd832023-01-11 14:50:10 +01006418 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006419
Gilles Peskine449bd832023-01-11 14:50:10 +01006420 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006421
Gilles Peskine449bd832023-01-11 14:50:10 +01006422 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006423 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006424 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006425 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006426 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006427
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006428 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006429 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006430
Gilles Peskine449bd832023-01-11 14:50:10 +01006431 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006432 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006433 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006434 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006435 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006436 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
6437 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6438 other_secret = handshake->premaster + 2;
6439 break;
6440 default:
6441 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006442 }
6443
Gilles Peskine449bd832023-01-11 14:50:10 +01006444 status = setup_psa_key_derivation(&derivation, psk, alg,
6445 ssl->conf->psk, ssl->conf->psk_len,
6446 seed, seed_len,
6447 (unsigned char const *) lbl,
6448 (size_t) strlen(lbl),
6449 other_secret, other_secret_len,
6450 master_secret_len);
6451 if (status != PSA_SUCCESS) {
6452 psa_key_derivation_abort(&derivation);
6453 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006454 }
6455
Gilles Peskine449bd832023-01-11 14:50:10 +01006456 status = psa_key_derivation_output_bytes(&derivation,
6457 master,
6458 master_secret_len);
6459 if (status != PSA_SUCCESS) {
6460 psa_key_derivation_abort(&derivation);
6461 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006462 }
6463
Gilles Peskine449bd832023-01-11 14:50:10 +01006464 status = psa_key_derivation_abort(&derivation);
6465 if (status != PSA_SUCCESS) {
6466 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6467 }
6468 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006469#endif
6470 {
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006471#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006472 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006473 psa_status_t status;
6474 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6475 psa_key_derivation_operation_t derivation =
6476 PSA_KEY_DERIVATION_OPERATION_INIT;
6477
Gilles Peskine449bd832023-01-11 14:50:10 +01006478 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006479
6480 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6481
Gilles Peskine449bd832023-01-11 14:50:10 +01006482 status = psa_key_derivation_setup(&derivation, alg);
6483 if (status != PSA_SUCCESS) {
6484 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006485 }
6486
Gilles Peskine449bd832023-01-11 14:50:10 +01006487 status = psa_key_derivation_set_capacity(&derivation,
6488 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6489 if (status != PSA_SUCCESS) {
6490 psa_key_derivation_abort(&derivation);
6491 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006492 }
6493
Gilles Peskine449bd832023-01-11 14:50:10 +01006494 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6495 &derivation);
6496 if (status != PSA_SUCCESS) {
6497 psa_key_derivation_abort(&derivation);
6498 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006499 }
6500
Gilles Peskine449bd832023-01-11 14:50:10 +01006501 status = psa_key_derivation_output_bytes(&derivation,
6502 handshake->premaster,
6503 handshake->pmslen);
6504 if (status != PSA_SUCCESS) {
6505 psa_key_derivation_abort(&derivation);
6506 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6507 }
6508
6509 status = psa_key_derivation_abort(&derivation);
6510 if (status != PSA_SUCCESS) {
6511 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006512 }
6513 }
6514#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006515 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6516 lbl, seed, seed_len,
6517 master,
6518 master_secret_len);
6519 if (ret != 0) {
6520 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6521 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006522 }
6523
Gilles Peskine449bd832023-01-11 14:50:10 +01006524 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6525 handshake->premaster,
6526 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006527
Gilles Peskine449bd832023-01-11 14:50:10 +01006528 mbedtls_platform_zeroize(handshake->premaster,
6529 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006530 }
6531
Gilles Peskine449bd832023-01-11 14:50:10 +01006532 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006533}
6534
Gilles Peskine449bd832023-01-11 14:50:10 +01006535int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006536{
6537 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6538 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6539 ssl->handshake->ciphersuite_info;
6540
Gilles Peskine449bd832023-01-11 14:50:10 +01006541 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006542
6543 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006544 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006545 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006546 if (ret != 0) {
6547 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6548 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006549 }
6550
6551 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006552 ret = ssl_compute_master(ssl->handshake,
6553 ssl->session_negotiate->master,
6554 ssl);
6555 if (ret != 0) {
6556 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6557 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006558 }
6559
6560 /* Swap the client and server random values:
6561 * - MS derivation wanted client+server (RFC 5246 8.1)
6562 * - key derivation wants server+client (RFC 5246 6.3) */
6563 {
6564 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006565 memcpy(tmp, ssl->handshake->randbytes, 64);
6566 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6567 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6568 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006569 }
6570
6571 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006572 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6573 ssl->session_negotiate->ciphersuite,
6574 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006575#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006576 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006577#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006578 ssl->handshake->tls_prf,
6579 ssl->handshake->randbytes,
6580 ssl->tls_version,
6581 ssl->conf->endpoint,
6582 ssl);
6583 if (ret != 0) {
6584 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6585 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006586 }
6587
6588 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006589 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6590 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006591
Gilles Peskine449bd832023-01-11 14:50:10 +01006592 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006593
Gilles Peskine449bd832023-01-11 14:50:10 +01006594 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006595}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006596
Gilles Peskine449bd832023-01-11 14:50:10 +01006597int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006598{
Gilles Peskine449bd832023-01-11 14:50:10 +01006599 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006600#if defined(PSA_WANT_ALG_SHA_384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006601 case MBEDTLS_SSL_HASH_SHA384:
6602 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6603 break;
6604#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006605#if defined(PSA_WANT_ALG_SHA_256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006606 case MBEDTLS_SSL_HASH_SHA256:
6607 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6608 break;
6609#endif
6610 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006611 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006612 }
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006613#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006614 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006615 (void) ssl;
6616#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006617 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006618}
6619
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006620static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6621 const psa_hash_operation_t *hs_op,
6622 size_t buffer_size,
6623 unsigned char *hash,
6624 size_t *hlen)
6625{
6626 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006627 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006628
6629#if !defined(MBEDTLS_DEBUG_C)
6630 (void) ssl;
6631#endif
6632 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006633 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006634 if (status != PSA_SUCCESS) {
6635 goto exit;
6636 }
6637
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006638 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006639 if (status != PSA_SUCCESS) {
6640 goto exit;
6641 }
6642
6643 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6644 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6645
6646exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006647 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006648 return mbedtls_md_error_from_psa(status);
6649}
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006650
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006651#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006652int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6653 unsigned char *hash,
6654 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006655{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006656 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6657 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006658}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006659#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006660
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006661#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006662int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6663 unsigned char *hash,
6664 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006665{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006666 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6667 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006668}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006669#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006670
Jerry Yuc2c673d2022-02-17 14:20:39 +08006671#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006672MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006673static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006674
6675#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006676int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006677{
6678 /* If renegotiation is not enforced, retransmit until we would reach max
6679 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006680 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006681 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6682 unsigned char doublings = 1;
6683
Gilles Peskine449bd832023-01-11 14:50:10 +01006684 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006685 ++doublings;
6686 ratio >>= 1;
6687 }
6688
Gilles Peskine449bd832023-01-11 14:50:10 +01006689 if (++ssl->renego_records_seen > doublings) {
6690 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6691 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006692 }
6693 }
6694
Gilles Peskine449bd832023-01-11 14:50:10 +01006695 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006696}
6697#endif
6698#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006699
Jerry Yud9526692022-02-17 14:23:47 +08006700/*
6701 * Handshake functions
6702 */
6703#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6704/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006705int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006706{
6707 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6708 ssl->handshake->ciphersuite_info;
6709
Gilles Peskine449bd832023-01-11 14:50:10 +01006710 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006711
Gilles Peskine449bd832023-01-11 14:50:10 +01006712 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6713 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006714 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006715 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006716 }
6717
Gilles Peskine449bd832023-01-11 14:50:10 +01006718 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6719 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006720}
6721
Gilles Peskine449bd832023-01-11 14:50:10 +01006722int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006723{
6724 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6725 ssl->handshake->ciphersuite_info;
6726
Gilles Peskine449bd832023-01-11 14:50:10 +01006727 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006728
Gilles Peskine449bd832023-01-11 14:50:10 +01006729 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6730 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006731 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006732 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006733 }
6734
Gilles Peskine449bd832023-01-11 14:50:10 +01006735 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6736 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006737}
6738
6739#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6740/* Some certificate support -> implement write and parse */
6741
Gilles Peskine449bd832023-01-11 14:50:10 +01006742int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006743{
6744 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6745 size_t i, n;
6746 const mbedtls_x509_crt *crt;
6747 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6748 ssl->handshake->ciphersuite_info;
6749
Gilles Peskine449bd832023-01-11 14:50:10 +01006750 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006751
Gilles Peskine449bd832023-01-11 14:50:10 +01006752 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6753 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006754 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006755 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006756 }
6757
6758#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006759 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6760 if (ssl->handshake->client_auth == 0) {
6761 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006762 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006763 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006764 }
6765 }
6766#endif /* MBEDTLS_SSL_CLI_C */
6767#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006768 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6769 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006770 /* Should never happen because we shouldn't have picked the
6771 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006773 }
6774 }
6775#endif
6776
Gilles Peskine449bd832023-01-11 14:50:10 +01006777 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006778
6779 /*
6780 * 0 . 0 handshake type
6781 * 1 . 3 handshake length
6782 * 4 . 6 length of all certs
6783 * 7 . 9 length of cert. 1
6784 * 10 . n-1 peer certificate
6785 * n . n+2 length of cert. 2
6786 * n+3 . ... upper level cert, etc.
6787 */
6788 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006789 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006790
Gilles Peskine449bd832023-01-11 14:50:10 +01006791 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006792 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006793 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6794 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6795 " > %" MBEDTLS_PRINTF_SIZET,
6796 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6797 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006798 }
6799
Gilles Peskine449bd832023-01-11 14:50:10 +01006800 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6801 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6802 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006803
Gilles Peskine449bd832023-01-11 14:50:10 +01006804 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006805 i += n; crt = crt->next;
6806 }
6807
Gilles Peskine449bd832023-01-11 14:50:10 +01006808 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6809 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6810 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006811
6812 ssl->out_msglen = i;
6813 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6814 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6815
Gilles Peskinef670ba52025-03-07 15:09:32 +01006816 mbedtls_ssl_handshake_increment_state(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006817
Gilles Peskine449bd832023-01-11 14:50:10 +01006818 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
6819 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
6820 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006821 }
6822
Gilles Peskine449bd832023-01-11 14:50:10 +01006823 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006824
Gilles Peskine449bd832023-01-11 14:50:10 +01006825 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006826}
6827
6828#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6829
6830#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006831MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006832static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6833 unsigned char *crt_buf,
6834 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006835{
6836 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6837
Gilles Peskine449bd832023-01-11 14:50:10 +01006838 if (peer_crt == NULL) {
6839 return -1;
6840 }
Jerry Yud9526692022-02-17 14:23:47 +08006841
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 if (peer_crt->raw.len != crt_buf_len) {
6843 return -1;
6844 }
Jerry Yud9526692022-02-17 14:23:47 +08006845
Gilles Peskine449bd832023-01-11 14:50:10 +01006846 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08006847}
6848#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006849MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006850static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6851 unsigned char *crt_buf,
6852 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006853{
6854 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6855 unsigned char const * const peer_cert_digest =
6856 ssl->session->peer_cert_digest;
6857 mbedtls_md_type_t const peer_cert_digest_type =
6858 ssl->session->peer_cert_digest_type;
6859 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01006860 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08006861 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6862 size_t digest_len;
6863
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 if (peer_cert_digest == NULL || digest_info == NULL) {
6865 return -1;
6866 }
Jerry Yud9526692022-02-17 14:23:47 +08006867
Gilles Peskine449bd832023-01-11 14:50:10 +01006868 digest_len = mbedtls_md_get_size(digest_info);
6869 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
6870 return -1;
6871 }
Jerry Yud9526692022-02-17 14:23:47 +08006872
Gilles Peskine449bd832023-01-11 14:50:10 +01006873 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
6874 if (ret != 0) {
6875 return -1;
6876 }
Jerry Yud9526692022-02-17 14:23:47 +08006877
Gilles Peskine449bd832023-01-11 14:50:10 +01006878 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08006879}
6880#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6881#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6882
6883/*
6884 * Once the certificate message is read, parse it into a cert chain and
6885 * perform basic checks, but leave actual verification to the caller
6886 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006887MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006888static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
6889 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08006890{
6891 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6892#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006893 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08006894#endif
6895 size_t i, n;
6896 uint8_t alert;
6897
Gilles Peskine449bd832023-01-11 14:50:10 +01006898 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
6899 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6900 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6901 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6902 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006903 }
6904
Gilles Peskine449bd832023-01-11 14:50:10 +01006905 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
6906 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6907 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6908 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006909 }
6910
Gilles Peskine449bd832023-01-11 14:50:10 +01006911 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
6912 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6913 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6914 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6915 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006916 }
6917
Gilles Peskine449bd832023-01-11 14:50:10 +01006918 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006919
6920 /*
6921 * Same message structure as in mbedtls_ssl_write_certificate()
6922 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006923 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006924
Gilles Peskine449bd832023-01-11 14:50:10 +01006925 if (ssl->in_msg[i] != 0 ||
6926 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
6927 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6928 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6929 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6930 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006931 }
6932
6933 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6934 i += 3;
6935
6936 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006937 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08006938 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006939 if (i + 3 > ssl->in_hslen) {
6940 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6941 mbedtls_ssl_send_alert_message(ssl,
6942 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6943 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6944 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006945 }
6946 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6947 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006948 if (ssl->in_msg[i] != 0) {
6949 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6950 mbedtls_ssl_send_alert_message(ssl,
6951 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6952 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
6953 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08006954 }
6955
6956 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006957 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006958 i += 3;
6959
Gilles Peskine449bd832023-01-11 14:50:10 +01006960 if (n < 128 || i + n > ssl->in_hslen) {
6961 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6962 mbedtls_ssl_send_alert_message(ssl,
6963 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6964 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6965 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006966 }
6967
6968 /* Check if we're handling the first CRT in the chain. */
6969#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006970 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08006971 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01006972 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08006973 /* During client-side renegotiation, check that the server's
6974 * end-CRTs hasn't changed compared to the initial handshake,
6975 * mitigating the triple handshake attack. On success, reuse
6976 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006977 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
6978 if (ssl_check_peer_crt_unchanged(ssl,
6979 &ssl->in_msg[i],
6980 n) != 0) {
6981 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
6982 mbedtls_ssl_send_alert_message(ssl,
6983 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6984 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
6985 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08006986 }
6987
6988 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006989 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08006990 }
6991#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6992
6993 /* Parse the next certificate in the chain. */
6994#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006995 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08006996#else
6997 /* If we don't need to store the CRT chain permanently, parse
6998 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006999 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007000#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007002 case 0: /*ok*/
Gilles Peskine4c832212025-05-07 23:05:12 +02007003 case MBEDTLS_ERR_X509_UNKNOWN_OID:
Jerry Yud9526692022-02-17 14:23:47 +08007004 /* Ignore certificate with an unknown algorithm: maybe a
7005 prior certificate was already trusted. */
7006 break;
7007
7008 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7009 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7010 goto crt_parse_der_failed;
7011
7012 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7013 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7014 goto crt_parse_der_failed;
7015
7016 default:
7017 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007018crt_parse_der_failed:
7019 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7020 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7021 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007022 }
7023
7024 i += n;
7025 }
7026
Gilles Peskine449bd832023-01-11 14:50:10 +01007027 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7028 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007029}
7030
7031#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007032MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007033static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007034{
Gilles Peskine449bd832023-01-11 14:50:10 +01007035 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7036 return -1;
7037 }
Jerry Yud9526692022-02-17 14:23:47 +08007038
Gilles Peskine449bd832023-01-11 14:50:10 +01007039 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007040 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7041 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007042 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7043 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7044 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007045 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007046 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007047}
7048#endif /* MBEDTLS_SSL_SRV_C */
7049
7050/* Check if a certificate message is expected.
7051 * Return either
7052 * - SSL_CERTIFICATE_EXPECTED, or
7053 * - SSL_CERTIFICATE_SKIP
7054 * indicating whether a Certificate message is expected or not.
7055 */
7056#define SSL_CERTIFICATE_EXPECTED 0
7057#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007058MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007059static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7060 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007061{
7062 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7063 ssl->handshake->ciphersuite_info;
7064
Gilles Peskine449bd832023-01-11 14:50:10 +01007065 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7066 return SSL_CERTIFICATE_SKIP;
7067 }
Jerry Yud9526692022-02-17 14:23:47 +08007068
7069#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007070 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007071 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007072 ssl->session_negotiate->verify_result =
7073 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007074 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007075 }
7076 }
7077#else
7078 ((void) authmode);
7079#endif /* MBEDTLS_SSL_SRV_C */
7080
Gilles Peskine449bd832023-01-11 14:50:10 +01007081 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007082}
7083
Jerry Yud9526692022-02-17 14:23:47 +08007084#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007085MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007086static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7087 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007088{
7089 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7090 /* Remember digest of the peer's end-CRT. */
7091 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007092 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7093 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7094 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7095 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7096 mbedtls_ssl_send_alert_message(ssl,
7097 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7098 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007099
Gilles Peskine449bd832023-01-11 14:50:10 +01007100 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007101 }
7102
Gilles Peskine449bd832023-01-11 14:50:10 +01007103 ret = mbedtls_md(mbedtls_md_info_from_type(
7104 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7105 start, len,
7106 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007107
7108 ssl->session_negotiate->peer_cert_digest_type =
7109 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7110 ssl->session_negotiate->peer_cert_digest_len =
7111 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7112
Gilles Peskine449bd832023-01-11 14:50:10 +01007113 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007114}
7115
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007116MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007117static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7118 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007119{
7120 unsigned char *end = start + len;
7121 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7122
7123 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007124 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7125 ret = mbedtls_pk_parse_subpubkey(&start, end,
7126 &ssl->handshake->peer_pubkey);
7127 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007128 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007129 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007130 }
7131
Gilles Peskine449bd832023-01-11 14:50:10 +01007132 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007133}
7134#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7135
Gilles Peskine449bd832023-01-11 14:50:10 +01007136int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007137{
7138 int ret = 0;
7139 int crt_expected;
Manuel Pégourié-Gonnard58ab9ba2024-08-14 09:47:38 +02007140 /* Authmode: precedence order is SNI if used else configuration */
Jerry Yud9526692022-02-17 14:23:47 +08007141#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7142 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7143 ? ssl->handshake->sni_authmode
7144 : ssl->conf->authmode;
7145#else
7146 const int authmode = ssl->conf->authmode;
7147#endif
7148 void *rs_ctx = NULL;
7149 mbedtls_x509_crt *chain = NULL;
7150
Gilles Peskine449bd832023-01-11 14:50:10 +01007151 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007152
Gilles Peskine449bd832023-01-11 14:50:10 +01007153 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7154 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7155 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007156 goto exit;
7157 }
7158
7159#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007160 if (ssl->handshake->ecrs_enabled &&
7161 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007162 chain = ssl->handshake->ecrs_peer_cert;
7163 ssl->handshake->ecrs_peer_cert = NULL;
7164 goto crt_verify;
7165 }
7166#endif
7167
Gilles Peskine449bd832023-01-11 14:50:10 +01007168 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007169 /* mbedtls_ssl_read_record may have sent an alert already. We
7170 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007171 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007172 goto exit;
7173 }
7174
7175#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007176 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007177 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7178
Gilles Peskine449bd832023-01-11 14:50:10 +01007179 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007180 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007181 }
Jerry Yud9526692022-02-17 14:23:47 +08007182
7183 goto exit;
7184 }
7185#endif /* MBEDTLS_SSL_SRV_C */
7186
7187 /* Clear existing peer CRT structure in case we tried to
7188 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007189 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007190
Gilles Peskine449bd832023-01-11 14:50:10 +01007191 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7192 if (chain == NULL) {
7193 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7194 sizeof(mbedtls_x509_crt)));
7195 mbedtls_ssl_send_alert_message(ssl,
7196 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7197 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007198
7199 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7200 goto exit;
7201 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007202 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007203
Gilles Peskine449bd832023-01-11 14:50:10 +01007204 ret = ssl_parse_certificate_chain(ssl, chain);
7205 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007206 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007207 }
Jerry Yud9526692022-02-17 14:23:47 +08007208
7209#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007210 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007211 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007212 }
Jerry Yud9526692022-02-17 14:23:47 +08007213
7214crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007215 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007216 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007217 }
Jerry Yud9526692022-02-17 14:23:47 +08007218#endif
7219
Manuel Pégourié-Gonnard19dd9f52024-08-16 11:03:42 +02007220 ret = mbedtls_ssl_verify_certificate(ssl, authmode, chain,
7221 ssl->handshake->ciphersuite_info,
7222 rs_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +01007223 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007224 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007225 }
Jerry Yud9526692022-02-17 14:23:47 +08007226
7227#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7228 {
7229 unsigned char *crt_start, *pk_start;
7230 size_t crt_len, pk_len;
7231
7232 /* We parse the CRT chain without copying, so
7233 * these pointers point into the input buffer,
7234 * and are hence still valid after freeing the
7235 * CRT chain. */
7236
7237 crt_start = chain->raw.p;
7238 crt_len = chain->raw.len;
7239
7240 pk_start = chain->pk_raw.p;
7241 pk_len = chain->pk_raw.len;
7242
7243 /* Free the CRT structures before computing
7244 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007245 mbedtls_x509_crt_free(chain);
7246 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007247 chain = NULL;
7248
Gilles Peskine449bd832023-01-11 14:50:10 +01007249 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7250 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007251 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007252 }
Jerry Yud9526692022-02-17 14:23:47 +08007253
Gilles Peskine449bd832023-01-11 14:50:10 +01007254 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7255 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007256 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007257 }
Jerry Yud9526692022-02-17 14:23:47 +08007258 }
7259#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7260 /* Pass ownership to session structure. */
7261 ssl->session_negotiate->peer_cert = chain;
7262 chain = NULL;
7263#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7264
Gilles Peskine449bd832023-01-11 14:50:10 +01007265 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007266
7267exit:
7268
Gilles Peskine449bd832023-01-11 14:50:10 +01007269 if (ret == 0) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007270 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007271 }
Jerry Yud9526692022-02-17 14:23:47 +08007272
7273#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007274 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007275 ssl->handshake->ecrs_peer_cert = chain;
7276 chain = NULL;
7277 }
7278#endif
7279
Gilles Peskine449bd832023-01-11 14:50:10 +01007280 if (chain != NULL) {
7281 mbedtls_x509_crt_free(chain);
7282 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007283 }
7284
Gilles Peskine449bd832023-01-11 14:50:10 +01007285 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007286}
7287#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7288
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007289static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7290 unsigned char *padbuf, size_t hlen,
7291 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007292{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007293 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007294 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007295 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007296 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007297 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007298 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007299
7300 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007301 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007302 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007303 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007304
Gilles Peskine449bd832023-01-11 14:50:10 +01007305 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007306 ? "client finished"
7307 : "server finished";
7308
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007309 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007310
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007311 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007312 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007313 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007314 }
7315
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007316 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007317 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007318 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007319 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007320 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007321
7322 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7323
Jerry Yu615bd6f2022-02-17 14:25:15 +08007324 /*
7325 * TLSv1.2:
7326 * hash = PRF( master, finished_label,
7327 * Hash( handshake ) )[0.11]
7328 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007329 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007330 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007331
Gilles Peskine449bd832023-01-11 14:50:10 +01007332 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007333
Paul Elliottecb95be2023-08-11 16:41:04 +01007334 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007335
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007336 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007337
7338exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007339 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007340 return mbedtls_md_error_from_psa(status);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007341}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007342
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007343#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007344static int ssl_calc_finished_tls_sha256(
7345 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7346{
7347 unsigned char padbuf[32];
7348 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007349 &ssl->handshake->fin_sha256_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007350 padbuf, sizeof(padbuf),
7351 buf, from);
7352}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007353#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007354
Jerry Yub7ba49e2022-02-17 14:25:53 +08007355
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007356#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007357static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007358 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007359{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007360 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007361 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007362 &ssl->handshake->fin_sha384_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007363 padbuf, sizeof(padbuf),
7364 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007365}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007366#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007367
Gilles Peskine449bd832023-01-11 14:50:10 +01007368void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007369{
Gilles Peskine449bd832023-01-11 14:50:10 +01007370 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007371
7372 /*
7373 * Free our handshake params
7374 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007375 mbedtls_ssl_handshake_free(ssl);
7376 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007377 ssl->handshake = NULL;
7378
7379 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007380 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007381 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007382 if (ssl->transform) {
7383 mbedtls_ssl_transform_free(ssl->transform);
7384 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007385 }
7386 ssl->transform = ssl->transform_negotiate;
7387 ssl->transform_negotiate = NULL;
7388
Gilles Peskine449bd832023-01-11 14:50:10 +01007389 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007390}
7391
Gilles Peskine449bd832023-01-11 14:50:10 +01007392void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007393{
7394 int resume = ssl->handshake->resume;
7395
Gilles Peskine449bd832023-01-11 14:50:10 +01007396 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007397
7398#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007399 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007400 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7401 ssl->renego_records_seen = 0;
7402 }
7403#endif
7404
7405 /*
7406 * Free the previous session and switch in the current one
7407 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007408 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007409#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7410 /* RFC 7366 3.1: keep the EtM state */
7411 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007412 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007413#endif
7414
Gilles Peskine449bd832023-01-11 14:50:10 +01007415 mbedtls_ssl_session_free(ssl->session);
7416 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007417 }
7418 ssl->session = ssl->session_negotiate;
7419 ssl->session_negotiate = NULL;
7420
7421 /*
7422 * Add cache entry
7423 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007424 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007425 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007426 resume == 0) {
7427 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7428 ssl->session->id,
7429 ssl->session->id_len,
7430 ssl->session) != 0) {
7431 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7432 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007433 }
7434
7435#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7437 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007438 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007439 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007440
7441 /* Keep last flight around in case we need to resend it:
7442 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007443 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7444 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007445#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007446 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007447
Gilles Peskinef670ba52025-03-07 15:09:32 +01007448 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007449
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007451}
7452
Gilles Peskine449bd832023-01-11 14:50:10 +01007453int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007454{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007455 int ret;
7456 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007457
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007459
Gilles Peskine449bd832023-01-11 14:50:10 +01007460 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007461
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007462 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7463 if (ret != 0) {
7464 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
David Horstmann816b7122025-03-07 17:20:59 +00007465 return ret;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007466 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007467
7468 /*
7469 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7470 * may define some other value. Currently (early 2016), no defined
7471 * ciphersuite does this (and this is unlikely to change as activity has
7472 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7473 */
7474 hash_len = 12;
7475
7476#if defined(MBEDTLS_SSL_RENEGOTIATION)
7477 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007478 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007479#endif
7480
7481 ssl->out_msglen = 4 + hash_len;
7482 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7483 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7484
7485 /*
7486 * In case of session resuming, invert the client and server
7487 * ChangeCipherSpec messages order.
7488 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007490#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007491 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007492 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
Gilles Peskine449bd832023-01-11 14:50:10 +01007493 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007494#endif
7495#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007496 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007497 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC);
Gilles Peskine449bd832023-01-11 14:50:10 +01007498 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007499#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 } else {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007501 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007502 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007503
7504 /*
7505 * Switch to our negotiated transform and session parameters for outbound
7506 * data.
7507 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007509
7510#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007511 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007512 unsigned char i;
7513
7514 /* Remember current epoch settings for resending */
7515 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007516 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7517 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007518
7519 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007520 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007521
7522
7523 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007524 for (i = 2; i > 0; i--) {
7525 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007526 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007527 }
7528 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007529
7530 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 if (i == 0) {
7532 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7533 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007534 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007536#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007537 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007538
7539 ssl->transform_out = ssl->transform_negotiate;
7540 ssl->session_out = ssl->session_negotiate;
7541
7542#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7544 mbedtls_ssl_send_flight_completed(ssl);
7545 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007546#endif
7547
Gilles Peskine449bd832023-01-11 14:50:10 +01007548 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7549 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7550 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007551 }
7552
7553#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007554 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7555 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7556 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7557 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007558 }
7559#endif
7560
Gilles Peskine449bd832023-01-11 14:50:10 +01007561 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007562
Gilles Peskine449bd832023-01-11 14:50:10 +01007563 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007564}
7565
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007566#define SSL_MAX_HASH_LEN 12
7567
Gilles Peskine449bd832023-01-11 14:50:10 +01007568int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007569{
7570 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7571 unsigned int hash_len = 12;
7572 unsigned char buf[SSL_MAX_HASH_LEN];
7573
Gilles Peskine449bd832023-01-11 14:50:10 +01007574 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007575
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007576 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7577 if (ret != 0) {
7578 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
David Horstmann816b7122025-03-07 17:20:59 +00007579 return ret;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007580 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007581
Gilles Peskine449bd832023-01-11 14:50:10 +01007582 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7583 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007584 goto exit;
7585 }
7586
Gilles Peskine449bd832023-01-11 14:50:10 +01007587 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7588 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7589 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7590 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007591 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7592 goto exit;
7593 }
7594
Gilles Peskine449bd832023-01-11 14:50:10 +01007595 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
7596 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7597 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007598 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7599 goto exit;
7600 }
7601
Gilles Peskine449bd832023-01-11 14:50:10 +01007602 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
7603 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7604 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7605 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007606 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7607 goto exit;
7608 }
7609
Gilles Peskine449bd832023-01-11 14:50:10 +01007610 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
7611 buf, hash_len) != 0) {
7612 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7613 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7614 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007615 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7616 goto exit;
7617 }
7618
7619#if defined(MBEDTLS_SSL_RENEGOTIATION)
7620 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007622#endif
7623
Gilles Peskine449bd832023-01-11 14:50:10 +01007624 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007625#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007626 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007627 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC);
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007629#endif
7630#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007631 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007632 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
Gilles Peskine449bd832023-01-11 14:50:10 +01007633 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007634#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007635 } else {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007636 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007637 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007638
7639#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007640 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7641 mbedtls_ssl_recv_flight_completed(ssl);
7642 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007643#endif
7644
Gilles Peskine449bd832023-01-11 14:50:10 +01007645 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007646
7647exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007648 mbedtls_platform_zeroize(buf, hash_len);
7649 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007650}
7651
Jerry Yu392112c2022-02-17 14:34:10 +08007652#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7653/*
7654 * Helper to get TLS 1.2 PRF from ciphersuite
7655 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7656 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007657static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08007658{
Jerry Yu392112c2022-02-17 14:34:10 +08007659 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007660 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007661#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007662 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
7663 return tls_prf_sha384;
7664 } else
Jerry Yu392112c2022-02-17 14:34:10 +08007665#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007666#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007667 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007668 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
7669 return tls_prf_sha256;
7670 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04007671 }
7672#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007673#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007674 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007675 (void) ciphersuite_info;
7676#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007677
Gilles Peskine449bd832023-01-11 14:50:10 +01007678 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08007679}
7680#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007681
Gilles Peskine449bd832023-01-11 14:50:10 +01007682static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007683{
7684 ((void) tls_prf);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007685#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 if (tls_prf == tls_prf_sha384) {
7687 return MBEDTLS_SSL_TLS_PRF_SHA384;
7688 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007689#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007690#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01007691 if (tls_prf == tls_prf_sha256) {
7692 return MBEDTLS_SSL_TLS_PRF_SHA256;
7693 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007694#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007695 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08007696}
7697
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007698/*
7699 * Populate a transform structure with session keys and all the other
7700 * necessary information.
7701 *
7702 * Parameters:
7703 * - [in/out]: transform: structure to populate
7704 * [in] must be just initialised with mbedtls_ssl_transform_init()
7705 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7706 * - [in] ciphersuite
7707 * - [in] master
7708 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007709 * - [in] tls_prf: pointer to PRF to use for key derivation
7710 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007711 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007712 * - [in] endpoint: client or server
7713 * - [in] ssl: used for:
7714 * - ssl->conf->{f,p}_export_keys
7715 * [in] optionally used for:
7716 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7717 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007718MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007719static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
7720 int ciphersuite,
7721 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007722#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007723 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007724#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007725 ssl_tls_prf_t tls_prf,
7726 const unsigned char randbytes[64],
7727 mbedtls_ssl_protocol_version tls_version,
7728 unsigned endpoint,
7729 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007730{
7731 int ret = 0;
7732 unsigned char keyblk[256];
7733 unsigned char *key1;
7734 unsigned char *key2;
7735 unsigned char *mac_enc;
7736 unsigned char *mac_dec;
7737 size_t mac_key_len = 0;
7738 size_t iv_copy_len;
7739 size_t keylen;
7740 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007741 mbedtls_ssl_mode_t ssl_mode;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007742
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007743 psa_key_type_t key_type;
7744 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7745 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007746 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007747 size_t key_bits;
7748 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007749
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007750 /*
7751 * Some data just needs copying into the structure
7752 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007753#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007754 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007755#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007756 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007757
Max Fillinger2fe35f62024-10-25 00:52:24 +02007758#if defined(MBEDTLS_SSL_KEEP_RANDBYTES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007759 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007760#endif
7761
7762#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01007763 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007764 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7765 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007766 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007767 }
7768#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7769
7770 /*
7771 * Get various info structures
7772 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007773 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
7774 if (ciphersuite_info == NULL) {
7775 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
7776 ciphersuite));
7777 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007778 }
7779
Neil Armstrongab555e02022-04-04 11:07:59 +02007780 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007781#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007782 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007783#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007784 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007785
Gilles Peskine449bd832023-01-11 14:50:10 +01007786 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007787 transform->taglen =
7788 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01007789 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007790
Dave Rodgman2eab4622023-10-05 13:30:37 +01007791 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01007792 transform->taglen,
7793 &alg,
7794 &key_type,
7795 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007796 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007797 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007798 goto end;
7799 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007800
Dave Rodgman2eab4622023-10-05 13:30:37 +01007801 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007802 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02007803 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01007804 (unsigned) ciphersuite_info->mac));
7805 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01007806 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007807
7808#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7809 /* Copy own and peer's CID if the use of the CID
7810 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007811 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
7812 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007813
7814 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007815 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
7816 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
7817 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007818
7819 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007820 memcpy(transform->out_cid, ssl->handshake->peer_cid,
7821 ssl->handshake->peer_cid_len);
7822 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
7823 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007824 }
7825#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7826
7827 /*
7828 * Compute key block using the PRF
7829 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007830 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
7831 if (ret != 0) {
7832 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7833 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007834 }
7835
Gilles Peskine449bd832023-01-11 14:50:10 +01007836 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
7837 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
7838 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
7839 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
7840 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007841
7842 /*
7843 * Determine the appropriate key, IV and MAC length.
7844 */
7845
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007846 keylen = PSA_BITS_TO_BYTES(key_bits);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007847
Valerio Settie5707042023-10-11 11:54:42 +02007848#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01007849 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007850 size_t explicit_ivlen;
7851
7852 transform->maclen = 0;
7853 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007854
7855 /* All modes haves 96-bit IVs, but the length of the static parts vary
7856 * with mode and version:
7857 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7858 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7859 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7860 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7861 * sequence number).
7862 */
7863 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01007864
7865 int is_chachapoly = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007866 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
David Horstmann3b2276a2022-10-06 14:49:08 +01007867
Gilles Peskine449bd832023-01-11 14:50:10 +01007868 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007869 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01007870 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007871 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01007872 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007873
7874 /* Minimum length of encrypted record */
7875 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7876 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007877 } else
Valerio Settie5707042023-10-11 11:54:42 +02007878#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007879#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007880 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007881 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01007882 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007883 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007884
Neil Armstronge4512952022-03-08 09:08:22 +01007885 /* Get MAC length */
7886 mac_key_len = PSA_HASH_LENGTH(mac_alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007887 transform->maclen = mac_key_len;
7888
7889 /* IV length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007890 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007891
7892 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007893 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007894 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007895 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007896 /*
7897 * GenericBlockCipher:
7898 * 1. if EtM is in use: one block plus MAC
7899 * otherwise: * first multiple of blocklen greater than maclen
7900 * 2. IV
7901 */
7902#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007903 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007904 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007905 + block_size;
7906 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007907#endif
7908 {
7909 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007910 + block_size
7911 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007912 }
7913
Gilles Peskine449bd832023-01-11 14:50:10 +01007914 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007915 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007916 } else {
7917 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007918 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7919 goto end;
7920 }
7921 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007922 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007923#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7924 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007925 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7926 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007927 }
7928
Gilles Peskine449bd832023-01-11 14:50:10 +01007929 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7930 (unsigned) keylen,
7931 (unsigned) transform->minlen,
7932 (unsigned) transform->ivlen,
7933 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007934
7935 /*
7936 * Finally setup the cipher contexts, IVs and MAC secrets.
7937 */
7938#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007939 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007940 key1 = keyblk + mac_key_len * 2;
7941 key2 = keyblk + mac_key_len * 2 + keylen;
7942
7943 mac_enc = keyblk;
7944 mac_dec = keyblk + mac_key_len;
7945
Gilles Peskine449bd832023-01-11 14:50:10 +01007946 iv_copy_len = (transform->fixed_ivlen) ?
7947 transform->fixed_ivlen : transform->ivlen;
7948 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
7949 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
7950 iv_copy_len);
7951 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007952#endif /* MBEDTLS_SSL_CLI_C */
7953#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007954 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007955 key1 = keyblk + mac_key_len * 2 + keylen;
7956 key2 = keyblk + mac_key_len * 2;
7957
7958 mac_enc = keyblk + mac_key_len;
7959 mac_dec = keyblk;
7960
Gilles Peskine449bd832023-01-11 14:50:10 +01007961 iv_copy_len = (transform->fixed_ivlen) ?
7962 transform->fixed_ivlen : transform->ivlen;
7963 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
7964 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
7965 iv_copy_len);
7966 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007967#endif /* MBEDTLS_SSL_SRV_C */
7968 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007969 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007970 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7971 goto end;
7972 }
7973
Paul Elliott4fb19552023-10-18 12:15:30 +01007974 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007975 ssl->f_export_keys(ssl->p_export_keys,
7976 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7977 master, 48,
7978 randbytes + 32,
7979 randbytes,
7980 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007981 }
7982
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007983 transform->psa_alg = alg;
7984
Gilles Peskine449bd832023-01-11 14:50:10 +01007985 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
7986 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
7987 psa_set_key_algorithm(&attributes, alg);
7988 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007989
Gilles Peskine449bd832023-01-11 14:50:10 +01007990 if ((status = psa_import_key(&attributes,
7991 key1,
7992 PSA_BITS_TO_BYTES(key_bits),
7993 &transform->psa_key_enc)) != PSA_SUCCESS) {
7994 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007995 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007996 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007997 goto end;
7998 }
7999
Gilles Peskine449bd832023-01-11 14:50:10 +01008000 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008001
Gilles Peskine449bd832023-01-11 14:50:10 +01008002 if ((status = psa_import_key(&attributes,
8003 key2,
8004 PSA_BITS_TO_BYTES(key_bits),
8005 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008006 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008007 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008008 goto end;
8009 }
8010 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008011
Neil Armstrong29c0c042022-03-17 17:47:28 +01008012#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8013 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8014 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008015 if (mac_key_len != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008016 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008017
Gilles Peskine449bd832023-01-11 14:50:10 +01008018 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8019 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8020 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008021
Gilles Peskine449bd832023-01-11 14:50:10 +01008022 if ((status = psa_import_key(&attributes,
8023 mac_enc, mac_key_len,
8024 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008025 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008026 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008027 goto end;
8028 }
8029
Gilles Peskine449bd832023-01-11 14:50:10 +01008030 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8031 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008032#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008033 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008034#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008035 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008036 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008037 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8038 PSA_KEY_USAGE_VERIFY_HASH);
8039 } else {
8040 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8041 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008042
Gilles Peskine449bd832023-01-11 14:50:10 +01008043 if ((status = psa_import_key(&attributes,
8044 mac_dec, mac_key_len,
8045 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008046 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008047 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008048 goto end;
8049 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008050 }
8051#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8052
8053 ((void) mac_dec);
8054 ((void) mac_enc);
8055
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008056end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008057 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8058 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008059}
8060
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008061#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008062int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008063 psa_pake_operation_t *pake_ctx,
8064 const unsigned char *buf,
8065 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008066{
8067 psa_status_t status;
8068 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008069 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008070 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8071 * At round two perform a single cycle
8072 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008073 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008074
Gilles Peskine449bd832023-01-11 14:50:10 +01008075 for (; remaining_steps > 0; remaining_steps--) {
8076 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008077 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008078 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008079 /* Length is stored at the first byte */
8080 size_t length = buf[input_offset];
8081 input_offset += 1;
8082
Gilles Peskine449bd832023-01-11 14:50:10 +01008083 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008084 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8085 }
8086
Gilles Peskine449bd832023-01-11 14:50:10 +01008087 status = psa_pake_input(pake_ctx, step,
8088 buf + input_offset, length);
8089 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008090 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008091 }
8092
8093 input_offset += length;
8094 }
8095 }
8096
Gilles Peskine449bd832023-01-11 14:50:10 +01008097 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008098 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008099 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008100
Gilles Peskine449bd832023-01-11 14:50:10 +01008101 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008102}
8103
Valerio Setti6b3dab02022-11-17 17:14:54 +01008104int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008105 psa_pake_operation_t *pake_ctx,
8106 unsigned char *buf,
8107 size_t len, size_t *olen,
8108 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008109{
8110 psa_status_t status;
8111 size_t output_offset = 0;
8112 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008113 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008114 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8115 * At round two perform a single cycle
8116 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008117 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008118
Gilles Peskine449bd832023-01-11 14:50:10 +01008119 for (; remaining_steps > 0; remaining_steps--) {
8120 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8121 step <= PSA_PAKE_STEP_ZK_PROOF;
8122 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008123 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008124 * For each step, prepend 1 byte with the length of the data as
8125 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008126 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008127 status = psa_pake_output(pake_ctx, step,
8128 buf + output_offset + 1,
8129 len - output_offset - 1,
8130 &output_len);
8131 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008132 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008133 }
8134
Valerio Setti99d88c12022-11-22 16:03:43 +01008135 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008136
8137 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008138 }
8139 }
8140
8141 *olen = output_offset;
8142
Gilles Peskine449bd832023-01-11 14:50:10 +01008143 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008144}
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008145#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Valerio Settia08b1a42022-11-17 15:10:02 +01008146
Gilles Peskine449bd832023-01-11 14:50:10 +01008147int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8148 unsigned char *hash, size_t *hashlen,
8149 unsigned char *data, size_t data_len,
8150 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008151{
8152 psa_status_t status;
8153 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008154 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008155
Gilles Peskine449bd832023-01-11 14:50:10 +01008156 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008157
Gilles Peskine449bd832023-01-11 14:50:10 +01008158 if ((status = psa_hash_setup(&hash_operation,
8159 hash_alg)) != PSA_SUCCESS) {
8160 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008161 goto exit;
8162 }
8163
Gilles Peskine449bd832023-01-11 14:50:10 +01008164 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8165 64)) != PSA_SUCCESS) {
8166 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008167 goto exit;
8168 }
8169
Gilles Peskine449bd832023-01-11 14:50:10 +01008170 if ((status = psa_hash_update(&hash_operation,
8171 data, data_len)) != PSA_SUCCESS) {
8172 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008173 goto exit;
8174 }
8175
Gilles Peskine449bd832023-01-11 14:50:10 +01008176 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8177 hashlen)) != PSA_SUCCESS) {
8178 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8179 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008180 }
8181
8182exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008183 if (status != PSA_SUCCESS) {
8184 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8185 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8186 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008187 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008188 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008189 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8190 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008191 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008192 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008193 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008194 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008195 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008196 }
8197 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008198 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008199}
8200
Jerry Yuee40f9d2022-02-17 14:55:16 +08008201
Jerry Yud9d91da2022-02-17 14:57:06 +08008202#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8203
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008204/* Find the preferred hash for a given signature algorithm. */
8205unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008206 mbedtls_ssl_context *ssl,
8207 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008208{
Gabor Mezei078e8032022-04-27 21:17:56 +02008209 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008210 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008211
Gilles Peskine449bd832023-01-11 14:50:10 +01008212 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8213 return MBEDTLS_SSL_HASH_NONE;
8214 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008215
Gilles Peskine449bd832023-01-11 14:50:10 +01008216 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008217 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008218 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8219 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008220 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008221 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8222 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008223
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008224 mbedtls_md_type_t md_alg =
8225 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8226 if (md_alg == MBEDTLS_MD_NONE) {
8227 continue;
8228 }
8229
Gilles Peskine449bd832023-01-11 14:50:10 +01008230 if (sig_alg == sig_alg_received) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008231 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008232 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008233 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008234
Gilles Peskine449bd832023-01-11 14:50:10 +01008235 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8236 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8237 PSA_ALG_ECDSA(psa_hash_alg),
8238 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008239 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008240 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008241
Gilles Peskine449bd832023-01-11 14:50:10 +01008242 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8243 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8244 PSA_ALG_RSA_PKCS1V15_SIGN(
8245 psa_hash_alg),
8246 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008247 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008248 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008249 }
Neil Armstrong96eceb82022-06-30 18:05:05 +02008250
Gilles Peskine449bd832023-01-11 14:50:10 +01008251 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008252 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008253 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008254
Gilles Peskine449bd832023-01-11 14:50:10 +01008255 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008256}
8257
8258#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8259
Jerry Yudc7bd172022-02-17 13:44:15 +08008260#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8261
XiaokangQian75d40ef2022-04-20 11:05:24 +00008262int mbedtls_ssl_validate_ciphersuite(
8263 const mbedtls_ssl_context *ssl,
8264 const mbedtls_ssl_ciphersuite_t *suite_info,
8265 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01008266 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008267{
8268 (void) ssl;
8269
Gilles Peskine449bd832023-01-11 14:50:10 +01008270 if (suite_info == NULL) {
8271 return -1;
8272 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00008273
Gilles Peskine449bd832023-01-11 14:50:10 +01008274 if ((suite_info->min_tls_version > max_tls_version) ||
8275 (suite_info->max_tls_version < min_tls_version)) {
8276 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008277 }
8278
XiaokangQian060d8672022-04-21 09:24:56 +00008279#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008280#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008281 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
Manuel Pégourié-Gonnard88800dd2025-01-23 11:01:35 +01008282 ssl->handshake->psa_pake_ctx_is_ok != 1) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008283 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008284 }
8285#endif
8286
8287 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8288#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008289 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
8290 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
8291 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008292 }
8293#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8294#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8295
Gilles Peskine449bd832023-01-11 14:50:10 +01008296 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008297}
8298
Ronald Crone68ab4f2022-10-05 12:46:29 +02008299#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00008300/*
8301 * Function for writing a signature algorithm extension.
8302 *
8303 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8304 * value (TLS 1.3 RFC8446):
8305 * enum {
8306 * ....
8307 * ecdsa_secp256r1_sha256( 0x0403 ),
8308 * ecdsa_secp384r1_sha384( 0x0503 ),
8309 * ecdsa_secp521r1_sha512( 0x0603 ),
8310 * ....
8311 * } SignatureScheme;
8312 *
8313 * struct {
8314 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8315 * } SignatureSchemeList;
8316 *
8317 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8318 * value (TLS 1.2 RFC5246):
8319 * enum {
8320 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8321 * sha512(6), (255)
8322 * } HashAlgorithm;
8323 *
8324 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8325 * SignatureAlgorithm;
8326 *
8327 * struct {
8328 * HashAlgorithm hash;
8329 * SignatureAlgorithm signature;
8330 * } SignatureAndHashAlgorithm;
8331 *
8332 * SignatureAndHashAlgorithm
8333 * supported_signature_algorithms<2..2^16-2>;
8334 *
8335 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8336 * generalization of the TLS 1.2 signature algorithm extension.
8337 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8338 * `SignatureScheme` field of TLS 1.3
8339 *
8340 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008341int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
8342 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00008343{
8344 unsigned char *p = buf;
8345 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8346 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8347
8348 *out_len = 0;
8349
Gilles Peskine449bd832023-01-11 14:50:10 +01008350 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00008351
8352 /* Check if we have space for header and length field:
8353 * - extension_type (2 bytes)
8354 * - extension_data_length (2 bytes)
8355 * - supported_signature_algorithms_length (2 bytes)
8356 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008357 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00008358 p += 6;
8359
8360 /*
8361 * Write supported_signature_algorithms
8362 */
8363 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01008364 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
8365 if (sig_alg == NULL) {
8366 return MBEDTLS_ERR_SSL_BAD_CONFIG;
8367 }
XiaokangQianeaf36512022-04-24 09:07:44 +00008368
Gilles Peskine449bd832023-01-11 14:50:10 +01008369 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
8370 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
8371 *sig_alg,
8372 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
8373 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00008374 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008375 }
8376 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
8377 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00008378 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008379 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
8380 *sig_alg,
8381 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00008382 }
8383
8384 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008385 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01008386 if (supported_sig_alg_len == 0) {
8387 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
8388 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00008389 }
8390
Gilles Peskine449bd832023-01-11 14:50:10 +01008391 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
8392 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
8393 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00008394
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008395 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00008396
8397#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008398 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00008399#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08008400
Gilles Peskine449bd832023-01-11 14:50:10 +01008401 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00008402}
Ronald Crone68ab4f2022-10-05 12:46:29 +02008403#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00008404
XiaokangQian40a35232022-05-07 09:02:40 +00008405#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008406/*
8407 * mbedtls_ssl_parse_server_name_ext
8408 *
8409 * Structure of server_name extension:
8410 *
8411 * enum {
8412 * host_name(0), (255)
8413 * } NameType;
8414 * opaque HostName<1..2^16-1>;
8415 *
8416 * struct {
8417 * NameType name_type;
8418 * select (name_type) {
8419 * case host_name: HostName;
8420 * } name;
8421 * } ServerName;
8422 * struct {
8423 * ServerName server_name_list<1..2^16-1>
8424 * } ServerNameList;
8425 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008426MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008427int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
8428 const unsigned char *buf,
8429 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00008430{
8431 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8432 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008433 size_t server_name_list_len, hostname_len;
8434 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008435
Gilles Peskine449bd832023-01-11 14:50:10 +01008436 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00008437
Gilles Peskine449bd832023-01-11 14:50:10 +01008438 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
8439 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00008440 p += 2;
8441
Gilles Peskine449bd832023-01-11 14:50:10 +01008442 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00008443 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008444 while (p < server_name_list_end) {
8445 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
8446 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
8447 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
8448 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00008449
Gilles Peskine449bd832023-01-11 14:50:10 +01008450 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008451 /* sni_name is intended to be used only during the parsing of the
8452 * ClientHello message (it is reset to NULL before the end of
8453 * the message parsing). Thus it is ok to just point to the
8454 * reception buffer and not make a copy of it.
8455 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008456 ssl->handshake->sni_name = p + 3;
8457 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008458 if (ssl->conf->f_sni == NULL) {
8459 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008460 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008461 ret = ssl->conf->f_sni(ssl->conf->p_sni,
8462 ssl, p + 3, hostname_len);
8463 if (ret != 0) {
8464 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
8465 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8466 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
8467 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
8468 }
8469 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008470 }
8471
8472 p += hostname_len + 3;
8473 }
8474
Gilles Peskine449bd832023-01-11 14:50:10 +01008475 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008476}
8477#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8478
XiaokangQianacb39922022-06-17 10:18:48 +00008479#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008480MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008481int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
8482 const unsigned char *buf,
8483 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00008484{
8485 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008486 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008487 const unsigned char *protocol_name_list;
8488 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008489 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008490
8491 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01008492 if (ssl->conf->alpn_list == NULL) {
8493 return 0;
8494 }
XiaokangQianacb39922022-06-17 10:18:48 +00008495
8496 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008497 * RFC7301, section 3.1
8498 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008499 *
XiaokangQianc7403452022-06-23 03:24:12 +00008500 * struct {
8501 * ProtocolName protocol_name_list<2..2^16-1>
8502 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008503 */
8504
XiaokangQianc7403452022-06-23 03:24:12 +00008505 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008506 * protocol_name_list_len 2 bytes
8507 * protocol_name_len 1 bytes
8508 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008509 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008510 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00008511
Gilles Peskine449bd832023-01-11 14:50:10 +01008512 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008513 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008514 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00008515 protocol_name_list = p;
8516 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008517
8518 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01008519 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008520 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008521 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
8522 protocol_name_len);
8523 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008524 MBEDTLS_SSL_PEND_FATAL_ALERT(
8525 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01008526 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
8527 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00008528 }
8529
8530 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008531 }
8532
8533 /* Use our order of preference */
Gilles Peskinec4949d12025-05-27 19:45:29 +02008534 for (const char *const *alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008535 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00008536 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01008537 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008538 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008539 if (protocol_name_len == alpn_len &&
8540 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00008541 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01008542 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008543 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008544
8545 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008546 }
8547 }
8548
XiaokangQian95d5f542022-06-24 02:29:26 +00008549 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008550 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01008551 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8552 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
8553 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00008554}
8555
Gilles Peskine449bd832023-01-11 14:50:10 +01008556int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
8557 unsigned char *buf,
8558 unsigned char *end,
8559 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00008560{
8561 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008562 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008563 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008564
Gilles Peskine449bd832023-01-11 14:50:10 +01008565 if (ssl->alpn_chosen == NULL) {
8566 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008567 }
8568
Gilles Peskine449bd832023-01-11 14:50:10 +01008569 protocol_name_len = strlen(ssl->alpn_chosen);
8570 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008571
Gilles Peskine449bd832023-01-11 14:50:10 +01008572 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00008573 /*
8574 * 0 . 1 ext identifier
8575 * 2 . 3 ext length
8576 * 4 . 5 protocol list length
8577 * 6 . 6 protocol name length
8578 * 7 . 7+n protocol name
8579 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008580 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008581
XiaokangQian95d5f542022-06-24 02:29:26 +00008582 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008583
Gilles Peskine449bd832023-01-11 14:50:10 +01008584 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
8585 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00008586 /* Note: the length of the chosen protocol has been checked to be less
8587 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8588 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008589 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008590
Gilles Peskine449bd832023-01-11 14:50:10 +01008591 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08008592
8593#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008594 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08008595#endif
8596
Gilles Peskine449bd832023-01-11 14:50:10 +01008597 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008598}
8599#endif /* MBEDTLS_SSL_ALPN */
8600
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008601#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00008602 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008603 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008604 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008605int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
8606 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008607{
8608 /* Initialize to suppress unnecessary compiler warning */
8609 size_t hostname_len = 0;
8610
8611 /* Check if new hostname is valid before
8612 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008613 if (hostname != NULL) {
8614 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008615
Gilles Peskine449bd832023-01-11 14:50:10 +01008616 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
8617 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8618 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008619 }
8620
8621 /* Now it's clear that we will overwrite the old hostname,
8622 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01008623 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008624 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01008625 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008626 }
8627
8628 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008629 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008630 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01008631 } else {
8632 session->hostname = mbedtls_calloc(1, hostname_len + 1);
8633 if (session->hostname == NULL) {
8634 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8635 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008636
Gilles Peskine449bd832023-01-11 14:50:10 +01008637 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008638 }
8639
Gilles Peskine449bd832023-01-11 14:50:10 +01008640 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008641}
Xiaokang Qian03409292022-10-12 02:49:52 +00008642#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
8643 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008644 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008645 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008646
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008647#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
8648 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008649int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
8650 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008651{
8652 size_t alpn_len = 0;
8653
8654 if (alpn != NULL) {
8655 alpn_len = strlen(alpn);
8656
8657 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
8658 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8659 }
8660 }
8661
8662 if (session->ticket_alpn != NULL) {
8663 mbedtls_zeroize_and_free(session->ticket_alpn,
8664 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008665 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008666 }
8667
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008668 if (alpn != NULL) {
8669 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008670 if (session->ticket_alpn == NULL) {
8671 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8672 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008673 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008674 }
8675
8676 return 0;
8677}
8678#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008679
8680/*
8681 * The following functions are used by 1.2 and 1.3, client and server.
8682 */
8683#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
8684int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
8685 const mbedtls_ssl_ciphersuite_t *ciphersuite,
8686 int recv_endpoint,
8687 mbedtls_ssl_protocol_version tls_version,
8688 uint32_t *flags)
8689{
8690 int ret = 0;
8691 unsigned int usage = 0;
8692 const char *ext_oid;
8693 size_t ext_len;
8694
8695 /*
8696 * keyUsage
8697 */
8698
8699 /* Note: don't guard this with MBEDTLS_SSL_CLI_C because the server wants
8700 * to check what a compliant client will think while choosing which cert
8701 * to send to the client. */
8702#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
8703 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8704 recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8705 /* TLS 1.2 server part of the key exchange */
8706 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008707 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
8708 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
8709 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8710 break;
8711
8712 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
8713 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
8714 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
8715 break;
8716
8717 /* Don't use default: we want warnings when adding new values */
8718 case MBEDTLS_KEY_EXCHANGE_NONE:
8719 case MBEDTLS_KEY_EXCHANGE_PSK:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008720 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
8721 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
8722 usage = 0;
8723 }
8724 } else
8725#endif
8726 {
8727 /* This is either TLS 1.3 authentication, which always uses signatures,
8728 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
8729 * options we implement, both using signatures. */
8730 (void) tls_version;
8731 (void) ciphersuite;
8732 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8733 }
8734
8735 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
8736 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
8737 ret = -1;
8738 }
8739
8740 /*
8741 * extKeyUsage
8742 */
8743
8744 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8745 ext_oid = MBEDTLS_OID_SERVER_AUTH;
8746 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
8747 } else {
8748 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
8749 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
8750 }
8751
8752 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
8753 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
8754 ret = -1;
8755 }
8756
8757 return ret;
8758}
8759
Gilles Peskine4ac40082025-02-20 18:13:58 +01008760static int get_hostname_for_verification(mbedtls_ssl_context *ssl,
8761 const char **hostname)
8762{
8763 if (!mbedtls_ssl_has_set_hostname_been_called(ssl)) {
8764 MBEDTLS_SSL_DEBUG_MSG(1, ("Certificate verification without having set hostname"));
Gilles Peskine488b9192025-02-13 14:39:02 +01008765 if (mbedtls_ssl_conf_get_endpoint(ssl->conf) == MBEDTLS_SSL_IS_CLIENT &&
8766 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8767 return MBEDTLS_ERR_SSL_CERTIFICATE_VERIFICATION_WITHOUT_HOSTNAME;
8768 }
Gilles Peskine4ac40082025-02-20 18:13:58 +01008769 }
8770
8771 *hostname = ssl->hostname;
8772 if (*hostname == NULL) {
8773 MBEDTLS_SSL_DEBUG_MSG(2, ("Certificate verification without CN verification"));
8774 }
8775
8776 return 0;
8777}
8778
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008779int mbedtls_ssl_verify_certificate(mbedtls_ssl_context *ssl,
8780 int authmode,
8781 mbedtls_x509_crt *chain,
8782 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
8783 void *rs_ctx)
8784{
8785 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
8786 return 0;
8787 }
8788
8789 /*
8790 * Primary check: use the appropriate X.509 verification function
8791 */
8792 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
8793 void *p_vrfy;
8794 if (ssl->f_vrfy != NULL) {
8795 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
8796 f_vrfy = ssl->f_vrfy;
8797 p_vrfy = ssl->p_vrfy;
8798 } else {
8799 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
8800 f_vrfy = ssl->conf->f_vrfy;
8801 p_vrfy = ssl->conf->p_vrfy;
8802 }
8803
Gilles Peskine4ac40082025-02-20 18:13:58 +01008804 const char *hostname = "";
8805 int ret = get_hostname_for_verification(ssl, &hostname);
8806 if (ret != 0) {
8807 MBEDTLS_SSL_DEBUG_RET(1, "get_hostname_for_verification", ret);
8808 return ret;
8809 }
8810
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008811 int have_ca_chain_or_callback = 0;
8812#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
8813 if (ssl->conf->f_ca_cb != NULL) {
8814 ((void) rs_ctx);
8815 have_ca_chain_or_callback = 1;
8816
8817 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
8818 ret = mbedtls_x509_crt_verify_with_ca_cb(
8819 chain,
8820 ssl->conf->f_ca_cb,
8821 ssl->conf->p_ca_cb,
8822 ssl->conf->cert_profile,
Gilles Peskine4ac40082025-02-20 18:13:58 +01008823 hostname,
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008824 &ssl->session_negotiate->verify_result,
8825 f_vrfy, p_vrfy);
8826 } else
8827#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
8828 {
8829 mbedtls_x509_crt *ca_chain;
8830 mbedtls_x509_crl *ca_crl;
8831#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8832 if (ssl->handshake->sni_ca_chain != NULL) {
8833 ca_chain = ssl->handshake->sni_ca_chain;
8834 ca_crl = ssl->handshake->sni_ca_crl;
8835 } else
8836#endif
8837 {
8838 ca_chain = ssl->conf->ca_chain;
8839 ca_crl = ssl->conf->ca_crl;
8840 }
8841
8842 if (ca_chain != NULL) {
8843 have_ca_chain_or_callback = 1;
8844 }
8845
8846 ret = mbedtls_x509_crt_verify_restartable(
8847 chain,
8848 ca_chain, ca_crl,
8849 ssl->conf->cert_profile,
Gilles Peskine4ac40082025-02-20 18:13:58 +01008850 hostname,
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008851 &ssl->session_negotiate->verify_result,
8852 f_vrfy, p_vrfy, rs_ctx);
8853 }
8854
8855 if (ret != 0) {
8856 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
8857 }
8858
8859#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
8860 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8861 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8862 }
8863#endif
8864
8865 /*
8866 * Secondary checks: always done, but change 'ret' only if it was 0
8867 */
8868
8869 /* With TLS 1.2 and ECC certs, check that the curve used by the
8870 * certificate is on our list of acceptable curves.
8871 *
8872 * With TLS 1.3 this is not needed because the curve is part of the
8873 * signature algorithm (eg ecdsa_secp256r1_sha256) which is checked when
8874 * we validate the signature made with the key associated to this cert.
8875 */
8876#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
8877 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
8878 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8879 mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY)) {
8880 if (mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
8881 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8882 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
8883 if (ret == 0) {
8884 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8885 }
8886 }
8887 }
8888#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
8889
8890 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
8891 if (mbedtls_ssl_check_cert_usage(chain,
8892 ciphersuite_info,
8893 ssl->conf->endpoint,
8894 ssl->tls_version,
8895 &ssl->session_negotiate->verify_result) != 0) {
8896 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8897 if (ret == 0) {
8898 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8899 }
8900 }
8901
8902 /* With authmode optional, we want to keep going if the certificate was
8903 * unacceptable, but still fail on other errors (out of memory etc),
8904 * including fatal errors from the f_vrfy callback.
8905 *
8906 * The only acceptable errors are:
8907 * - MBEDTLS_ERR_X509_CERT_VERIFY_FAILED: cert rejected by primary check;
8908 * - MBEDTLS_ERR_SSL_BAD_CERTIFICATE: cert rejected by secondary checks.
8909 * Anything else is a fatal error. */
8910 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8911 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8912 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
8913 ret = 0;
8914 }
8915
8916 /* Return a specific error as this is a user error: inconsistent
8917 * configuration - can't verify without trust anchors. */
8918 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8919 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
8920 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8921 }
8922
8923 if (ret != 0) {
8924 uint8_t alert;
8925
8926 /* The certificate may have been rejected for several reasons.
8927 Pick one and send the corresponding alert. Which alert to send
8928 may be a subject of debate in some cases. */
8929 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
8930 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
8931 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
8932 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
8933 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
8934 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8935 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
8936 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8937 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
8938 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8939 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
8940 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8941 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
8942 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
8943 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
8944 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
8945 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
8946 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
8947 } else {
8948 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
8949 }
8950 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8951 alert);
8952 }
8953
8954#if defined(MBEDTLS_DEBUG_C)
8955 if (ssl->session_negotiate->verify_result != 0) {
8956 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8957 (unsigned int) ssl->session_negotiate->verify_result));
8958 } else {
8959 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
8960 }
8961#endif /* MBEDTLS_DEBUG_C */
8962
8963 return ret;
8964}
8965#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
8966
Max Fillinger2fe35f62024-10-25 00:52:24 +02008967#if defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT)
Max Fillinger281fb792024-10-23 18:35:09 +02008968
Max Fillinger29beade2024-09-21 11:06:28 +02008969#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008970static int mbedtls_ssl_tls12_export_keying_material(const mbedtls_ssl_context *ssl,
8971 const mbedtls_md_type_t hash_alg,
Max Fillinger7b722202024-09-21 10:48:57 +02008972 uint8_t *out,
8973 const size_t key_len,
8974 const char *label,
8975 const size_t label_len,
8976 const unsigned char *context,
8977 const size_t context_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008978 const int use_context)
8979{
8980 int ret = 0;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008981 unsigned char *prf_input = NULL;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008982
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008983 /* The input to the PRF is client_random, then server_random.
8984 * If a context is provided, this is then followed by the context length
8985 * as a 16-bit big-endian integer, and then the context itself. */
Max Fillinger155cea02024-10-23 16:32:54 +02008986 const size_t randbytes_len = MBEDTLS_CLIENT_HELLO_RANDOM_LEN + MBEDTLS_SERVER_HELLO_RANDOM_LEN;
8987 size_t prf_input_len = randbytes_len;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008988 if (use_context) {
Max Fillinger155cea02024-10-23 16:32:54 +02008989 if (context_len > UINT16_MAX) {
8990 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8991 }
8992
8993 /* This does not overflow a 32-bit size_t because the current value of
8994 * prf_input_len is 64 (length of client_random + server_random) and
8995 * context_len fits into two bytes (checked above). */
8996 prf_input_len += sizeof(uint16_t) + context_len;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008997 }
Max Fillinger155cea02024-10-23 16:32:54 +02008998
8999 prf_input = mbedtls_calloc(prf_input_len, sizeof(unsigned char));
9000 if (prf_input == NULL) {
9001 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9002 }
9003
9004 memcpy(prf_input,
9005 ssl->transform->randbytes + MBEDTLS_SERVER_HELLO_RANDOM_LEN,
9006 MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
9007 memcpy(prf_input + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
9008 ssl->transform->randbytes,
9009 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
9010 if (use_context) {
9011 MBEDTLS_PUT_UINT16_BE(context_len, prf_input, randbytes_len);
9012 memcpy(prf_input + randbytes_len + sizeof(uint16_t), context, context_len);
9013 }
9014 ret = tls_prf_generic(hash_alg, ssl->session->master, sizeof(ssl->session->master),
Max Fillingerf2dda152024-10-23 15:47:23 +02009015 label, label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009016 prf_input, prf_input_len,
9017 out, key_len);
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009018 mbedtls_free(prf_input);
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009019 return ret;
9020}
Max Fillinger281fb792024-10-23 18:35:09 +02009021#endif /* defined(MBEDTLS_SSL_PROTO_TLS1_2) */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009022
Max Fillinger29beade2024-09-21 11:06:28 +02009023#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009024static int mbedtls_ssl_tls13_export_keying_material(mbedtls_ssl_context *ssl,
9025 const mbedtls_md_type_t hash_alg,
Max Fillinger7b722202024-09-21 10:48:57 +02009026 uint8_t *out,
9027 const size_t key_len,
9028 const char *label,
9029 const size_t label_len,
9030 const unsigned char *context,
9031 const size_t context_len)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009032{
9033 const psa_algorithm_t psa_hash_alg = mbedtls_md_psa_alg_from_type(hash_alg);
9034 const size_t hash_len = PSA_HASH_LENGTH(hash_alg);
9035 const unsigned char *secret = ssl->session->app_secrets.exporter_master_secret;
9036
Max Fillinger9c5bae52024-11-21 12:33:46 +01009037 /* The length of the label must be at most 249 bytes to fit into the HkdfLabel
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009038 * struct as defined in RFC 8446, Section 7.1.
Max Fillinger3e129182024-10-29 19:18:54 +01009039 *
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009040 * The length of the context is unlimited even though the context field in the
Max Fillinger9c5bae52024-11-21 12:33:46 +01009041 * struct can only hold up to 255 bytes. This is because we place a *hash* of
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009042 * the context in the field. */
Max Fillinger9c5bae52024-11-21 12:33:46 +01009043 if (label_len > 249) {
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009044 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9045 }
9046
9047 return mbedtls_ssl_tls13_exporter(psa_hash_alg, secret, hash_len,
Max Fillinger7b722202024-09-21 10:48:57 +02009048 (const unsigned char *) label, label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009049 context, context_len, out, key_len);
9050}
Max Fillinger281fb792024-10-23 18:35:09 +02009051#endif /* defined(MBEDTLS_SSL_PROTO_TLS1_3) */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009052
9053int mbedtls_ssl_export_keying_material(mbedtls_ssl_context *ssl,
Max Fillinger9c9989f2024-08-14 16:44:50 +02009054 uint8_t *out, const size_t key_len,
9055 const char *label, const size_t label_len,
9056 const unsigned char *context, const size_t context_len,
9057 const int use_context)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009058{
9059 if (!mbedtls_ssl_is_handshake_over(ssl)) {
Max Fillinger53d91682024-11-18 18:22:51 +01009060 /* TODO: Change this to a more appropriate error code when one is available. */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009061 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9062 }
9063
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009064 if (key_len > MBEDTLS_SSL_EXPORT_MAX_KEY_LEN) {
9065 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9066 }
9067
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009068 int ciphersuite_id = mbedtls_ssl_get_ciphersuite_id_from_ssl(ssl);
9069 const mbedtls_ssl_ciphersuite_t *ciphersuite = mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
9070 const mbedtls_md_type_t hash_alg = ciphersuite->mac;
9071
9072 switch (mbedtls_ssl_get_version_number(ssl)) {
Max Fillinger29beade2024-09-21 11:06:28 +02009073#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009074 case MBEDTLS_SSL_VERSION_TLS1_2:
9075 return mbedtls_ssl_tls12_export_keying_material(ssl, hash_alg, out, key_len,
9076 label, label_len,
9077 context, context_len, use_context);
Max Fillinger29beade2024-09-21 11:06:28 +02009078#endif
9079#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009080 case MBEDTLS_SSL_VERSION_TLS1_3:
Max Fillinger7b722202024-09-21 10:48:57 +02009081 return mbedtls_ssl_tls13_export_keying_material(ssl,
9082 hash_alg,
9083 out,
9084 key_len,
9085 label,
9086 label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009087 use_context ? context : NULL,
9088 use_context ? context_len : 0);
Max Fillinger29beade2024-09-21 11:06:28 +02009089#endif
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009090 default:
9091 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
9092 }
9093}
9094
Max Fillinger2fe35f62024-10-25 00:52:24 +02009095#endif /* defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT) */
Max Fillinger281fb792024-10-23 18:35:09 +02009096
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009097#endif /* MBEDTLS_SSL_TLS_C */