blob: 9144f9222b27446feadb1db5220b625c864b6a91 [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
Gilles Peskine449bd832023-01-11 14:50:10 +01001069 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001070}
1071
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001072#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001073/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001074MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001075static int ssl_cookie_write_dummy(void *ctx,
1076 unsigned char **p, unsigned char *end,
1077 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001078{
1079 ((void) ctx);
1080 ((void) p);
1081 ((void) end);
1082 ((void) cli_id);
1083 ((void) cli_id_len);
1084
Gilles Peskine449bd832023-01-11 14:50:10 +01001085 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001086}
1087
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001088MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001089static int ssl_cookie_check_dummy(void *ctx,
1090 const unsigned char *cookie, size_t cookie_len,
1091 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001092{
1093 ((void) ctx);
1094 ((void) cookie);
1095 ((void) cookie_len);
1096 ((void) cli_id);
1097 ((void) cli_id_len);
1098
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001100}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001101#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001102
Paul Bakker5121ce52009-01-03 21:22:43 +00001103/*
1104 * Initialize an SSL context
1105 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001106void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001107{
Gilles Peskine449bd832023-01-11 14:50:10 +01001108 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001109}
1110
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001111MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001112static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001113{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001114 const mbedtls_ssl_config *conf = ssl->conf;
1115
Ronald Cron6f135e12021-12-08 16:57:54 +01001116#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1118 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1119 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1120 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001121 }
1122
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1124 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001125 }
1126#endif
1127
1128#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1130 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1131 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001132 }
1133#endif
1134
Ronald Cron6f135e12021-12-08 16:57:54 +01001135#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1137 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1138 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1139 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001140 }
1141
Gilles Peskine449bd832023-01-11 14:50:10 +01001142 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1143 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001144 }
1145#endif
1146
Gilles Peskine449bd832023-01-11 14:50:10 +01001147 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1148 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001149}
1150
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001151MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001152static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1153{
1154 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001155 ret = ssl_conf_version_check(ssl);
1156 if (ret != 0) {
1157 return ret;
1158 }
Jerry Yu60835a82021-08-04 10:13:52 +08001159
1160 /* Space for further checks */
1161
Gilles Peskine449bd832023-01-11 14:50:10 +01001162 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001163}
1164
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001165/*
1166 * Setup an SSL context
1167 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001168
Gilles Peskine449bd832023-01-11 14:50:10 +01001169int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1170 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001171{
Janos Follath865b3eb2019-12-16 11:46:15 +00001172 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001173 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1174 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001175
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001176 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001177
Gilles Peskine449bd832023-01-11 14:50:10 +01001178 if ((ret = ssl_conf_check(ssl)) != 0) {
1179 return ret;
1180 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001181 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001182
Paul Bakker62f2dee2012-09-28 07:31:51 +00001183 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001184 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001185 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001186
1187 /* Set to NULL in case of an error condition */
1188 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001189
Darryl Greenb33cc762019-11-28 14:29:44 +00001190#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1191 ssl->in_buf_len = in_buf_len;
1192#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001193 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1194 if (ssl->in_buf == NULL) {
1195 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001196 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001197 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001198 }
1199
Darryl Greenb33cc762019-11-28 14:29:44 +00001200#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1201 ssl->out_buf_len = out_buf_len;
1202#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001203 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1204 if (ssl->out_buf == NULL) {
1205 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001206 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001207 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001208 }
1209
Deomid rojer Ryabkov3dfe75e2025-01-26 10:43:42 +02001210 mbedtls_ssl_reset_in_pointers(ssl);
1211 mbedtls_ssl_reset_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001212
Johan Pascalb62bb512015-12-03 21:56:45 +01001213#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001215#endif
1216
Gilles Peskine449bd832023-01-11 14:50:10 +01001217 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001218 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001219 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001220
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001222
1223error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001224 mbedtls_free(ssl->in_buf);
1225 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001226
1227 ssl->conf = NULL;
1228
Darryl Greenb33cc762019-11-28 14:29:44 +00001229#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1230 ssl->in_buf_len = 0;
1231 ssl->out_buf_len = 0;
1232#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001233 ssl->in_buf = NULL;
1234 ssl->out_buf = NULL;
1235
1236 ssl->in_hdr = NULL;
1237 ssl->in_ctr = NULL;
1238 ssl->in_len = NULL;
1239 ssl->in_iv = NULL;
1240 ssl->in_msg = NULL;
1241
1242 ssl->out_hdr = NULL;
1243 ssl->out_ctr = NULL;
1244 ssl->out_len = NULL;
1245 ssl->out_iv = NULL;
1246 ssl->out_msg = NULL;
1247
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001249}
1250
1251/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001252 * Reset an initialized and used SSL context for re-use while retaining
1253 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001254 *
1255 * If partial is non-zero, keep data in the input buffer and client ID.
1256 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001257 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001258void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1259 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001260{
Darryl Greenb33cc762019-11-28 14:29:44 +00001261#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1262 size_t in_buf_len = ssl->in_buf_len;
1263 size_t out_buf_len = ssl->out_buf_len;
1264#else
1265 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1266 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1267#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001268
Hanno Beckerb0302c42021-08-03 09:39:42 +01001269#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1270 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001271#endif
1272
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001273 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001274 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001275
Deomid rojer Ryabkov3dfe75e2025-01-26 10:43:42 +02001276 mbedtls_ssl_reset_in_pointers(ssl);
1277 mbedtls_ssl_reset_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001278
1279 /* Reset incoming message parsing */
1280 ssl->in_offt = NULL;
1281 ssl->nb_zero = 0;
1282 ssl->in_msgtype = 0;
1283 ssl->in_msglen = 0;
1284 ssl->in_hslen = 0;
Deomid rojer Ryabkovdd14c0a2025-02-13 13:41:51 +03001285 ssl->in_hsfraglen = 0;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001286 ssl->keep_current_message = 0;
1287 ssl->transform_in = NULL;
1288
1289#if defined(MBEDTLS_SSL_PROTO_DTLS)
1290 ssl->next_record_offset = 0;
1291 ssl->in_epoch = 0;
1292#endif
1293
1294 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001295 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001296 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001297 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001298 }
1299
Ronald Cronad8c17b2022-06-10 17:18:09 +02001300 ssl->send_alert = 0;
1301
Hanno Beckerb0302c42021-08-03 09:39:42 +01001302 /* Reset outgoing message writing */
1303 ssl->out_msgtype = 0;
1304 ssl->out_msglen = 0;
1305 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001306 memset(ssl->out_buf, 0, out_buf_len);
1307 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001308 ssl->transform_out = NULL;
1309
1310#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001312#endif
1313
XiaokangQian2b01dc32022-01-21 02:53:13 +00001314#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001315 if (ssl->transform) {
1316 mbedtls_ssl_transform_free(ssl->transform);
1317 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001318 ssl->transform = NULL;
1319 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001320#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1321
XiaokangQian2b01dc32022-01-21 02:53:13 +00001322#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001323 mbedtls_ssl_transform_free(ssl->transform_application);
1324 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001325 ssl->transform_application = NULL;
1326
Gilles Peskine449bd832023-01-11 14:50:10 +01001327 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001328#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001329 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1330 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001331 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001332#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001333
Gilles Peskine449bd832023-01-11 14:50:10 +01001334 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1335 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001336 ssl->handshake->transform_handshake = NULL;
1337 }
1338
XiaokangQian2b01dc32022-01-21 02:53:13 +00001339#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001340}
1341
Gilles Peskine449bd832023-01-11 14:50:10 +01001342int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001343{
1344 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1345
Gilles Peskinef670ba52025-03-07 15:09:32 +01001346 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_REQUEST);
Gilles Peskinefd89acc2025-02-24 18:45:49 +01001347 ssl->flags &= MBEDTLS_SSL_CONTEXT_FLAGS_KEEP_AT_SESSION;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001348 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001349
Gilles Peskine449bd832023-01-11 14:50:10 +01001350 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001351
1352 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001353#if defined(MBEDTLS_SSL_RENEGOTIATION)
1354 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001355 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001356
1357 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001358 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1359 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001360#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001361 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001362
Hanno Beckerb0302c42021-08-03 09:39:42 +01001363 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001364 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001365 if (ssl->session) {
1366 mbedtls_ssl_session_free(ssl->session);
1367 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001368 ssl->session = NULL;
1369 }
1370
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001371#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001372 ssl->alpn_chosen = NULL;
1373#endif
1374
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001375#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001376 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001377#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001378 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001379#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001380 if (free_cli_id) {
1381 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001382 ssl->cli_id = NULL;
1383 ssl->cli_id_len = 0;
1384 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001385#endif
1386
Gilles Peskine449bd832023-01-11 14:50:10 +01001387 if ((ret = ssl_handshake_init(ssl)) != 0) {
1388 return ret;
1389 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001390
Gilles Peskine449bd832023-01-11 14:50:10 +01001391 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001392}
1393
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001394/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001395 * Reset an initialized and used SSL context for re-use while retaining
1396 * all application-set variables, function pointers and data.
1397 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001398int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001399{
Gilles Peskine449bd832023-01-11 14:50:10 +01001400 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001401}
1402
1403/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001404 * SSL set accessors
1405 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001406void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001407{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001408 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001409}
1410
Gilles Peskine449bd832023-01-11 14:50:10 +01001411void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001412{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001413 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001414}
1415
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001416#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001417void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001418{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001419 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001420}
1421#endif
1422
Gilles Peskine449bd832023-01-11 14:50:10 +01001423void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001424{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001425 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001426}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001427
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001428#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001429
Gilles Peskine449bd832023-01-11 14:50:10 +01001430void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1431 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001432{
1433 ssl->disable_datagram_packing = !allow_packing;
1434}
1435
Gilles Peskine449bd832023-01-11 14:50:10 +01001436void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1437 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001438{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001439 conf->hs_timeout_min = min;
1440 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001441}
1442#endif
1443
Gilles Peskine449bd832023-01-11 14:50:10 +01001444void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001445{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001446 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001447}
1448
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001449#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001450void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1451 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1452 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001453{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001454 conf->f_vrfy = f_vrfy;
1455 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001456}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001457#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001458
Gilles Peskine449bd832023-01-11 14:50:10 +01001459void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1460 void (*f_dbg)(void *, int, const char *, int, const char *),
1461 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001462{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001463 conf->f_dbg = f_dbg;
1464 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001465}
1466
Gilles Peskine449bd832023-01-11 14:50:10 +01001467void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1468 void *p_bio,
1469 mbedtls_ssl_send_t *f_send,
1470 mbedtls_ssl_recv_t *f_recv,
1471 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001472{
1473 ssl->p_bio = p_bio;
1474 ssl->f_send = f_send;
1475 ssl->f_recv = f_recv;
1476 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001477}
1478
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001479#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001480void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001481{
1482 ssl->mtu = mtu;
1483}
1484#endif
1485
Gilles Peskine449bd832023-01-11 14:50:10 +01001486void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001487{
1488 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001489}
1490
Gilles Peskine449bd832023-01-11 14:50:10 +01001491void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1492 void *p_timer,
1493 mbedtls_ssl_set_timer_t *f_set_timer,
1494 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001495{
1496 ssl->p_timer = p_timer;
1497 ssl->f_set_timer = f_set_timer;
1498 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001499
1500 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001501 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001502}
1503
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001504#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001505void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1506 void *p_cache,
1507 mbedtls_ssl_cache_get_t *f_get_cache,
1508 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001509{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001510 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001511 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001512 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001513}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001514#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001515
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001516#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001517int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001518{
Janos Follath865b3eb2019-12-16 11:46:15 +00001519 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001520
Gilles Peskine449bd832023-01-11 14:50:10 +01001521 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001522 session == NULL ||
1523 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1525 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001526 }
1527
Gilles Peskine449bd832023-01-11 14:50:10 +01001528 if (ssl->handshake->resume == 1) {
1529 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1530 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001531
Jerry Yu21092062022-10-10 21:21:31 +08001532#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001533 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron233fcaa2024-04-04 14:05:21 +02001534#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001535 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001536 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001537
Gilles Peskine449bd832023-01-11 14:50:10 +01001538 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001539 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001540 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1541 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1542 session->ciphersuite));
1543 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001544 }
Ronald Cron233fcaa2024-04-04 14:05:21 +02001545#else
1546 /*
1547 * If session tickets are not enabled, it is not possible to resume a
1548 * TLS 1.3 session, thus do not make any change to the SSL context in
1549 * the first place.
1550 */
1551 return 0;
1552#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001553 }
Jerry Yu21092062022-10-10 21:21:31 +08001554#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001555
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1557 session)) != 0) {
1558 return ret;
1559 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001560
Paul Bakker0a597072012-09-25 21:55:46 +00001561 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001562
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001564}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001565#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001566
Gilles Peskine449bd832023-01-11 14:50:10 +01001567void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1568 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001569{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001570 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001571}
1572
Ronald Cron6f135e12021-12-08 16:57:54 +01001573#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001574void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1575 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001576{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001577 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001578}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001579
1580#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001581void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1582 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001583{
1584 conf->early_data_enabled = early_data_enabled;
1585}
Jerry Yucc4e0072022-11-22 17:22:22 +08001586
1587#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001588void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001589 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001590{
Jerry Yu39da9852022-12-06 16:58:36 +08001591 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001592}
1593#endif /* MBEDTLS_SSL_SRV_C */
1594
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001595#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001596#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001597
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001598#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001599void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1600 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001601{
1602 conf->cert_profile = profile;
1603}
1604
Gilles Peskine449bd832023-01-11 14:50:10 +01001605static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001606{
1607 mbedtls_ssl_key_cert *cur = key_cert, *next;
1608
Gilles Peskine449bd832023-01-11 14:50:10 +01001609 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001610 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001611 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001612 cur = next;
1613 }
1614}
1615
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001616/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001617MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001618static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1619 mbedtls_x509_crt *cert,
1620 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001621{
niisato8ee24222018-06-25 19:05:48 +09001622 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001623
Gilles Peskine449bd832023-01-11 14:50:10 +01001624 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001625 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001626 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001627 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001628 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001629 }
1630
Gilles Peskine449bd832023-01-11 14:50:10 +01001631 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1632 if (new_cert == NULL) {
1633 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1634 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001635
niisato8ee24222018-06-25 19:05:48 +09001636 new_cert->cert = cert;
1637 new_cert->key = key;
1638 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001639
Glenn Strauss36872db2022-01-22 05:06:31 -05001640 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001641 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001642 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001643 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001644 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001645 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001646 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001647 }
niisato8ee24222018-06-25 19:05:48 +09001648 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001649 }
1650
Gilles Peskine449bd832023-01-11 14:50:10 +01001651 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001652}
1653
Gilles Peskine449bd832023-01-11 14:50:10 +01001654int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001655 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001656 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001657{
Gilles Peskine449bd832023-01-11 14:50:10 +01001658 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001659}
1660
Gilles Peskine449bd832023-01-11 14:50:10 +01001661void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001662 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001663 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001664{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001665 conf->ca_chain = ca_chain;
1666 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001667
1668#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1669 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1670 * cannot be used together. */
1671 conf->f_ca_cb = NULL;
1672 conf->p_ca_cb = NULL;
1673#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001674}
Hanno Becker5adaad92019-03-27 16:54:37 +00001675
1676#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001677void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1678 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1679 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001680{
1681 conf->f_ca_cb = f_ca_cb;
1682 conf->p_ca_cb = p_ca_cb;
1683
1684 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1685 * cannot be used together. */
1686 conf->ca_chain = NULL;
1687 conf->ca_crl = NULL;
1688}
1689#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001690#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001691
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001692#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001693const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1694 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001695{
1696 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001697 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001698}
1699
Gilles Peskine449bd832023-01-11 14:50:10 +01001700int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1701 mbedtls_x509_crt *own_cert,
1702 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001703{
Gilles Peskine449bd832023-01-11 14:50:10 +01001704 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1705 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001706}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001707
Gilles Peskine449bd832023-01-11 14:50:10 +01001708void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1709 mbedtls_x509_crt *ca_chain,
1710 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001711{
1712 ssl->handshake->sni_ca_chain = ca_chain;
1713 ssl->handshake->sni_ca_crl = ca_crl;
1714}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001715
Glenn Strauss999ef702022-03-11 01:37:23 -05001716#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001717void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1718 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001719{
1720 ssl->handshake->dn_hints = crt;
1721}
1722#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1723
Gilles Peskine449bd832023-01-11 14:50:10 +01001724void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1725 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001726{
1727 ssl->handshake->sni_authmode = authmode;
1728}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001729#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1730
Hanno Becker8927c832019-04-03 12:52:50 +01001731#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001732void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1733 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1734 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001735{
1736 ssl->f_vrfy = f_vrfy;
1737 ssl->p_vrfy = p_vrfy;
1738}
1739#endif
1740
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001741#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001742
Przemek Stekielfde11282023-03-13 16:06:09 +01001743static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1744static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1745
Valerio Setti016f6822022-12-09 14:17:50 +01001746static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001747 mbedtls_ssl_context *ssl,
1748 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001749{
1750 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001751 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001752 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001753 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001754 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001755 size_t peer_len = 0;
Anton Matkin1b700842025-03-10 18:51:20 +01001756 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE(PSA_ALG_SHA_256));
Gilles Peskine449bd832023-01-11 14:50:10 +01001757 psa_pake_cs_set_primitive(&cipher_suite,
1758 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1759 PSA_ECC_FAMILY_SECP_R1,
1760 256));
Valerio Setti016f6822022-12-09 14:17:50 +01001761
Anton Matkin72d60302025-03-19 14:56:57 +01001762 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, pwd, &cipher_suite);
Gilles Peskine449bd832023-01-11 14:50:10 +01001763 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001764 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001765 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001766
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001768 user = jpake_server_id;
1769 user_len = sizeof(jpake_server_id);
1770 peer = jpake_client_id;
1771 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001772 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001773 user = jpake_client_id;
1774 user_len = sizeof(jpake_client_id);
1775 peer = jpake_server_id;
1776 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001777 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001778
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001779 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1780 if (status != PSA_SUCCESS) {
1781 return status;
1782 }
1783
1784 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001785 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001786 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001787 }
Valerio Setti016f6822022-12-09 14:17:50 +01001788
Valerio Setti016f6822022-12-09 14:17:50 +01001789 ssl->handshake->psa_pake_ctx_is_ok = 1;
1790
Gilles Peskine449bd832023-01-11 14:50:10 +01001791 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001792}
1793
Gilles Peskine449bd832023-01-11 14:50:10 +01001794int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1795 const unsigned char *pw,
1796 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001797{
1798 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1799 psa_status_t status;
1800
Gilles Peskine449bd832023-01-11 14:50:10 +01001801 if (ssl->handshake == NULL || ssl->conf == NULL) {
1802 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001803 }
1804
Gilles Peskine449bd832023-01-11 14:50:10 +01001805 /* Empty password is not valid */
1806 if ((pw == NULL) || (pw_len == 0)) {
1807 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1808 }
1809
1810 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
Anton Matkin6eb53352025-05-28 20:02:35 +02001811 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE(PSA_ALG_SHA_256));
Gilles Peskine449bd832023-01-11 14:50:10 +01001812 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
1813
1814 status = psa_import_key(&attributes, pw, pw_len,
1815 &ssl->handshake->psa_pake_password);
1816 if (status != PSA_SUCCESS) {
1817 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1818 }
1819
1820 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
1821 ssl->handshake->psa_pake_password);
1822 if (status != PSA_SUCCESS) {
1823 psa_destroy_key(ssl->handshake->psa_pake_password);
1824 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1825 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1826 }
1827
1828 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001829}
Valerio Settia9a97dc2022-11-28 18:26:16 +01001830
Gilles Peskine449bd832023-01-11 14:50:10 +01001831int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
1832 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01001833{
Valerio Settia9a97dc2022-11-28 18:26:16 +01001834 psa_status_t status;
1835
Gilles Peskine449bd832023-01-11 14:50:10 +01001836 if (ssl->handshake == NULL || ssl->conf == NULL) {
1837 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001838 }
1839
Gilles Peskine449bd832023-01-11 14:50:10 +01001840 if (mbedtls_svc_key_id_is_null(pwd)) {
1841 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1842 }
1843
1844 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
1845 if (status != PSA_SUCCESS) {
1846 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1847 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1848 }
1849
1850 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001851}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001852#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001853
Ronald Cron73fe8df2022-10-05 14:31:43 +02001854#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001855int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001856{
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 if (conf->psk_identity == NULL ||
1858 conf->psk_identity_len == 0) {
1859 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02001860 }
1861
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
1863 return 1;
1864 }
Ronald Crond29e13e2022-10-19 10:33:48 +02001865
Gilles Peskine449bd832023-01-11 14:50:10 +01001866 if (conf->psk != NULL && conf->psk_len != 0) {
1867 return 1;
1868 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001869
Gilles Peskine449bd832023-01-11 14:50:10 +01001870 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001871}
1872
Gilles Peskine449bd832023-01-11 14:50:10 +01001873static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001874{
1875 /* Remove reference to existing PSK, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001876 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001877 /* The maintenance of the PSK key slot is the
1878 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001879 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001880 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001881 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01001882 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001883 conf->psk = NULL;
1884 conf->psk_len = 0;
1885 }
1886
1887 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001888 if (conf->psk_identity != NULL) {
1889 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001890 conf->psk_identity = NULL;
1891 conf->psk_identity_len = 0;
1892 }
1893}
1894
Hanno Becker7390c712018-11-15 13:33:04 +00001895/* This function assumes that PSK identity in the SSL config is unset.
1896 * It checks that the provided identity is well-formed and attempts
1897 * to make a copy of it in the SSL config.
1898 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001899MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001900static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
1901 unsigned char const *psk_identity,
1902 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001903{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001904 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01001905 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02001906 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001907 (psk_identity_len >> 16) != 0 ||
1908 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
1909 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001910 }
1911
Gilles Peskine449bd832023-01-11 14:50:10 +01001912 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
1913 if (conf->psk_identity == NULL) {
1914 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1915 }
Paul Bakker6db455e2013-09-18 17:29:31 +02001916
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001917 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001918 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02001919
Gilles Peskine449bd832023-01-11 14:50:10 +01001920 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02001921}
1922
Gilles Peskine449bd832023-01-11 14:50:10 +01001923int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
1924 const unsigned char *psk, size_t psk_len,
1925 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00001926{
Janos Follath865b3eb2019-12-16 11:46:15 +00001927 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001928
1929 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001930 if (mbedtls_ssl_conf_has_static_psk(conf)) {
1931 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1932 }
Hanno Becker7390c712018-11-15 13:33:04 +00001933
1934 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01001935 if (psk == NULL) {
1936 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1937 }
1938 if (psk_len == 0) {
1939 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1940 }
1941 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
1942 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1943 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001944
Gilles Peskine449bd832023-01-11 14:50:10 +01001945 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
1946 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1947 }
Hanno Becker7390c712018-11-15 13:33:04 +00001948 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00001950
1951 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
1953 if (ret != 0) {
1954 ssl_conf_remove_psk(conf);
1955 }
Hanno Becker7390c712018-11-15 13:33:04 +00001956
Gilles Peskine449bd832023-01-11 14:50:10 +01001957 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00001958}
1959
Gilles Peskine449bd832023-01-11 14:50:10 +01001960static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001961{
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02001963 /* The maintenance of the external PSK key slot is the
1964 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 if (ssl->handshake->psk_opaque_is_internal) {
1966 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02001967 ssl->handshake->psk_opaque_is_internal = 0;
1968 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02001969 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001970 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001971}
1972
Gilles Peskine449bd832023-01-11 14:50:10 +01001973int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
1974 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001975{
Neil Armstrong501c9322022-05-03 09:35:09 +02001976 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08001977 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08001978 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08001979 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02001980
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 if (psk == NULL || ssl->handshake == NULL) {
1982 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1983 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001984
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
1986 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1987 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001988
Gilles Peskine449bd832023-01-11 14:50:10 +01001989 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001990
Jerry Yuccc68a42022-07-26 16:39:20 +08001991#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
1993 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
1994 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
1995 } else {
1996 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
1997 }
1998 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08001999 }
2000#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002001
Jerry Yu568ec252022-07-22 21:27:34 +08002002#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2004 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2005 psa_set_key_usage_flags(&key_attributes,
2006 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002007 }
2008#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2009
Gilles Peskine449bd832023-01-11 14:50:10 +01002010 psa_set_key_algorithm(&key_attributes, alg);
2011 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002012
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2014 if (status != PSA_SUCCESS) {
2015 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2016 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002017
2018 /* Allow calling psa_destroy_key() on psk remove */
2019 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002020 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002021}
2022
Gilles Peskine449bd832023-01-11 14:50:10 +01002023int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2024 mbedtls_svc_key_id_t psk,
2025 const unsigned char *psk_identity,
2026 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002027{
Janos Follath865b3eb2019-12-16 11:46:15 +00002028 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002029
2030 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002031 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2032 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2033 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002034
Hanno Becker7390c712018-11-15 13:33:04 +00002035 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 if (mbedtls_svc_key_id_is_null(psk)) {
2037 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2038 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002039 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002040
2041 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002042 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2043 psk_identity_len);
2044 if (ret != 0) {
2045 ssl_conf_remove_psk(conf);
2046 }
Hanno Becker7390c712018-11-15 13:33:04 +00002047
Gilles Peskine449bd832023-01-11 14:50:10 +01002048 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002049}
2050
Gilles Peskine449bd832023-01-11 14:50:10 +01002051int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2052 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002053{
Gilles Peskine449bd832023-01-11 14:50:10 +01002054 if ((mbedtls_svc_key_id_is_null(psk)) ||
2055 (ssl->handshake == NULL)) {
2056 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2057 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002058
Gilles Peskine449bd832023-01-11 14:50:10 +01002059 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002060 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002061 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002062}
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002063
Jerry Yu8897c072022-08-12 13:56:53 +08002064#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002065void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2066 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2067 size_t),
2068 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002069{
2070 conf->f_psk = f_psk;
2071 conf->p_psk = p_psk;
2072}
Jerry Yu8897c072022-08-12 13:56:53 +08002073#endif /* MBEDTLS_SSL_SRV_C */
2074
Ronald Cron73fe8df2022-10-05 14:31:43 +02002075#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002076
Gilles Peskine301711e2022-04-26 16:57:05 +02002077static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002079{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002080#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 if (alg == PSA_ALG_CBC_NO_PADDING) {
2082 return MBEDTLS_SSL_MODE_CBC;
2083 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002084#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 if (PSA_ALG_IS_AEAD(alg)) {
2086 return MBEDTLS_SSL_MODE_AEAD;
2087 }
2088 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002089}
2090
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002091
Gilles Peskinee108d982022-04-26 16:50:40 +02002092static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2093 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002094 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002095{
2096#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2098 base_mode == MBEDTLS_SSL_MODE_CBC) {
2099 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002100 }
2101#else
2102 (void) encrypt_then_mac;
2103#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002105}
2106
Neil Armstrongab555e02022-04-04 11:07:59 +02002107mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002109{
Gilles Peskinee108d982022-04-26 16:50:40 +02002110 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002111 transform->psa_alg
Gilles Peskinee108d982022-04-26 16:50:40 +02002112 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002113
Gilles Peskinee108d982022-04-26 16:50:40 +02002114 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002115#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002116 encrypt_then_mac = transform->encrypt_then_mac;
2117#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002119}
2120
Neil Armstrongab555e02022-04-04 11:07:59 +02002121mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002122#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002124#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002126{
Gilles Peskinee108d982022-04-26 16:50:40 +02002127 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2128
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002129 psa_status_t status;
2130 psa_algorithm_t alg;
2131 psa_key_type_t type;
2132 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002133 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2134 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002135 if (status == PSA_SUCCESS) {
2136 base_mode = mbedtls_ssl_get_base_mode(alg);
2137 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002138
Gilles Peskinee108d982022-04-26 16:50:40 +02002139#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2140 int encrypt_then_mac = 0;
2141#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002143}
2144
Jerry Yu251a12e2022-07-13 15:15:48 +08002145
Ronald Cron8b592d22024-11-12 18:08:25 +01002146const mbedtls_error_pair_t psa_to_ssl_errors[] =
2147{
2148 { PSA_SUCCESS, 0 },
2149 { PSA_ERROR_INSUFFICIENT_MEMORY, MBEDTLS_ERR_SSL_ALLOC_FAILED },
2150 { PSA_ERROR_NOT_SUPPORTED, MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE },
2151 { PSA_ERROR_INVALID_SIGNATURE, MBEDTLS_ERR_SSL_INVALID_MAC },
2152 { PSA_ERROR_INVALID_ARGUMENT, MBEDTLS_ERR_SSL_BAD_INPUT_DATA },
2153 { PSA_ERROR_BAD_STATE, MBEDTLS_ERR_SSL_INTERNAL_ERROR },
2154 { PSA_ERROR_BUFFER_TOO_SMALL, MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL }
2155};
2156
Gilles Peskine449bd832023-01-11 14:50:10 +01002157psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2158 size_t taglen,
2159 psa_algorithm_t *alg,
2160 psa_key_type_t *key_type,
2161 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002162{
Elena Uziunaitec2561722024-07-05 11:37:33 +01002163#if !defined(PSA_WANT_ALG_CCM)
Yanray Wang19e4dc82023-11-16 18:02:05 +08002164 (void) taglen;
2165#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 switch (mbedtls_cipher_type) {
Elena Uziunaite74342c72024-07-05 11:31:29 +01002167#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002168 case MBEDTLS_CIPHER_AES_128_CBC:
2169 *alg = PSA_ALG_CBC_NO_PADDING;
2170 *key_type = PSA_KEY_TYPE_AES;
2171 *key_size = 128;
2172 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002173#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002174#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002175 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002177 *key_type = PSA_KEY_TYPE_AES;
2178 *key_size = 128;
2179 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002180#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002181#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002182 case MBEDTLS_CIPHER_AES_128_GCM:
2183 *alg = PSA_ALG_GCM;
2184 *key_type = PSA_KEY_TYPE_AES;
2185 *key_size = 128;
2186 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002187#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002188#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002189 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002190 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002191 *key_type = PSA_KEY_TYPE_AES;
2192 *key_size = 192;
2193 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002194#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002195#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002196 case MBEDTLS_CIPHER_AES_192_GCM:
2197 *alg = PSA_ALG_GCM;
2198 *key_type = PSA_KEY_TYPE_AES;
2199 *key_size = 192;
2200 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002201#endif
Elena Uziunaite74342c72024-07-05 11:31:29 +01002202#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002203 case MBEDTLS_CIPHER_AES_256_CBC:
2204 *alg = PSA_ALG_CBC_NO_PADDING;
2205 *key_type = PSA_KEY_TYPE_AES;
2206 *key_size = 256;
2207 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002208#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002209#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002210 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002212 *key_type = PSA_KEY_TYPE_AES;
2213 *key_size = 256;
2214 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002215#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002216#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002217 case MBEDTLS_CIPHER_AES_256_GCM:
2218 *alg = PSA_ALG_GCM;
2219 *key_type = PSA_KEY_TYPE_AES;
2220 *key_size = 256;
2221 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002222#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002223#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002224 case MBEDTLS_CIPHER_ARIA_128_CBC:
2225 *alg = PSA_ALG_CBC_NO_PADDING;
2226 *key_type = PSA_KEY_TYPE_ARIA;
2227 *key_size = 128;
2228 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002229#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002230#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002231 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002233 *key_type = PSA_KEY_TYPE_ARIA;
2234 *key_size = 128;
2235 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002236#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002237#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002238 case MBEDTLS_CIPHER_ARIA_128_GCM:
2239 *alg = PSA_ALG_GCM;
2240 *key_type = PSA_KEY_TYPE_ARIA;
2241 *key_size = 128;
2242 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002243#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002244#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002245 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002247 *key_type = PSA_KEY_TYPE_ARIA;
2248 *key_size = 192;
2249 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002250#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002251#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002252 case MBEDTLS_CIPHER_ARIA_192_GCM:
2253 *alg = PSA_ALG_GCM;
2254 *key_type = PSA_KEY_TYPE_ARIA;
2255 *key_size = 192;
2256 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002257#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002258#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002259 case MBEDTLS_CIPHER_ARIA_256_CBC:
2260 *alg = PSA_ALG_CBC_NO_PADDING;
2261 *key_type = PSA_KEY_TYPE_ARIA;
2262 *key_size = 256;
2263 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002264#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002265#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002266 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002268 *key_type = PSA_KEY_TYPE_ARIA;
2269 *key_size = 256;
2270 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002271#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002272#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002273 case MBEDTLS_CIPHER_ARIA_256_GCM:
2274 *alg = PSA_ALG_GCM;
2275 *key_type = PSA_KEY_TYPE_ARIA;
2276 *key_size = 256;
2277 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002278#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002279#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002280 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2281 *alg = PSA_ALG_CBC_NO_PADDING;
2282 *key_type = PSA_KEY_TYPE_CAMELLIA;
2283 *key_size = 128;
2284 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002285#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002286#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002287 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002288 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002289 *key_type = PSA_KEY_TYPE_CAMELLIA;
2290 *key_size = 128;
2291 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002292#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002293#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002294 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2295 *alg = PSA_ALG_GCM;
2296 *key_type = PSA_KEY_TYPE_CAMELLIA;
2297 *key_size = 128;
2298 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002299#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002300#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002301 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002303 *key_type = PSA_KEY_TYPE_CAMELLIA;
2304 *key_size = 192;
2305 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002306#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002307#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002308 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2309 *alg = PSA_ALG_GCM;
2310 *key_type = PSA_KEY_TYPE_CAMELLIA;
2311 *key_size = 192;
2312 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002313#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002314#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002315 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2316 *alg = PSA_ALG_CBC_NO_PADDING;
2317 *key_type = PSA_KEY_TYPE_CAMELLIA;
2318 *key_size = 256;
2319 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002320#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002321#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002322 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002324 *key_type = PSA_KEY_TYPE_CAMELLIA;
2325 *key_size = 256;
2326 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002327#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002328#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002329 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2330 *alg = PSA_ALG_GCM;
2331 *key_type = PSA_KEY_TYPE_CAMELLIA;
2332 *key_size = 256;
2333 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002334#endif
Elena Uziunaite5c70c302024-07-05 11:44:44 +01002335#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002336 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2337 *alg = PSA_ALG_CHACHA20_POLY1305;
2338 *key_type = PSA_KEY_TYPE_CHACHA20;
2339 *key_size = 256;
2340 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002341#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002342 case MBEDTLS_CIPHER_NULL:
2343 *alg = MBEDTLS_SSL_NULL_CIPHER;
2344 *key_type = 0;
2345 *key_size = 0;
2346 break;
2347 default:
2348 return PSA_ERROR_NOT_SUPPORTED;
2349 }
2350
2351 return PSA_SUCCESS;
2352}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002353
Ronald Crone68ab4f2022-10-05 12:46:29 +02002354#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002355
Jerry Yuf017ee42022-01-12 15:49:48 +08002356/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002357void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2358 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002359{
Jerry Yuf017ee42022-01-12 15:49:48 +08002360 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002361}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002362#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002363
Brett Warrene0edc842021-08-17 09:53:13 +01002364/*
2365 * Set the allowed groups
2366 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002367void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2368 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002369{
Brett Warrene0edc842021-08-17 09:53:13 +01002370 conf->group_list = group_list;
2371}
2372
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002373#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine4ac40082025-02-20 18:13:58 +01002374
2375#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2376/** Whether mbedtls_ssl_set_hostname() has been called.
2377 *
2378 * \param[in] ssl SSL context
2379 *
2380 * \return \c 1 if mbedtls_ssl_set_hostname() has been called on \p ssl
2381 * (including `mbedtls_ssl_set_hostname(ssl, NULL)`),
2382 * otherwise \c 0.
2383 */
2384static int mbedtls_ssl_has_set_hostname_been_called(
2385 const mbedtls_ssl_context *ssl)
2386{
Gilles Peskine434016e2025-02-20 18:49:59 +01002387 return (ssl->flags & MBEDTLS_SSL_CONTEXT_FLAG_HOSTNAME_SET) != 0;
Gilles Peskine4ac40082025-02-20 18:13:58 +01002388}
2389#endif
2390
2391static void mbedtls_ssl_free_hostname(mbedtls_ssl_context *ssl)
2392{
2393 if (ssl->hostname != NULL) {
2394 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
2395 }
2396 ssl->hostname = NULL;
2397}
2398
Gilles Peskine449bd832023-01-11 14:50:10 +01002399int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002400{
Hanno Becker947194e2017-04-07 13:25:49 +01002401 /* Initialize to suppress unnecessary compiler warning */
2402 size_t hostname_len = 0;
2403
2404 /* Check if new hostname is valid before
2405 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 if (hostname != NULL) {
2407 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002408
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2410 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2411 }
Hanno Becker947194e2017-04-07 13:25:49 +01002412 }
2413
2414 /* Now it's clear that we will overwrite the old hostname,
2415 * so we can free it safely */
Gilles Peskine4ac40082025-02-20 18:13:58 +01002416 mbedtls_ssl_free_hostname(ssl);
Hanno Becker947194e2017-04-07 13:25:49 +01002417
2418 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002419
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002421 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 } else {
2423 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2424 if (ssl->hostname == NULL) {
2425 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2426 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002427
Gilles Peskine449bd832023-01-11 14:50:10 +01002428 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002429
Hanno Becker947194e2017-04-07 13:25:49 +01002430 ssl->hostname[hostname_len] = '\0';
2431 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002432
Gilles Peskine434016e2025-02-20 18:49:59 +01002433 ssl->flags |= MBEDTLS_SSL_CONTEXT_FLAG_HOSTNAME_SET;
2434
Gilles Peskine449bd832023-01-11 14:50:10 +01002435 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002436}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002437#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002438
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002439#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002440void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2441 int (*f_sni)(void *, mbedtls_ssl_context *,
2442 const unsigned char *, size_t),
2443 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002444{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002445 conf->f_sni = f_sni;
2446 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002447}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002448#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002449
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002450#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskinec4949d12025-05-27 19:45:29 +02002451int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf,
2452 const char *const *protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002453{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002454 size_t cur_len, tot_len;
Gilles Peskinec4949d12025-05-27 19:45:29 +02002455 const char *const *p;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002456
2457 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002458 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2459 * MUST NOT be truncated."
2460 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002461 */
2462 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 for (p = protos; *p != NULL; p++) {
2464 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002465 tot_len += cur_len;
2466
Gilles Peskine449bd832023-01-11 14:50:10 +01002467 if ((cur_len == 0) ||
2468 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2469 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2470 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2471 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002472 }
2473
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002474 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002475
Gilles Peskine449bd832023-01-11 14:50:10 +01002476 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002477}
2478
Gilles Peskine449bd832023-01-11 14:50:10 +01002479const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002480{
Gilles Peskine449bd832023-01-11 14:50:10 +01002481 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002482}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002483#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002484
Johan Pascalb62bb512015-12-03 21:56:45 +01002485#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002486void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2487 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002488{
2489 conf->dtls_srtp_mki_support = support_mki_value;
2490}
2491
Gilles Peskine449bd832023-01-11 14:50:10 +01002492int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2493 unsigned char *mki_value,
2494 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002495{
Gilles Peskine449bd832023-01-11 14:50:10 +01002496 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2497 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002498 }
Ron Eldor591f1622018-01-22 12:30:04 +02002499
Gilles Peskine449bd832023-01-11 14:50:10 +01002500 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2501 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002502 }
Ron Eldor591f1622018-01-22 12:30:04 +02002503
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002505 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002506 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002507}
2508
Gilles Peskine449bd832023-01-11 14:50:10 +01002509int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2510 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002511{
Johan Pascal253d0262020-09-22 13:04:45 +02002512 const mbedtls_ssl_srtp_profile *p;
2513 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002514
Johan Pascal253d0262020-09-22 13:04:45 +02002515 /* check the profiles list: all entry must be valid,
2516 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002517 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2518 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2519 p++) {
2520 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002521 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002523 /* unsupported value, stop parsing and set the size to an error value */
2524 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002525 }
2526 }
2527
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2529 conf->dtls_srtp_profile_list = NULL;
2530 conf->dtls_srtp_profile_list_len = 0;
2531 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002532 }
2533
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002534 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002535 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002536
Gilles Peskine449bd832023-01-11 14:50:10 +01002537 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002538}
2539
Gilles Peskine449bd832023-01-11 14:50:10 +01002540void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2541 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002542{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002543 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2544 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002545 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002546 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002547 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002548 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002549 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2550 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002551 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002552}
Johan Pascalb62bb512015-12-03 21:56:45 +01002553#endif /* MBEDTLS_SSL_DTLS_SRTP */
2554
Janos Follath088ce432017-04-10 12:42:31 +01002555#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002556void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2557 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002558{
2559 conf->cert_req_ca_list = cert_req_ca_list;
2560}
2561#endif
2562
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002563#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002564void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002565{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002566 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002567}
2568#endif
2569
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002570#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002571void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002572{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002573 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002574}
2575#endif
2576
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002577#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002578int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002579{
Gilles Peskine449bd832023-01-11 14:50:10 +01002580 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2581 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2582 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002583 }
2584
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002585 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002586
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002588}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002589#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002590
Gilles Peskine449bd832023-01-11 14:50:10 +01002591void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002592{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002593 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002594}
2595
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002596#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002597void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002598{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002599 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002600}
2601
Gilles Peskine449bd832023-01-11 14:50:10 +01002602void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002603{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002604 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002605}
2606
Gilles Peskine449bd832023-01-11 14:50:10 +01002607void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2608 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002609{
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002611}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002612#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker490ecc82011-10-06 13:04:09 +00002613
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002614#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002615#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002616void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002617{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002618 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002619}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002620#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002621
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002622#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002623
Jerry Yud0766ec2022-09-22 10:46:57 +08002624#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002625void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2626 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002627{
Jerry Yud0766ec2022-09-22 10:46:57 +08002628 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002629}
2630#endif
2631
Gilles Peskine449bd832023-01-11 14:50:10 +01002632void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2633 mbedtls_ssl_ticket_write_t *f_ticket_write,
2634 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2635 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02002636{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002637 conf->f_ticket_write = f_ticket_write;
2638 conf->f_ticket_parse = f_ticket_parse;
2639 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002640}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002641#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002642#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002643
Gilles Peskine449bd832023-01-11 14:50:10 +01002644void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
2645 mbedtls_ssl_export_keys_t *f_export_keys,
2646 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002647{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002648 ssl->f_export_keys = f_export_keys;
2649 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002650}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002651
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002652#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002653void mbedtls_ssl_conf_async_private_cb(
2654 mbedtls_ssl_config *conf,
2655 mbedtls_ssl_async_sign_t *f_async_sign,
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002656 mbedtls_ssl_async_resume_t *f_async_resume,
2657 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002659{
2660 conf->f_async_sign_start = f_async_sign;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002661 conf->f_async_resume = f_async_resume;
2662 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002663 conf->p_async_config_data = async_config_data;
2664}
2665
Gilles Peskine449bd832023-01-11 14:50:10 +01002666void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02002667{
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02002669}
2670
Gilles Peskine449bd832023-01-11 14:50:10 +01002671void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002672{
Gilles Peskine449bd832023-01-11 14:50:10 +01002673 if (ssl->handshake == NULL) {
2674 return NULL;
2675 } else {
2676 return ssl->handshake->user_async_ctx;
2677 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002678}
2679
Gilles Peskine449bd832023-01-11 14:50:10 +01002680void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2681 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002682{
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002684 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01002685 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002686}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002687#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002688
Paul Bakker5121ce52009-01-03 21:22:43 +00002689/*
2690 * SSL get accessors
2691 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002692uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002693{
Gilles Peskine449bd832023-01-11 14:50:10 +01002694 if (ssl->session != NULL) {
2695 return ssl->session->verify_result;
2696 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002697
Gilles Peskine449bd832023-01-11 14:50:10 +01002698 if (ssl->session_negotiate != NULL) {
2699 return ssl->session_negotiate->verify_result;
2700 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002701
Gilles Peskine449bd832023-01-11 14:50:10 +01002702 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00002703}
2704
Gilles Peskine449bd832023-01-11 14:50:10 +01002705int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05002706{
Gilles Peskine449bd832023-01-11 14:50:10 +01002707 if (ssl == NULL || ssl->session == NULL) {
2708 return 0;
2709 }
Glenn Strauss8f526902022-01-13 00:04:49 -05002710
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05002712}
2713
Gilles Peskine449bd832023-01-11 14:50:10 +01002714const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00002715{
Gilles Peskine449bd832023-01-11 14:50:10 +01002716 if (ssl == NULL || ssl->session == NULL) {
2717 return NULL;
2718 }
Paul Bakker926c8e42013-03-06 10:23:34 +01002719
Gilles Peskine449bd832023-01-11 14:50:10 +01002720 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00002721}
2722
Gilles Peskine449bd832023-01-11 14:50:10 +01002723const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00002724{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002725#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2727 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002728 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002729 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002730 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002731 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002732 }
2733 }
2734#endif
2735
Gilles Peskine449bd832023-01-11 14:50:10 +01002736 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002737 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002738 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04002739 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01002740 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002741 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002742 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002743 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002744}
2745
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002746#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2747
2748size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
2749{
2750 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2751 size_t record_size_limit = max_len;
2752
2753 if (ssl->session != NULL &&
2754 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2755 ssl->session->record_size_limit < max_len) {
2756 record_size_limit = ssl->session->record_size_limit;
2757 }
2758
2759 // TODO: this is currently untested
2760 /* During a handshake, use the value being negotiated */
2761 if (ssl->session_negotiate != NULL &&
2762 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2763 ssl->session_negotiate->record_size_limit < max_len) {
2764 record_size_limit = ssl->session_negotiate->record_size_limit;
2765 }
2766
2767 return record_size_limit;
2768}
2769#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2770
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002771#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002772size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002773{
David Horstmann95d516f2021-05-04 18:36:56 +01002774 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002775 size_t read_mfl;
2776
Jerry Yuddda0502022-12-01 19:43:12 +08002777#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002778 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2780 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
2781 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002782 }
Jerry Yuddda0502022-12-01 19:43:12 +08002783#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002784
2785 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002786 if (ssl->session_out != NULL) {
2787 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
2788 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002789 max_len = read_mfl;
2790 }
2791 }
2792
Jerry Yuddda0502022-12-01 19:43:12 +08002793 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 if (ssl->session_negotiate != NULL) {
2795 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
2796 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002797 max_len = read_mfl;
2798 }
2799 }
2800
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002802}
2803
Gilles Peskine449bd832023-01-11 14:50:10 +01002804size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002805{
2806 size_t max_len;
2807
2808 /*
2809 * Assume mfl_code is correct since it was checked when set
2810 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002811 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002812
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002813 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002814 if (ssl->session_out != NULL &&
2815 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
2816 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002817 }
2818
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002819 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002820 if (ssl->session_negotiate != NULL &&
2821 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
2822 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002823 }
2824
Gilles Peskine449bd832023-01-11 14:50:10 +01002825 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002826}
2827#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2828
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002829#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002830size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002831{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002832 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002833 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2834 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2835 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
2836 return 0;
2837 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002838
Gilles Peskine449bd832023-01-11 14:50:10 +01002839 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
2840 return ssl->mtu;
2841 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002842
Gilles Peskine449bd832023-01-11 14:50:10 +01002843 if (ssl->mtu == 0) {
2844 return ssl->handshake->mtu;
2845 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002846
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 return ssl->mtu < ssl->handshake->mtu ?
2848 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002849}
2850#endif /* MBEDTLS_SSL_PROTO_DTLS */
2851
Gilles Peskine449bd832023-01-11 14:50:10 +01002852int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002853{
2854 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2855
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002856#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002857 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002858 !defined(MBEDTLS_SSL_PROTO_DTLS)
2859 (void) ssl;
2860#endif
2861
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002862#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002863 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002864
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002866 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002868#endif
2869
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002870#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2871 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
2872
2873 if (max_len > record_size_limit) {
2874 max_len = record_size_limit;
2875 }
2876#endif
2877
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002878 if (ssl->transform_out != NULL &&
2879 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00002880 /*
2881 * In TLS 1.3 case, when records are protected, `max_len` as computed
2882 * above is the maximum length of the TLSInnerPlaintext structure that
2883 * along the plaintext payload contains the inner content type (one byte)
2884 * and some zero padding. Given the algorithm used for padding
2885 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
2886 * the plaintext payload. Round down to a multiple of
2887 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
2888 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002889 */
2890 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
2891 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
2892 }
2893
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002894#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002895 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
2896 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
2897 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002898 const size_t overhead = (size_t) ret;
2899
Gilles Peskine449bd832023-01-11 14:50:10 +01002900 if (ret < 0) {
2901 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002902 }
2903
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 if (mtu <= overhead) {
2905 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
2906 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2907 }
2908
2909 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002910 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002912 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002913#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002914
Hanno Becker0defedb2018-08-10 12:35:02 +01002915#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00002916 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
2917 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01002918 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002919#endif
2920
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002922}
2923
Gilles Peskine449bd832023-01-11 14:50:10 +01002924int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002925{
2926 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2927
2928#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2929 (void) ssl;
2930#endif
2931
2932#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002934
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002936 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01002937 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002938#endif
2939
Gilles Peskine449bd832023-01-11 14:50:10 +01002940 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002941}
2942
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002943#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002944const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00002945{
Gilles Peskine449bd832023-01-11 14:50:10 +01002946 if (ssl == NULL || ssl->session == NULL) {
2947 return NULL;
2948 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00002949
Hanno Beckere6824572019-02-07 13:18:46 +00002950#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00002952#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002953 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00002954#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002955}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002956#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002957
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002958#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002959int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
2960 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002961{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002962 int ret;
2963
Gilles Peskine449bd832023-01-11 14:50:10 +01002964 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002965 dst == NULL ||
2966 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
2968 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002969 }
2970
Hanno Beckere810bbc2021-05-14 16:01:05 +01002971 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2972 * idempotent: Each session can only be exported once.
2973 *
2974 * (This is in preparation for TLS 1.3 support where we will
2975 * need the ability to export multiple sessions (aka tickets),
2976 * which will be achieved by calling mbedtls_ssl_get_session()
2977 * multiple times until it fails.)
2978 *
2979 * Check whether we have already exported the current session,
2980 * and fail if so.
2981 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002982 if (ssl->session->exported == 1) {
2983 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2984 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01002985
Gilles Peskine449bd832023-01-11 14:50:10 +01002986 ret = mbedtls_ssl_session_copy(dst, ssl->session);
2987 if (ret != 0) {
2988 return ret;
2989 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01002990
2991 /* Remember that we've exported the session. */
2992 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002993 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002994}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002995#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002996
David Horstmanncb01b362024-02-29 17:31:46 +00002997#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2998
2999/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003000 *
David Horstmanncb01b362024-02-29 17:31:46 +00003001 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003002 */
3003static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3004 unsigned char *buf,
3005 size_t buf_len)
3006{
3007 unsigned char *p = buf;
3008 size_t used = 0;
3009
3010#if defined(MBEDTLS_HAVE_TIME)
3011 uint64_t start;
3012#endif
3013#if defined(MBEDTLS_X509_CRT_PARSE_C)
3014#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3015 size_t cert_len;
3016#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3017#endif /* MBEDTLS_X509_CRT_PARSE_C */
3018
3019 /*
3020 * Time
3021 */
3022#if defined(MBEDTLS_HAVE_TIME)
3023 used += 8;
3024
3025 if (used <= buf_len) {
3026 start = (uint64_t) session->start;
3027
3028 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3029 p += 8;
3030 }
3031#endif /* MBEDTLS_HAVE_TIME */
3032
3033 /*
3034 * Basic mandatory fields
3035 */
3036 used += 1 /* id_len */
3037 + sizeof(session->id)
3038 + sizeof(session->master)
3039 + 4; /* verify_result */
3040
3041 if (used <= buf_len) {
3042 *p++ = MBEDTLS_BYTE_0(session->id_len);
3043 memcpy(p, session->id, 32);
3044 p += 32;
3045
3046 memcpy(p, session->master, 48);
3047 p += 48;
3048
3049 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3050 p += 4;
3051 }
3052
3053 /*
3054 * Peer's end-entity certificate
3055 */
3056#if defined(MBEDTLS_X509_CRT_PARSE_C)
3057#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3058 if (session->peer_cert == NULL) {
3059 cert_len = 0;
3060 } else {
3061 cert_len = session->peer_cert->raw.len;
3062 }
3063
3064 used += 3 + cert_len;
3065
3066 if (used <= buf_len) {
3067 *p++ = MBEDTLS_BYTE_2(cert_len);
3068 *p++ = MBEDTLS_BYTE_1(cert_len);
3069 *p++ = MBEDTLS_BYTE_0(cert_len);
3070
3071 if (session->peer_cert != NULL) {
3072 memcpy(p, session->peer_cert->raw.p, cert_len);
3073 p += cert_len;
3074 }
3075 }
3076#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3077 if (session->peer_cert_digest != NULL) {
3078 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3079 if (used <= buf_len) {
3080 *p++ = (unsigned char) session->peer_cert_digest_type;
3081 *p++ = (unsigned char) session->peer_cert_digest_len;
3082 memcpy(p, session->peer_cert_digest,
3083 session->peer_cert_digest_len);
3084 p += session->peer_cert_digest_len;
3085 }
3086 } else {
3087 used += 2;
3088 if (used <= buf_len) {
3089 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3090 *p++ = 0;
3091 }
3092 }
3093#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3094#endif /* MBEDTLS_X509_CRT_PARSE_C */
3095
3096 /*
3097 * Session ticket if any, plus associated data
3098 */
3099#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3100#if defined(MBEDTLS_SSL_CLI_C)
3101 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3102 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3103
3104 if (used <= buf_len) {
3105 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3106 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3107 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3108
3109 if (session->ticket != NULL) {
3110 memcpy(p, session->ticket, session->ticket_len);
3111 p += session->ticket_len;
3112 }
3113
3114 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3115 p += 4;
3116 }
3117 }
3118#endif /* MBEDTLS_SSL_CLI_C */
3119#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3120 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3121 used += 8;
3122
3123 if (used <= buf_len) {
3124 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3125 p += 8;
3126 }
3127 }
3128#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3129#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3130
3131 /*
3132 * Misc extension-related info
3133 */
3134#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3135 used += 1;
3136
3137 if (used <= buf_len) {
3138 *p++ = session->mfl_code;
3139 }
3140#endif
3141
3142#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3143 used += 1;
3144
3145 if (used <= buf_len) {
3146 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3147 }
3148#endif
3149
3150 return used;
3151}
3152
3153MBEDTLS_CHECK_RETURN_CRITICAL
3154static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3155 const unsigned char *buf,
3156 size_t len)
3157{
3158#if defined(MBEDTLS_HAVE_TIME)
3159 uint64_t start;
3160#endif
3161#if defined(MBEDTLS_X509_CRT_PARSE_C)
3162#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3163 size_t cert_len;
3164#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3165#endif /* MBEDTLS_X509_CRT_PARSE_C */
3166
3167 const unsigned char *p = buf;
3168 const unsigned char * const end = buf + len;
3169
3170 /*
3171 * Time
3172 */
3173#if defined(MBEDTLS_HAVE_TIME)
3174 if (8 > (size_t) (end - p)) {
3175 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3176 }
3177
3178 start = MBEDTLS_GET_UINT64_BE(p, 0);
3179 p += 8;
3180
3181 session->start = (time_t) start;
3182#endif /* MBEDTLS_HAVE_TIME */
3183
3184 /*
3185 * Basic mandatory fields
3186 */
3187 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3188 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3189 }
3190
3191 session->id_len = *p++;
3192 memcpy(session->id, p, 32);
3193 p += 32;
3194
3195 memcpy(session->master, p, 48);
3196 p += 48;
3197
3198 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3199 p += 4;
3200
3201 /* Immediately clear invalid pointer values that have been read, in case
3202 * we exit early before we replaced them with valid ones. */
3203#if defined(MBEDTLS_X509_CRT_PARSE_C)
3204#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3205 session->peer_cert = NULL;
3206#else
3207 session->peer_cert_digest = NULL;
3208#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3209#endif /* MBEDTLS_X509_CRT_PARSE_C */
3210#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3211 session->ticket = NULL;
3212#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3213
3214 /*
3215 * Peer certificate
3216 */
3217#if defined(MBEDTLS_X509_CRT_PARSE_C)
3218#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3219 /* Deserialize CRT from the end of the ticket. */
3220 if (3 > (size_t) (end - p)) {
3221 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3222 }
3223
3224 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3225 p += 3;
3226
3227 if (cert_len != 0) {
3228 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3229
3230 if (cert_len > (size_t) (end - p)) {
3231 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3232 }
3233
3234 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3235
3236 if (session->peer_cert == NULL) {
3237 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3238 }
3239
3240 mbedtls_x509_crt_init(session->peer_cert);
3241
3242 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3243 p, cert_len)) != 0) {
3244 mbedtls_x509_crt_free(session->peer_cert);
3245 mbedtls_free(session->peer_cert);
3246 session->peer_cert = NULL;
3247 return ret;
3248 }
3249
3250 p += cert_len;
3251 }
3252#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3253 /* Deserialize CRT digest from the end of the ticket. */
3254 if (2 > (size_t) (end - p)) {
3255 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3256 }
3257
3258 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3259 session->peer_cert_digest_len = (size_t) *p++;
3260
3261 if (session->peer_cert_digest_len != 0) {
3262 const mbedtls_md_info_t *md_info =
3263 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3264 if (md_info == NULL) {
3265 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3266 }
3267 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3268 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3269 }
3270
3271 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3272 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3273 }
3274
3275 session->peer_cert_digest =
3276 mbedtls_calloc(1, session->peer_cert_digest_len);
3277 if (session->peer_cert_digest == NULL) {
3278 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3279 }
3280
3281 memcpy(session->peer_cert_digest, p,
3282 session->peer_cert_digest_len);
3283 p += session->peer_cert_digest_len;
3284 }
3285#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3286#endif /* MBEDTLS_X509_CRT_PARSE_C */
3287
3288 /*
3289 * Session ticket and associated data
3290 */
3291#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3292#if defined(MBEDTLS_SSL_CLI_C)
3293 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3294 if (3 > (size_t) (end - p)) {
3295 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3296 }
3297
3298 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3299 p += 3;
3300
3301 if (session->ticket_len != 0) {
3302 if (session->ticket_len > (size_t) (end - p)) {
3303 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3304 }
3305
3306 session->ticket = mbedtls_calloc(1, session->ticket_len);
3307 if (session->ticket == NULL) {
3308 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3309 }
3310
3311 memcpy(session->ticket, p, session->ticket_len);
3312 p += session->ticket_len;
3313 }
3314
3315 if (4 > (size_t) (end - p)) {
3316 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3317 }
3318
3319 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3320 p += 4;
3321 }
3322#endif /* MBEDTLS_SSL_CLI_C */
3323#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3324 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3325 if (8 > (size_t) (end - p)) {
3326 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3327 }
3328 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3329 p += 8;
3330 }
3331#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3332#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3333
3334 /*
3335 * Misc extension-related info
3336 */
3337#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3338 if (1 > (size_t) (end - p)) {
3339 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3340 }
3341
3342 session->mfl_code = *p++;
3343#endif
3344
3345#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3346 if (1 > (size_t) (end - p)) {
3347 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3348 }
3349
3350 session->encrypt_then_mac = *p++;
3351#endif
3352
3353 /* Done, should have consumed entire buffer */
3354 if (p != end) {
3355 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3356 }
3357
3358 return 0;
3359}
3360
3361#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3362
3363#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3364/* Serialization of TLS 1.3 sessions:
3365 *
David Horstmanncb01b362024-02-29 17:31:46 +00003366 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003367 */
3368#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3369MBEDTLS_CHECK_RETURN_CRITICAL
3370static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3371 unsigned char *buf,
3372 size_t buf_len,
3373 size_t *olen)
3374{
3375 unsigned char *p = buf;
3376#if defined(MBEDTLS_SSL_CLI_C) && \
3377 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3378 size_t hostname_len = (session->hostname == NULL) ?
3379 0 : strlen(session->hostname) + 1;
3380#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003381
3382#if defined(MBEDTLS_SSL_SRV_C) && \
3383 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003384 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003385 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003386#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003387 size_t needed = 4 /* ticket_age_add */
3388 + 1 /* ticket_flags */
3389 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003390
David Horstmanne59f9702024-02-29 16:08:57 +00003391 *olen = 0;
3392
3393 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3394 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3395 }
3396 needed += session->resumption_key_len; /* resumption_key */
3397
3398#if defined(MBEDTLS_SSL_EARLY_DATA)
3399 needed += 4; /* max_early_data_size */
3400#endif
3401#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3402 needed += 2; /* record_size_limit */
3403#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3404
3405#if defined(MBEDTLS_HAVE_TIME)
3406 needed += 8; /* ticket_creation_time or ticket_reception_time */
3407#endif
3408
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003409#if defined(MBEDTLS_SSL_SRV_C)
3410 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3411#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003412 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003413 + alpn_len; /* alpn */
3414#endif
3415 }
3416#endif /* MBEDTLS_SSL_SRV_C */
3417
David Horstmanne59f9702024-02-29 16:08:57 +00003418#if defined(MBEDTLS_SSL_CLI_C)
3419 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3420#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3421 needed += 2 /* hostname_len */
3422 + hostname_len; /* hostname */
3423#endif
3424
3425 needed += 4 /* ticket_lifetime */
3426 + 2; /* ticket_len */
3427
3428 /* Check size_t overflow */
3429 if (session->ticket_len > SIZE_MAX - needed) {
3430 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3431 }
3432
3433 needed += session->ticket_len; /* ticket */
3434 }
3435#endif /* MBEDTLS_SSL_CLI_C */
3436
3437 *olen = needed;
3438 if (needed > buf_len) {
3439 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3440 }
3441
3442 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3443 p[4] = session->ticket_flags;
3444
3445 /* save resumption_key */
3446 p[5] = session->resumption_key_len;
3447 p += 6;
3448 memcpy(p, session->resumption_key, session->resumption_key_len);
3449 p += session->resumption_key_len;
3450
3451#if defined(MBEDTLS_SSL_EARLY_DATA)
3452 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3453 p += 4;
3454#endif
3455#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3456 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3457 p += 2;
3458#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3459
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003460#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003461 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003462#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003463 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3464 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003465#endif /* MBEDTLS_HAVE_TIME */
3466
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003467#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003468 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3469 p += 2;
3470
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003471 if (alpn_len > 0) {
3472 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003473 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003474 p += alpn_len;
3475 }
3476#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3477 }
3478#endif /* MBEDTLS_SSL_SRV_C */
3479
David Horstmanne59f9702024-02-29 16:08:57 +00003480#if defined(MBEDTLS_SSL_CLI_C)
3481 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3482#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3483 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3484 p += 2;
3485 if (hostname_len > 0) {
3486 /* save host name */
3487 memcpy(p, session->hostname, hostname_len);
3488 p += hostname_len;
3489 }
3490#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3491
3492#if defined(MBEDTLS_HAVE_TIME)
3493 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3494 p += 8;
3495#endif
3496 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3497 p += 4;
3498
3499 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3500 p += 2;
3501
3502 if (session->ticket != NULL && session->ticket_len > 0) {
3503 memcpy(p, session->ticket, session->ticket_len);
3504 p += session->ticket_len;
3505 }
3506 }
3507#endif /* MBEDTLS_SSL_CLI_C */
3508 return 0;
3509}
3510
3511MBEDTLS_CHECK_RETURN_CRITICAL
3512static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3513 const unsigned char *buf,
3514 size_t len)
3515{
3516 const unsigned char *p = buf;
3517 const unsigned char *end = buf + len;
3518
3519 if (end - p < 6) {
3520 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3521 }
3522 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3523 session->ticket_flags = p[4];
3524
3525 /* load resumption_key */
3526 session->resumption_key_len = p[5];
3527 p += 6;
3528
3529 if (end - p < session->resumption_key_len) {
3530 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3531 }
3532
3533 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3534 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3535 }
3536 memcpy(session->resumption_key, p, session->resumption_key_len);
3537 p += session->resumption_key_len;
3538
3539#if defined(MBEDTLS_SSL_EARLY_DATA)
3540 if (end - p < 4) {
3541 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3542 }
3543 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3544 p += 4;
3545#endif
3546#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3547 if (end - p < 2) {
3548 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3549 }
3550 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3551 p += 2;
3552#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3553
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003554#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003555 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003556#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003557 if (end - p < 8) {
3558 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3559 }
3560 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3561 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003562#endif /* MBEDTLS_HAVE_TIME */
3563
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003564#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003565 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003566
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003567 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003568 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3569 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003570
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003571 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3572 p += 2;
3573
3574 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003575 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3576 }
3577
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003578 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003579 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3580 if (ret != 0) {
3581 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003582 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003583 p += alpn_len;
3584 }
3585#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3586 }
3587#endif /* MBEDTLS_SSL_SRV_C */
3588
David Horstmanne59f9702024-02-29 16:08:57 +00003589#if defined(MBEDTLS_SSL_CLI_C)
3590 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3591#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3592 size_t hostname_len;
3593 /* load host name */
3594 if (end - p < 2) {
3595 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3596 }
3597 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3598 p += 2;
3599
3600 if (end - p < (long int) hostname_len) {
3601 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3602 }
3603 if (hostname_len > 0) {
3604 session->hostname = mbedtls_calloc(1, hostname_len);
3605 if (session->hostname == NULL) {
3606 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3607 }
3608 memcpy(session->hostname, p, hostname_len);
3609 p += hostname_len;
3610 }
3611#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3612
3613#if defined(MBEDTLS_HAVE_TIME)
3614 if (end - p < 8) {
3615 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3616 }
3617 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3618 p += 8;
3619#endif
3620 if (end - p < 4) {
3621 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3622 }
3623 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3624 p += 4;
3625
3626 if (end - p < 2) {
3627 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3628 }
3629 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
3630 p += 2;
3631
3632 if (end - p < (long int) session->ticket_len) {
3633 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3634 }
3635 if (session->ticket_len > 0) {
3636 session->ticket = mbedtls_calloc(1, session->ticket_len);
3637 if (session->ticket == NULL) {
3638 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3639 }
3640 memcpy(session->ticket, p, session->ticket_len);
3641 p += session->ticket_len;
3642 }
3643 }
3644#endif /* MBEDTLS_SSL_CLI_C */
3645
3646 return 0;
3647
3648}
3649#else /* MBEDTLS_SSL_SESSION_TICKETS */
3650MBEDTLS_CHECK_RETURN_CRITICAL
3651static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3652 unsigned char *buf,
3653 size_t buf_len,
3654 size_t *olen)
3655{
3656 ((void) session);
3657 ((void) buf);
3658 ((void) buf_len);
3659 *olen = 0;
3660 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3661}
3662
3663static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01003664 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00003665 size_t buf_len)
3666{
3667 ((void) session);
3668 ((void) buf);
3669 ((void) buf_len);
3670 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3671}
3672#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
3673#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3674
Paul Bakker5121ce52009-01-03 21:22:43 +00003675/*
Hanno Beckera835da52019-05-16 12:39:07 +01003676 * Define ticket header determining Mbed TLS version
3677 * and structure of the ticket.
3678 */
3679
Hanno Becker94ef3b32019-05-16 12:50:45 +01003680/*
Hanno Becker50b59662019-05-28 14:30:45 +01003681 * Define bitflag determining compile-time settings influencing
3682 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003683 */
3684
Hanno Becker50b59662019-05-28 14:30:45 +01003685#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003686#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003687#else
Hanno Becker3e088662019-05-29 11:10:18 +01003688#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003689#endif /* MBEDTLS_HAVE_TIME */
3690
3691#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003692#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003693#else
Hanno Becker3e088662019-05-29 11:10:18 +01003694#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003695#endif /* MBEDTLS_X509_CRT_PARSE_C */
3696
David Horstmann5c5a32f2024-02-13 17:53:35 +00003697#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00003698#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00003699#else
David Horstmannf686f1d2024-03-01 11:20:32 +00003700#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00003701#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3702
Hanno Becker94ef3b32019-05-16 12:50:45 +01003703#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003704#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003705#else
Hanno Becker3e088662019-05-29 11:10:18 +01003706#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003707#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3708
3709#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003710#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003711#else
Hanno Becker3e088662019-05-29 11:10:18 +01003712#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003713#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3714
Hanno Becker94ef3b32019-05-16 12:50:45 +01003715#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003716#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003717#else
Hanno Becker3e088662019-05-29 11:10:18 +01003718#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003719#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3720
Hanno Becker94ef3b32019-05-16 12:50:45 +01003721#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3722#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3723#else
3724#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3725#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3726
David Horstmann92b258b2024-02-13 17:23:34 +00003727#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3728#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
3729#else
3730#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
3731#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3732
3733#if defined(MBEDTLS_SSL_EARLY_DATA)
3734#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
3735#else
3736#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
3737#endif /* MBEDTLS_SSL_EARLY_DATA */
3738
3739#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3740#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
3741#else
3742#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
3743#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3744
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003745#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
3746 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00003747#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
3748#else
3749#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
3750#endif /* MBEDTLS_SSL_ALPN */
3751
Hanno Becker3e088662019-05-29 11:10:18 +01003752#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3753#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3754#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3755#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003756#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3757#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00003758#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00003759#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
3760#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
3761#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00003762#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01003763
Hanno Becker50b59662019-05-28 14:30:45 +01003764#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003765 ((uint16_t) ( \
3766 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3767 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3768 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3769 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3770 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3771 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00003772 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00003773 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
3774 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00003775 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
3776 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
3777 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
3778 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003779 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00003780 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003781 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003782
Chien Wong4e9683e2023-12-28 17:07:43 +08003783static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003784 MBEDTLS_VERSION_MAJOR,
3785 MBEDTLS_VERSION_MINOR,
3786 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003787 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3788 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003789};
Hanno Beckera835da52019-05-16 12:39:07 +01003790
3791/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003792 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003793 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003794 *
David Horstmanncb01b362024-02-29 17:31:46 +00003795 * TLS 1.2 session:
3796 *
3797 * struct {
3798 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
3799 * opaque ticket<0..2^24-1>; // length 0 means no ticket
3800 * uint32 ticket_lifetime;
3801 * #endif
3802 * } ClientOnlyData;
3803 *
3804 * struct {
3805 * #if defined(MBEDTLS_HAVE_TIME)
3806 * uint64 start_time;
3807 * #endif
3808 * uint8 session_id_len; // at most 32
3809 * opaque session_id[32];
3810 * opaque master[48]; // fixed length in the standard
3811 * uint32 verify_result;
3812 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
3813 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
3814 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00003815 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00003816 * opaque peer_cert_digest<0..2^8-1>
3817 * #endif
3818 * select (endpoint) {
3819 * case client: ClientOnlyData;
3820 * case server: uint64 ticket_creation_time;
3821 * };
3822 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3823 * uint8 mfl_code; // up to 255 according to standard
3824 * #endif
3825 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3826 * uint8 encrypt_then_mac; // 0 or 1
3827 * #endif
3828 * } serialized_session_tls12;
3829 *
3830 *
3831 * TLS 1.3 Session:
3832 *
3833 * struct {
3834 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3835 * opaque hostname<0..2^16-1>;
3836 * #endif
3837 * #if defined(MBEDTLS_HAVE_TIME)
3838 * uint64 ticket_reception_time;
3839 * #endif
3840 * uint32 ticket_lifetime;
3841 * opaque ticket<1..2^16-1>;
3842 * } ClientOnlyData;
3843 *
3844 * struct {
3845 * uint32 ticket_age_add;
3846 * uint8 ticket_flags;
3847 * opaque resumption_key<0..255>;
3848 * #if defined(MBEDTLS_SSL_EARLY_DATA)
3849 * uint32 max_early_data_size;
3850 * #endif
3851 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3852 * uint16 record_size_limit;
3853 * #endif
3854 * select ( endpoint ) {
3855 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003856 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00003857 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003858 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00003859 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00003860 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003861 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00003862 * #endif
3863 * };
3864 * } serialized_session_tls13;
3865 *
3866 *
3867 * SSL session:
3868 *
3869 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003870 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003871 * opaque mbedtls_version[3]; // library version: major, minor, patch
3872 * opaque session_format[2]; // library-version specific 16-bit field
3873 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003874 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003875 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003876 * Note: When updating the format, remember to keep
3877 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003878 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003879 * // In this version, `session_format` determines
3880 * // the setting of those compile-time
3881 * // configuration options which influence
3882 * // the structure of mbedtls_ssl_session.
3883 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003884 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003885 * // - TLS 1.2 (0x0303)
3886 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00003887 * uint8_t endpoint;
3888 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003889 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003890 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003891 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003892 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003893 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003894 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003895 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003896 *
3897 * };
3898 *
3899 * } serialized_session;
3900 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003901 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003902
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003903MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003904static int ssl_session_save(const mbedtls_ssl_session *session,
3905 unsigned char omit_header,
3906 unsigned char *buf,
3907 size_t buf_len,
3908 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003909{
3910 unsigned char *p = buf;
3911 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003912 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003913#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3914 size_t out_len;
3915 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3916#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003917 if (session == NULL) {
3918 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3919 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003920
Gilles Peskine449bd832023-01-11 14:50:10 +01003921 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003922 /*
3923 * Add Mbed TLS version identifier
3924 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003925 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003926
Gilles Peskine449bd832023-01-11 14:50:10 +01003927 if (used <= buf_len) {
3928 memcpy(p, ssl_serialized_session_header,
3929 sizeof(ssl_serialized_session_header));
3930 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003931 }
3932 }
3933
3934 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01003935 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003936 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01003937 used += 1 /* TLS version */
3938 + 1 /* endpoint */
3939 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01003940 if (used <= buf_len) {
3941 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01003942 *p++ = session->endpoint;
3943 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
3944 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003945 }
3946
3947 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003948 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003949 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003950#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003951 case MBEDTLS_SSL_VERSION_TLS1_2:
3952 used += ssl_tls12_session_save(session, p, remaining_len);
3953 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003954#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3955
Jerry Yu251a12e2022-07-13 15:15:48 +08003956#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003957 case MBEDTLS_SSL_VERSION_TLS1_3:
3958 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3959 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3960 return ret;
3961 }
3962 used += out_len;
3963 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003964#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3965
Gilles Peskine449bd832023-01-11 14:50:10 +01003966 default:
3967 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003968 }
3969
3970 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003971 if (used > buf_len) {
3972 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3973 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003974
Gilles Peskine449bd832023-01-11 14:50:10 +01003975 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003976}
3977
3978/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003979 * Public wrapper for ssl_session_save()
3980 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003981int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3982 unsigned char *buf,
3983 size_t buf_len,
3984 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003985{
Gilles Peskine449bd832023-01-11 14:50:10 +01003986 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003987}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003988
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003989/*
3990 * Deserialize session, see mbedtls_ssl_session_save() for format.
3991 *
3992 * This internal version is wrapped by a public function that cleans up in
3993 * case of error, and has an extra option omit_header.
3994 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003995MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003996static int ssl_session_load(mbedtls_ssl_session *session,
3997 unsigned char omit_header,
3998 const unsigned char *buf,
3999 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004000{
4001 const unsigned char *p = buf;
4002 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004003 size_t remaining_len;
4004
4005
Gilles Peskine449bd832023-01-11 14:50:10 +01004006 if (session == NULL) {
4007 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4008 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004009
Gilles Peskine449bd832023-01-11 14:50:10 +01004010 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004011 /*
4012 * Check Mbed TLS version identifier
4013 */
4014
Gilles Peskine449bd832023-01-11 14:50:10 +01004015 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4016 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004017 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004018
4019 if (memcmp(p, ssl_serialized_session_header,
4020 sizeof(ssl_serialized_session_header)) != 0) {
4021 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4022 }
4023 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004024 }
4025
4026 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004027 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004028 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004029 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004030 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4031 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004032 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004033 session->endpoint = *p++;
4034 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4035 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004036
4037 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004038 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004039 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004040#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004041 case MBEDTLS_SSL_VERSION_TLS1_2:
4042 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004043#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4044
Jerry Yu438ddd82022-07-07 06:55:50 +00004045#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004046 case MBEDTLS_SSL_VERSION_TLS1_3:
4047 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004048#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4049
Gilles Peskine449bd832023-01-11 14:50:10 +01004050 default:
4051 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004052 }
4053}
4054
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004055/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004056 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004057 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004058int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4059 const unsigned char *buf,
4060 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004061{
Gilles Peskine449bd832023-01-11 14:50:10 +01004062 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004063
Gilles Peskine449bd832023-01-11 14:50:10 +01004064 if (ret != 0) {
4065 mbedtls_ssl_session_free(session);
4066 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004067
Gilles Peskine449bd832023-01-11 14:50:10 +01004068 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004069}
4070
4071/*
Paul Bakker1961b702013-01-25 14:49:24 +01004072 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004073 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004074MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004075static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004076{
4077 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4078
Ronald Cron66dbf912022-02-02 15:33:46 +01004079 /*
4080 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004081 * that were written into the output buffer by the previous handshake step,
4082 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004083 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4084 * We proceed to the next handshake step only when all data from the
4085 * previous one have been sent to the peer, thus we make sure that this is
4086 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4087 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4088 * we have to wait before to go ahead.
4089 * In the case of TLS 1.3, handshake step handlers do not send data to the
4090 * peer. Data are only sent here and through
4091 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004092 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004093 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004094 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4095 return ret;
4096 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004097
4098#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004099 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4100 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4101 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4102 return ret;
4103 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004104 }
4105#endif /* MBEDTLS_SSL_PROTO_DTLS */
4106
Gilles Peskine449bd832023-01-11 14:50:10 +01004107 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004108}
4109
Gilles Peskine449bd832023-01-11 14:50:10 +01004110int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004111{
Hanno Becker41934dd2021-08-07 19:13:43 +01004112 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004113
Gilles Peskine449bd832023-01-11 14:50:10 +01004114 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004115 ssl->conf == NULL ||
4116 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004117 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4118 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004119 }
4120
Gilles Peskine449bd832023-01-11 14:50:10 +01004121 ret = ssl_prepare_handshake_step(ssl);
4122 if (ret != 0) {
4123 return ret;
4124 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004125
Gilles Peskine449bd832023-01-11 14:50:10 +01004126 ret = mbedtls_ssl_handle_pending_alert(ssl);
4127 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004128 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004129 }
Jerry Yue7047812021-09-13 19:26:39 +08004130
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004131 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4132 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4133 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4134
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004135#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4137 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004138 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004139
Gilles Peskine449bd832023-01-11 14:50:10 +01004140 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004141 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskinef670ba52025-03-07 15:09:32 +01004142 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004143 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004144 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004145
Ronald Cron9f0fba32022-02-10 16:45:15 +01004146 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004147 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004148 break;
4149
4150 default:
4151#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004152 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4153 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4154 } else {
4155 ret = mbedtls_ssl_handshake_client_step(ssl);
4156 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004157#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004158 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004159#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004160 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004161#endif
4162 }
Jerry Yub9930e72021-08-06 17:11:51 +08004163 }
Ronald Cron6291b232023-03-08 15:51:25 +01004164#endif /* MBEDTLS_SSL_CLI_C */
4165
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004166#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004167 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004168#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4169 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004170 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004171 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004172 ret = mbedtls_ssl_handshake_server_step(ssl);
4173 }
Ronald Cron6291b232023-03-08 15:51:25 +01004174#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4175 ret = mbedtls_ssl_handshake_server_step(ssl);
4176#else
4177 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004178#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004179 }
4180#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004181
Gilles Peskine449bd832023-01-11 14:50:10 +01004182 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004183 /* handshake_step return error. And it is same
4184 * with alert_reason.
4185 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004186 if (ssl->send_alert) {
4187 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004188 goto cleanup;
4189 }
4190 }
4191
4192cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004193 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004194}
4195
4196/*
4197 * Perform the SSL handshake
4198 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004199int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004200{
4201 int ret = 0;
4202
Hanno Beckera817ea42020-10-20 15:20:23 +01004203 /* Sanity checks */
4204
Gilles Peskine449bd832023-01-11 14:50:10 +01004205 if (ssl == NULL || ssl->conf == NULL) {
4206 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4207 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004208
Hanno Beckera817ea42020-10-20 15:20:23 +01004209#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004210 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4211 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4212 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4213 "mbedtls_ssl_set_timer_cb() for DTLS"));
4214 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004215 }
4216#endif /* MBEDTLS_SSL_PROTO_DTLS */
4217
Gilles Peskine449bd832023-01-11 14:50:10 +01004218 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004219
Hanno Beckera817ea42020-10-20 15:20:23 +01004220 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004221 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4222 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004223
Gilles Peskine449bd832023-01-11 14:50:10 +01004224 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004225 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004226 }
Paul Bakker1961b702013-01-25 14:49:24 +01004227 }
4228
Gilles Peskine449bd832023-01-11 14:50:10 +01004229 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004230
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004232}
4233
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004234#if defined(MBEDTLS_SSL_RENEGOTIATION)
4235#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004236/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004237 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004238 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004239MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004240static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004241{
Janos Follath865b3eb2019-12-16 11:46:15 +00004242 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004243
Gilles Peskine449bd832023-01-11 14:50:10 +01004244 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004245
4246 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004247 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4248 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004249
Gilles Peskine449bd832023-01-11 14:50:10 +01004250 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4251 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4252 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004253 }
4254
Gilles Peskine449bd832023-01-11 14:50:10 +01004255 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004256
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004258}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004259#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004260
4261/*
4262 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004263 * - any side: calling mbedtls_ssl_renegotiate(),
4264 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4265 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004266 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004267 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004268 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004269 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004270int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004271{
Janos Follath865b3eb2019-12-16 11:46:15 +00004272 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004273
Gilles Peskine449bd832023-01-11 14:50:10 +01004274 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004275
Gilles Peskine449bd832023-01-11 14:50:10 +01004276 if ((ret = ssl_handshake_init(ssl)) != 0) {
4277 return ret;
4278 }
Paul Bakker48916f92012-09-16 19:57:18 +00004279
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004280 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4281 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004282#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004283 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4284 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4285 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004286 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004287 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004288 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004289 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004290 }
4291#endif
4292
Gilles Peskinef670ba52025-03-07 15:09:32 +01004293 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_REQUEST);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004294 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004295
Gilles Peskine449bd832023-01-11 14:50:10 +01004296 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4297 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4298 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004299 }
4300
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004302
Gilles Peskine449bd832023-01-11 14:50:10 +01004303 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004304}
4305
4306/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004307 * Renegotiate current connection on client,
4308 * or request renegotiation on server
4309 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004310int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004311{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004312 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004313
Gilles Peskine449bd832023-01-11 14:50:10 +01004314 if (ssl == NULL || ssl->conf == NULL) {
4315 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4316 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004317
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004318#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004319 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004320 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4321 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4322 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4323 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004324
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004325 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004326
4327 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004328 if (ssl->out_left != 0) {
4329 return mbedtls_ssl_flush_output(ssl);
4330 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004331
Gilles Peskine449bd832023-01-11 14:50:10 +01004332 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004333 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004334#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004335
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004336#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004337 /*
4338 * On client, either start the renegotiation process or,
4339 * if already in progress, continue the handshake
4340 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004341 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4342 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4343 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004344 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004345
4346 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4347 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4348 return ret;
4349 }
4350 } else {
4351 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4352 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4353 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004354 }
4355 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004356#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004357
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004359}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004360#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004361
Gilles Peskine449bd832023-01-11 14:50:10 +01004362void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004363{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004364 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4365
Gilles Peskine449bd832023-01-11 14:50:10 +01004366 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004367 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004368 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004369
Ronald Crone68ab4f2022-10-05 12:46:29 +02004370#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004371#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004372 handshake->sig_algs = NULL;
4373#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004374#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004375 if (ssl->handshake->certificate_request_context) {
4376 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004377 }
4378#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004379#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004380
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004381#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Ben Taylorcd2660f2025-03-21 13:13:29 +00004382 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
Ben Taylorc12152e2025-03-21 11:03:04 +00004383 ssl->conf->f_async_cancel(ssl);
4384 handshake->async_in_progress = 0;
Ben Taylor1cd1e012025-03-18 11:50:39 +00004385 }
Ben Taylor6ff2da12025-03-17 09:26:20 +00004386
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004387#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4388
Elena Uziunaite0916cd72024-05-23 17:01:07 +01004389#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004391#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01004392#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004394#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004395
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004396#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004397 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004398 /*
4399 * Opaque keys are not stored in the handshake's data and it's the user
4400 * responsibility to destroy them. Clear ones, instead, are created by
4401 * the TLS library and should be destroyed at the same level
4402 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004403 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4404 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004405 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004406 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004407#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004408 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004409 handshake->ecjpake_cache = NULL;
4410 handshake->ecjpake_cache_len = 0;
4411#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004412#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004413
Valerio Setti7aeec542023-07-05 18:57:21 +02004414#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004415 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004416 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004417 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004418 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004419#endif
4420
Ronald Cron73fe8df2022-10-05 14:31:43 +02004421#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004422 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004423 /* The maintenance of the external PSK key slot is the
4424 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004425 if (ssl->handshake->psk_opaque_is_internal) {
4426 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004427 ssl->handshake->psk_opaque_is_internal = 0;
4428 }
4429 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4430 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02004431#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004432
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004433#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4434 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004435 /*
4436 * Free only the linked list wrapper, not the keys themselves
4437 * since the belong to the SNI callback
4438 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004439 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004440#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004441
Gilles Peskineeccd8882020-03-10 12:19:08 +01004442#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004443 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4444 if (handshake->ecrs_peer_cert != NULL) {
4445 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4446 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004447 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004448#endif
4449
Hanno Becker75173122019-02-06 16:18:31 +00004450#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4451 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004452 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004453#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4454
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004455#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004456 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4457 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004458#endif /* MBEDTLS_SSL_CLI_C &&
4459 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004460
4461#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004462 mbedtls_ssl_flight_free(handshake->flight);
4463 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004464#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004465
Valerio Settiea59c432023-07-25 11:14:03 +02004466#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004467 if (handshake->xxdh_psa_privkey_is_external == 0) {
4468 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004469 }
Valerio Settiea59c432023-07-25 11:14:03 +02004470#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004471
Ronald Cron6f135e12021-12-08 16:57:54 +01004472#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 mbedtls_ssl_transform_free(handshake->transform_handshake);
4474 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004475#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004476 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4477 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004478#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004479#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004480
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004481
4482#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4483 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4484 * processes datagrams and the fact that a datagram is allowed to have
4485 * several records in it, it is possible that the I/O buffers are not
4486 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004487 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4488 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004489#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004490
Jerry Yuba9c7272021-10-30 11:54:10 +08004491 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 mbedtls_platform_zeroize(handshake,
4493 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004494}
4495
Gilles Peskine449bd832023-01-11 14:50:10 +01004496void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004497{
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004499 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004500 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004501
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004502#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004504#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004505
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004506#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004507#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4508 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004509 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004510#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004511 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004512#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004513
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004514#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4515 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004516 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004517#endif
4518
Gilles Peskine449bd832023-01-11 14:50:10 +01004519 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004520}
4521
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004522#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004523
4524#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4525#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4526#else
4527#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4528#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4529
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004530#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004531
4532#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4533#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4534#else
4535#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4536#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4537
4538#if defined(MBEDTLS_SSL_ALPN)
4539#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4540#else
4541#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4542#endif /* MBEDTLS_SSL_ALPN */
4543
4544#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4545#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4546#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4547#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4548
4549#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 ((uint32_t) ( \
4551 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4552 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4553 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4554 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4555 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4556 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4557 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4558 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004559
Chien Wong4e9683e2023-12-28 17:07:43 +08004560static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004561 MBEDTLS_VERSION_MAJOR,
4562 MBEDTLS_VERSION_MINOR,
4563 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004564 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4565 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4566 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4567 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4568 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004569};
4570
Paul Bakker5121ce52009-01-03 21:22:43 +00004571/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004572 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004573 *
4574 * The format of the serialized data is:
4575 * (in the presentation language of TLS, RFC 8446 section 3)
4576 *
4577 * // header
4578 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004579 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004580 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004581 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004582 * Note: When updating the format, remember to keep these
4583 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004584 *
4585 * // session sub-structure
4586 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4587 * // transform sub-structure
4588 * uint8 random[64]; // ServerHello.random+ClientHello.random
4589 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4590 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4591 * // fields from ssl_context
4592 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4593 * uint64 in_window_top; // DTLS: last validated record seq_num
4594 * uint64 in_window; // DTLS: bitmask for replay protection
4595 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4596 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4597 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4598 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4599 *
4600 * Note that many fields of the ssl_context or sub-structures are not
4601 * serialized, as they fall in one of the following categories:
4602 *
4603 * 1. forced value (eg in_left must be 0)
4604 * 2. pointer to dynamically-allocated memory (eg session, transform)
4605 * 3. value can be re-derived from other data (eg session keys from MS)
4606 * 4. value was temporary (eg content of input buffer)
4607 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004608 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004609int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4610 unsigned char *buf,
4611 size_t buf_len,
4612 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004613{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004614 unsigned char *p = buf;
4615 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004616 size_t session_len;
4617 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004618
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004619 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004620 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4621 * this function's documentation.
4622 *
4623 * These are due to assumptions/limitations in the implementation. Some of
4624 * them are likely to stay (no handshake in progress) some might go away
4625 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004626 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004627 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004628 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4629 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4630 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004631 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004632 if (ssl->handshake != NULL) {
4633 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4634 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004635 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004636 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004637 if (ssl->transform == NULL || ssl->session == NULL) {
4638 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4639 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004640 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004641 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004642 if (mbedtls_ssl_check_pending(ssl) != 0) {
4643 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4644 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004645 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004646 if (ssl->out_left != 0) {
4647 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4648 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004649 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004650 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004651 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4652 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4653 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004654 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004655 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004656 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4657 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4658 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004659 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004660 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4662 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4663 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004664 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004665 /* Renegotiation must not be enabled */
4666#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004667 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4668 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4669 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004670 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004671#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004672
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004673 /*
4674 * Version and format identifier
4675 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004676 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004677
Gilles Peskine449bd832023-01-11 14:50:10 +01004678 if (used <= buf_len) {
4679 memcpy(p, ssl_serialized_context_header,
4680 sizeof(ssl_serialized_context_header));
4681 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004682 }
4683
4684 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004685 * Session (length + data)
4686 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4688 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4689 return ret;
4690 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004691
4692 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004693 if (used <= buf_len) {
4694 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004695 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004696
Gilles Peskine449bd832023-01-11 14:50:10 +01004697 ret = ssl_session_save(ssl->session, 1,
4698 p, session_len, &session_len);
4699 if (ret != 0) {
4700 return ret;
4701 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004702
4703 p += session_len;
4704 }
4705
4706 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004707 * Transform
4708 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004709 used += sizeof(ssl->transform->randbytes);
4710 if (used <= buf_len) {
4711 memcpy(p, ssl->transform->randbytes,
4712 sizeof(ssl->transform->randbytes));
4713 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004714 }
4715
4716#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004717 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004718 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004719 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004720 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004721 p += ssl->transform->in_cid_len;
4722
4723 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004724 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004725 p += ssl->transform->out_cid_len;
4726 }
4727#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4728
4729 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004730 * Saved fields from top-level ssl_context structure
4731 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004732 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004733 if (used <= buf_len) {
4734 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004735 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004736 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004737
4738#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4739 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004740 if (used <= buf_len) {
4741 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004742 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004743
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004745 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004746 }
4747#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4748
4749#if defined(MBEDTLS_SSL_PROTO_DTLS)
4750 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004751 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004752 *p++ = ssl->disable_datagram_packing;
4753 }
4754#endif /* MBEDTLS_SSL_PROTO_DTLS */
4755
Jerry Yuae0b2e22021-10-08 15:21:19 +08004756 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004757 if (used <= buf_len) {
4758 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004759 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004760 }
4761
4762#if defined(MBEDTLS_SSL_PROTO_DTLS)
4763 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 if (used <= buf_len) {
4765 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004766 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004767 }
4768#endif /* MBEDTLS_SSL_PROTO_DTLS */
4769
4770#if defined(MBEDTLS_SSL_ALPN)
4771 {
4772 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004773 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004774 : 0;
4775
4776 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004778 *p++ = alpn_len;
4779
Gilles Peskine449bd832023-01-11 14:50:10 +01004780 if (ssl->alpn_chosen != NULL) {
4781 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004782 p += alpn_len;
4783 }
4784 }
4785 }
4786#endif /* MBEDTLS_SSL_ALPN */
4787
4788 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004789 * Done
4790 */
4791 *olen = used;
4792
Gilles Peskine449bd832023-01-11 14:50:10 +01004793 if (used > buf_len) {
4794 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4795 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004796
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004798
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004800}
4801
4802/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004803 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004804 *
4805 * This internal version is wrapped by a public function that cleans up in
4806 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004807 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004808MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004809static int ssl_context_load(mbedtls_ssl_context *ssl,
4810 const unsigned char *buf,
4811 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004812{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004813 const unsigned char *p = buf;
4814 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004815 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004816 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004817#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004818 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004819#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004820
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004821 /*
4822 * The context should have been freshly setup or reset.
4823 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004824 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004825 * renegotiating, or if the user mistakenly loaded a session first.)
4826 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4828 ssl->session != NULL) {
4829 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004830 }
4831
4832 /*
4833 * We can't check that the config matches the initial one, but we can at
4834 * least check it matches the requirements for serializing.
4835 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004836 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004837#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004838 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004839#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004840 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4841 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4842 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4843 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004844 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004845 }
4846
Gilles Peskine449bd832023-01-11 14:50:10 +01004847 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004848
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004849 /*
4850 * Check version identifier
4851 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4853 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004854 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004855
4856 if (memcmp(p, ssl_serialized_context_header,
4857 sizeof(ssl_serialized_context_header)) != 0) {
4858 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4859 }
4860 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004861
4862 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004863 * Session
4864 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004865 if ((size_t) (end - p) < 4) {
4866 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4867 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004868
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004869 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004870 p += 4;
4871
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004872 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004873 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004874 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004875 ssl->session_in = ssl->session;
4876 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004877 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004878
Gilles Peskine449bd832023-01-11 14:50:10 +01004879 if ((size_t) (end - p) < session_len) {
4880 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4881 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004882
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 ret = ssl_session_load(ssl->session, 1, p, session_len);
4884 if (ret != 0) {
4885 mbedtls_ssl_session_free(ssl->session);
4886 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004887 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004888
4889 p += session_len;
4890
4891 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004892 * Transform
4893 */
4894
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004895 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004896 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004897#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004898 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004899 ssl->transform_in = ssl->transform;
4900 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004901 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004902#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004903
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004904#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004905 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4906 if (prf_func == NULL) {
4907 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4908 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004909
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004910 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004911 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4912 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4913 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004914
Gilles Peskine449bd832023-01-11 14:50:10 +01004915 ret = ssl_tls12_populate_transform(ssl->transform,
4916 ssl->session->ciphersuite,
4917 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004918#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004919 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004920#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 prf_func,
4922 p, /* currently pointing to randbytes */
4923 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4924 ssl->conf->endpoint,
4925 ssl);
4926 if (ret != 0) {
4927 return ret;
4928 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004929#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004931
4932#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4933 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004934 if ((size_t) (end - p) < 1) {
4935 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4936 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004937
4938 ssl->transform->in_cid_len = *p++;
4939
Gilles Peskine449bd832023-01-11 14:50:10 +01004940 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4941 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4942 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004943
Gilles Peskine449bd832023-01-11 14:50:10 +01004944 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004945 p += ssl->transform->in_cid_len;
4946
4947 ssl->transform->out_cid_len = *p++;
4948
Gilles Peskine449bd832023-01-11 14:50:10 +01004949 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4950 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4951 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004952
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004954 p += ssl->transform->out_cid_len;
4955#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4956
4957 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004958 * Saved fields from top-level ssl_context structure
4959 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004960 if ((size_t) (end - p) < 4) {
4961 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4962 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004963
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004964 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004965 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004966
4967#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004968 if ((size_t) (end - p) < 16) {
4969 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4970 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004971
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004972 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004973 p += 8;
4974
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004975 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004976 p += 8;
4977#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4978
4979#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004980 if ((size_t) (end - p) < 1) {
4981 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4982 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004983
4984 ssl->disable_datagram_packing = *p++;
4985#endif /* MBEDTLS_SSL_PROTO_DTLS */
4986
Gilles Peskine449bd832023-01-11 14:50:10 +01004987 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
4988 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4989 }
4990 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
4991 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004992
4993#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004994 if ((size_t) (end - p) < 2) {
4995 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4996 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004997
Dave Rodgmana3d0f612023-11-03 23:34:02 +00004998 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004999 p += 2;
5000#endif /* MBEDTLS_SSL_PROTO_DTLS */
5001
5002#if defined(MBEDTLS_SSL_ALPN)
5003 {
5004 uint8_t alpn_len;
Gilles Peskinec4949d12025-05-27 19:45:29 +02005005 const char *const *cur;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005006
Gilles Peskine449bd832023-01-11 14:50:10 +01005007 if ((size_t) (end - p) < 1) {
5008 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5009 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005010
5011 alpn_len = *p++;
5012
Gilles Peskine449bd832023-01-11 14:50:10 +01005013 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005014 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005015 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5016 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005017 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005018 ssl->alpn_chosen = *cur;
5019 break;
5020 }
5021 }
5022 }
5023
5024 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005025 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5026 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5027 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005028
5029 p += alpn_len;
5030 }
5031#endif /* MBEDTLS_SSL_ALPN */
5032
5033 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005034 * Forced fields from top-level ssl_context structure
5035 *
5036 * Most of them already set to the correct value by mbedtls_ssl_init() and
5037 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5038 */
Gilles Peskinef670ba52025-03-07 15:09:32 +01005039 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Glenn Strauss60bfe602022-03-14 19:04:24 -04005040 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005041
Hanno Becker361b10d2019-08-30 10:42:49 +01005042 /* Adjust pointers for header fields of outgoing records to
5043 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005044 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005045
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005046#if defined(MBEDTLS_SSL_PROTO_DTLS)
5047 ssl->in_epoch = 1;
5048#endif
5049
5050 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5051 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005052 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5053 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 if (ssl->handshake != NULL) {
5055 mbedtls_ssl_handshake_free(ssl);
5056 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005057 ssl->handshake = NULL;
5058 }
5059
5060 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005061 * Done - should have consumed entire buffer
5062 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005063 if (p != end) {
5064 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5065 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005066
Gilles Peskine449bd832023-01-11 14:50:10 +01005067 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005068}
5069
5070/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005071 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005072 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005073int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5074 const unsigned char *buf,
5075 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005076{
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005078
Gilles Peskine449bd832023-01-11 14:50:10 +01005079 if (ret != 0) {
5080 mbedtls_ssl_free(context);
5081 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005082
Gilles Peskine449bd832023-01-11 14:50:10 +01005083 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005084}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005085#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005086
5087/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005088 * Free an SSL context
5089 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005090void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005091{
Gilles Peskine449bd832023-01-11 14:50:10 +01005092 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005093 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005094 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005095
Gilles Peskine449bd832023-01-11 14:50:10 +01005096 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005097
Gilles Peskine449bd832023-01-11 14:50:10 +01005098 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005099#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5100 size_t out_buf_len = ssl->out_buf_len;
5101#else
5102 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5103#endif
5104
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005105 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005106 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005107 }
5108
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005110#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5111 size_t in_buf_len = ssl->in_buf_len;
5112#else
5113 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5114#endif
5115
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005116 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005117 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005118 }
5119
Gilles Peskine449bd832023-01-11 14:50:10 +01005120 if (ssl->transform) {
5121 mbedtls_ssl_transform_free(ssl->transform);
5122 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005123 }
5124
Gilles Peskine449bd832023-01-11 14:50:10 +01005125 if (ssl->handshake) {
5126 mbedtls_ssl_handshake_free(ssl);
5127 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005128
5129#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005130 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5131 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005132#endif
5133
Gilles Peskine449bd832023-01-11 14:50:10 +01005134 mbedtls_ssl_session_free(ssl->session_negotiate);
5135 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005136 }
5137
Ronald Cron6f135e12021-12-08 16:57:54 +01005138#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005139 mbedtls_ssl_transform_free(ssl->transform_application);
5140 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005141#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005142
Gilles Peskine449bd832023-01-11 14:50:10 +01005143 if (ssl->session) {
5144 mbedtls_ssl_session_free(ssl->session);
5145 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005146 }
5147
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005148#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine4ac40082025-02-20 18:13:58 +01005149 mbedtls_ssl_free_hostname(ssl);
Paul Bakker0be444a2013-08-27 21:55:01 +02005150#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005151
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005152#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005153 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005154#endif
5155
Gilles Peskine449bd832023-01-11 14:50:10 +01005156 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005157
Paul Bakker86f04f42013-02-14 11:20:09 +01005158 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005159 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005160}
5161
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005162/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005163 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005164 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005165void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005166{
Gilles Peskine449bd832023-01-11 14:50:10 +01005167 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005168}
5169
Gilles Peskineae270bf2021-06-02 00:05:29 +02005170/* The selection should be the same as mbedtls_x509_crt_profile_default in
5171 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005172 * curves with a lower resource usage come first.
Manuel Pégourié-Gonnard93d45912025-01-14 11:45:44 +01005173 * See the documentation of mbedtls_ssl_conf_groups() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005174 * about this list.
5175 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005176static const uint16_t ssl_preset_default_groups[] = {
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005177#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Brett Warrene0edc842021-08-17 09:53:13 +01005178 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005179#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005180#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005181 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005182#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005183#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005184 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005185#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005186#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Brett Warrene0edc842021-08-17 09:53:13 +01005187 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005188#endif
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005189#if defined(PSA_WANT_ECC_SECP_R1_521)
Brett Warrene0edc842021-08-17 09:53:13 +01005190 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005191#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005192#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005193 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005194#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005195#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005196 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005197#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005198#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Brett Warrene0edc842021-08-17 09:53:13 +01005199 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005200#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005201#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005202 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5203 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5204 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5205 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5206 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5207#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005208 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005209};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005210
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005211static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005212 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5213 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5214 0
5215};
5216
Ronald Crone68ab4f2022-10-05 12:46:29 +02005217#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005218
Jerry Yu909df7b2022-01-22 11:56:27 +08005219/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005220 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005221 * rules SHOULD be upheld.
5222 * - No duplicate entries.
5223 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005224 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005225 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005226 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005227static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005228
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005229#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005230 defined(PSA_WANT_ALG_SHA_256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005231 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005232 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005233 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5234#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005235
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005236#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005237 defined(PSA_WANT_ALG_SHA_384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005238 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005239 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005240 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5241#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005242
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005243#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Gabor Mezeic15ef932024-06-13 12:53:54 +02005244 defined(PSA_WANT_ALG_SHA_512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005245 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005246 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005247 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5248#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005249
Gabor Mezeic15ef932024-06-13 12:53:54 +02005250#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005251 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005252#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005253
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005254#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005255 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005256#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005257
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005258#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005259 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005260#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005261
Gabor Mezeic15ef932024-06-13 12:53:54 +02005262#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005263 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Gabor Mezeic15ef932024-06-13 12:53:54 +02005264#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005265
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005266#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005267 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005268#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005269
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005270#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005271 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005272#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005273
Gabor Mezei15b95a62022-05-09 16:37:58 +02005274 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005275};
5276
5277/* NOTICE: see above */
5278#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Deomid rojer Ryabkove2d71cc2024-03-18 12:32:30 +00005279static const uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005280
Gabor Mezeic15ef932024-06-13 12:53:54 +02005281#if defined(PSA_WANT_ALG_SHA_512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005282#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005283 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005284#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005285#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5286 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005287#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005288#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005289 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005290#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005291#endif /* PSA_WANT_ALG_SHA_512 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005292
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005293#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005294#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005295 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005296#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005297#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5298 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005299#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005300#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005301 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005302#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005303#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005304
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005305#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005306#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005307 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005308#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005309#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5310 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005311#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005312#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005313 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005314#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005315#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005316
Gabor Mezei15b95a62022-05-09 16:37:58 +02005317 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005318};
5319#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005320
Jerry Yu909df7b2022-01-22 11:56:27 +08005321/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005322static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005323
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005324#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005325 defined(PSA_WANT_ALG_SHA_256) && \
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005326 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005327 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005328 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5329#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005330
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005331#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005332 defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005333 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu53037892022-01-25 11:02:06 +08005334 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005335 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5336#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005337
Gabor Mezei15b95a62022-05-09 16:37:58 +02005338 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005339};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005340
Jerry Yu909df7b2022-01-22 11:56:27 +08005341/* NOTICE: see above */
5342#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Deomid rojer Ryabkov7dddc172024-03-20 00:43:34 +00005343static const uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005344
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005345#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005346#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005347 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005348#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005349#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005350
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005351#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005352#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005353 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005354#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005355#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005356
Gabor Mezei15b95a62022-05-09 16:37:58 +02005357 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005358};
Jerry Yu909df7b2022-01-22 11:56:27 +08005359#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5360
Ronald Crone68ab4f2022-10-05 12:46:29 +02005361#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005362
Chien Wong4e9683e2023-12-28 17:07:43 +08005363static const uint16_t ssl_preset_suiteb_groups[] = {
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005364#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005365 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005366#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005367#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005368 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005369#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005370 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005371};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005372
Ronald Crone68ab4f2022-10-05 12:46:29 +02005373#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005374/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005375 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005376MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005377static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005378{
5379 size_t i, j;
5380 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005381
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5383 for (j = 0; j < i; j++) {
5384 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005385 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 }
5387 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5388 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5389 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005390 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005391 }
5392 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005393 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005394}
5395
Ronald Crone68ab4f2022-10-05 12:46:29 +02005396#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005397
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005398/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005399 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005400 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005401int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5402 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005403{
Ronald Crone68ab4f2022-10-05 12:46:29 +02005404#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5406 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5407 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005408 }
5409
Gilles Peskine449bd832023-01-11 14:50:10 +01005410 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5411 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5412 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005413 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005414
5415#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5417 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5418 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005419 }
5420
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5422 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5423 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005424 }
5425#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005426#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005427
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005428 /* Use the functions here so that they are covered in tests,
5429 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 mbedtls_ssl_conf_endpoint(conf, endpoint);
5431 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005432
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005433 /*
5434 * Things that are common to all presets
5435 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005436#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005437 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005438 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5439#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5440 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5441#endif
5442 }
5443#endif
5444
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005445#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5446 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5447#endif
5448
5449#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5450 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5451#endif
5452
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005453#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005454 conf->f_cookie_write = ssl_cookie_write_dummy;
5455 conf->f_cookie_check = ssl_cookie_check_dummy;
5456#endif
5457
5458#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5459 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5460#endif
5461
Janos Follath088ce432017-04-10 12:42:31 +01005462#if defined(MBEDTLS_SSL_SRV_C)
5463 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005464 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005465#endif
5466
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005467#if defined(MBEDTLS_SSL_PROTO_DTLS)
5468 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5469 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5470#endif
5471
5472#if defined(MBEDTLS_SSL_RENEGOTIATION)
5473 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005474 memset(conf->renego_period, 0x00, 2);
5475 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005476#endif
5477
Ronald Cron6f135e12021-12-08 16:57:54 +01005478#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005479
5480#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005481 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005482#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005483 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005484#endif
5485#endif /* MBEDTLS_SSL_EARLY_DATA */
5486
Jerry Yud0766ec2022-09-22 10:46:57 +08005487#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005488 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005490#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005491 /*
5492 * Allow all TLS 1.3 key exchange modes by default.
5493 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005494 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005495#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005496
Gilles Peskine449bd832023-01-11 14:50:10 +01005497 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005498#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005499 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005500 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005501#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005503#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005504 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005505#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005506 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5507 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005508#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5509 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5510 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5511#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5512 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5513 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5514#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005515 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005516#endif
5517 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005518
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005519 /*
5520 * Preset-specific defaults
5521 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005522 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005523 /*
5524 * NSA Suite B
5525 */
5526 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005527
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005528 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005529
5530#if defined(MBEDTLS_X509_CRT_PARSE_C)
5531 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005532#endif
5533
Ronald Crone68ab4f2022-10-05 12:46:29 +02005534#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005535#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005536 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005537 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005538 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005539#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005540 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005541#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005542
Brett Warrene0edc842021-08-17 09:53:13 +01005543 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005544 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005545
5546 /*
5547 * Default
5548 */
5549 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005550
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005551 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005552
5553#if defined(MBEDTLS_X509_CRT_PARSE_C)
5554 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5555#endif
5556
Ronald Crone68ab4f2022-10-05 12:46:29 +02005557#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005558#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005559 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005560 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005561 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005562#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005563 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005564#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005565
Brett Warrene0edc842021-08-17 09:53:13 +01005566 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005567 }
5568
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005570}
5571
5572/*
5573 * Free mbedtls_ssl_config
5574 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005575void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005576{
Troy-Butlerda73abc2024-04-02 13:37:31 -04005577 if (conf == NULL) {
5578 return;
5579 }
5580
Ronald Cron73fe8df2022-10-05 14:31:43 +02005581#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005583 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5584 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005585 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005586 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005587 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005588 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005589 }
5590
Gilles Peskine449bd832023-01-11 14:50:10 +01005591 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005592 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005593 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005594 conf->psk_identity_len = 0;
5595 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005596#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005597
5598#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005599 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005600#endif
5601
Gilles Peskine449bd832023-01-11 14:50:10 +01005602 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005603}
5604
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005605#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005606 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005607/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005608 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005609 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005610unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005611{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005612#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005613 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5614 return MBEDTLS_SSL_SIG_RSA;
5615 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005616#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005617#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5619 return MBEDTLS_SSL_SIG_ECDSA;
5620 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005621#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005622 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005623}
5624
Gilles Peskine449bd832023-01-11 14:50:10 +01005625unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005626{
Gilles Peskine449bd832023-01-11 14:50:10 +01005627 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005628 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005629 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005630 case MBEDTLS_PK_ECDSA:
5631 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005632 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005633 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005634 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005635 }
5636}
5637
Gilles Peskine449bd832023-01-11 14:50:10 +01005638mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005639{
Gilles Peskine449bd832023-01-11 14:50:10 +01005640 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005641#if defined(MBEDTLS_RSA_C)
5642 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005643 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005644#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005645#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005646 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005647 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005648#endif
5649 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005650 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005651 }
5652}
Valerio Settie9646ec2023-08-02 20:02:28 +02005653#endif /* MBEDTLS_PK_C &&
5654 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005655
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005656/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005657 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005658 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005659mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005660{
Gilles Peskine449bd832023-01-11 14:50:10 +01005661 switch (hash) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005662#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005663 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005664 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005665#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005666#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005667 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005668 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005669#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005670#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005671 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005672 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005673#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005674#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005675 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005676 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005677#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005678#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005679 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005680 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005681#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005682#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005683 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005684 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005685#endif
5686 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005687 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005688 }
5689}
5690
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005691/*
5692 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5693 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005694unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005695{
Gilles Peskine449bd832023-01-11 14:50:10 +01005696 switch (md) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005697#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005698 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005699 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005700#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005701#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005702 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005703 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005704#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005705#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005706 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005707 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005708#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005709#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005710 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005711 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005712#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005713#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005714 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005715 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005716#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005717#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005718 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005719 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005720#endif
5721 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005722 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005723 }
5724}
5725
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005726/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005727 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005728 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005729 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005730int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005731{
Manuel Pégourié-Gonnard6402c352025-01-14 12:23:56 +01005732 const uint16_t *group_list = ssl->conf->group_list;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005733
Gilles Peskine449bd832023-01-11 14:50:10 +01005734 if (group_list == NULL) {
5735 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005736 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005737
Gilles Peskine449bd832023-01-11 14:50:10 +01005738 for (; *group_list != 0; group_list++) {
5739 if (*group_list == tls_id) {
5740 return 0;
5741 }
5742 }
5743
5744 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005745}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005746
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005747#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005748/*
5749 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5750 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005751int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005752{
Gilles Peskine449bd832023-01-11 14:50:10 +01005753 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005754
Gilles Peskine449bd832023-01-11 14:50:10 +01005755 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005756 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005757 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005758
Gilles Peskine449bd832023-01-11 14:50:10 +01005759 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005760}
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005761#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Valerio Setti67419f02023-01-04 16:12:42 +01005762
Valerio Setti18c9fed2022-12-30 17:44:24 +01005763static const struct {
5764 uint16_t tls_id;
5765 mbedtls_ecp_group_id ecp_group_id;
5766 psa_ecc_family_t psa_family;
5767 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005768} tls_id_match_table[] =
5769{
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005770#if defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02005771 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005772#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005773#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02005774 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005775#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005776#if defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005777 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005778#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005779#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005780 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005781#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005782#if defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005783 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005784#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005785#if defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005786 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005787#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005788#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005789 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005790#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005791#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02005792 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005793#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005794#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005795 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005796#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005797 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005798};
5799
Gilles Peskine449bd832023-01-11 14:50:10 +01005800int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005801 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005802 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005803{
Gilles Peskine449bd832023-01-11 14:50:10 +01005804 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5805 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005806 if (type != NULL) {
5807 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005808 }
5809 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005810 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005811 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005812 return PSA_SUCCESS;
5813 }
5814 }
5815
5816 return PSA_ERROR_NOT_SUPPORTED;
5817}
5818
Gilles Peskine449bd832023-01-11 14:50:10 +01005819mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005820{
Gilles Peskine449bd832023-01-11 14:50:10 +01005821 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5822 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005823 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005824 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005825 }
5826
5827 return MBEDTLS_ECP_DP_NONE;
5828}
5829
Gilles Peskine449bd832023-01-11 14:50:10 +01005830uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005831{
Gilles Peskine449bd832023-01-11 14:50:10 +01005832 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5833 i++) {
5834 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005835 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005836 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005837 }
5838
5839 return 0;
5840}
5841
Valerio Setti67419f02023-01-04 16:12:42 +01005842#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005843static const struct {
5844 uint16_t tls_id;
5845 const char *name;
5846} tls_id_curve_name_table[] =
5847{
Valerio Setti54e23792023-07-07 10:49:27 +02005848 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5849 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5850 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5851 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5852 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5853 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5854 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
Valerio Setti54e23792023-07-07 10:49:27 +02005855 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5856 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005857 { 0, NULL },
5858};
5859
Gilles Peskine449bd832023-01-11 14:50:10 +01005860const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005861{
Valerio Settiacd32c02023-06-29 18:06:29 +02005862 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5863 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5864 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005865 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005866 }
5867
5868 return NULL;
5869}
Valerio Setti67419f02023-01-04 16:12:42 +01005870#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005871
Gilles Peskine449bd832023-01-11 14:50:10 +01005872int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5873 const mbedtls_md_type_t md,
5874 unsigned char *dst,
5875 size_t dst_len,
5876 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005877{
Ronald Cronf6893e12022-01-07 22:09:01 +01005878 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5879 psa_hash_operation_t *hash_operation_to_clone;
5880 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5881
Jerry Yu148165c2021-09-24 23:20:59 +08005882 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005883
Gilles Peskine449bd832023-01-11 14:50:10 +01005884 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005885#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005886 case MBEDTLS_MD_SHA384:
5887 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5888 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005889#endif
5890
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005891#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005892 case MBEDTLS_MD_SHA256:
5893 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5894 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005895#endif
5896
Gilles Peskine449bd832023-01-11 14:50:10 +01005897 default:
5898 goto exit;
5899 }
5900
5901 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5902 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005903 goto exit;
5904 }
5905
Gilles Peskine449bd832023-01-11 14:50:10 +01005906 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5907 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005908 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005909 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005910
5911exit:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005912#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005913 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005914 (void) ssl;
5915#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005916 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005917}
Jerry Yu24c0ec32021-09-09 14:21:07 +08005918
Ronald Crone68ab4f2022-10-05 12:46:29 +02005919#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005920/* mbedtls_ssl_parse_sig_alg_ext()
5921 *
5922 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5923 * value (TLS 1.3 RFC8446):
5924 * enum {
5925 * ....
5926 * ecdsa_secp256r1_sha256( 0x0403 ),
5927 * ecdsa_secp384r1_sha384( 0x0503 ),
5928 * ecdsa_secp521r1_sha512( 0x0603 ),
5929 * ....
5930 * } SignatureScheme;
5931 *
5932 * struct {
5933 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5934 * } SignatureSchemeList;
5935 *
5936 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5937 * value (TLS 1.2 RFC5246):
5938 * enum {
5939 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5940 * sha512(6), (255)
5941 * } HashAlgorithm;
5942 *
5943 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5944 * SignatureAlgorithm;
5945 *
5946 * struct {
5947 * HashAlgorithm hash;
5948 * SignatureAlgorithm signature;
5949 * } SignatureAndHashAlgorithm;
5950 *
5951 * SignatureAndHashAlgorithm
5952 * supported_signature_algorithms<2..2^16-2>;
5953 *
5954 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5955 * generalization of the TLS 1.2 signature algorithm extension.
5956 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5957 * `SignatureScheme` field of TLS 1.3
5958 *
5959 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005960int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
5961 const unsigned char *buf,
5962 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02005963{
5964 const unsigned char *p = buf;
5965 size_t supported_sig_algs_len = 0;
5966 const unsigned char *supported_sig_algs_end;
5967 uint16_t sig_alg;
5968 uint32_t common_idx = 0;
5969
Gilles Peskine449bd832023-01-11 14:50:10 +01005970 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
5971 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005972 p += 2;
5973
Gilles Peskine449bd832023-01-11 14:50:10 +01005974 memset(ssl->handshake->received_sig_algs, 0,
5975 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02005976
Gilles Peskine449bd832023-01-11 14:50:10 +01005977 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02005978 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005979 while (p < supported_sig_algs_end) {
5980 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
5981 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02005982 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005983 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
5984 sig_alg,
5985 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08005986#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005987 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
5988 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
5989 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005990 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08005991 }
5992#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02005993
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
5995 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02005996
Gilles Peskine449bd832023-01-11 14:50:10 +01005997 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02005998 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
5999 common_idx += 1;
6000 }
6001 }
6002 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006003 if (p != end) {
6004 MBEDTLS_SSL_DEBUG_MSG(1,
6005 ("Signature algorithms extension length misaligned"));
6006 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6007 MBEDTLS_ERR_SSL_DECODE_ERROR);
6008 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006009 }
6010
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 if (common_idx == 0) {
6012 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6013 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6014 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6015 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006016 }
6017
Gabor Mezei15b95a62022-05-09 16:37:58 +02006018 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006019 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006020}
6021
Ronald Crone68ab4f2022-10-05 12:46:29 +02006022#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006023
Jerry Yudc7bd172022-02-17 13:44:15 +08006024#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6025
Jerry Yudc7bd172022-02-17 13:44:15 +08006026
Gilles Peskine449bd832023-01-11 14:50:10 +01006027static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6028 mbedtls_svc_key_id_t key,
6029 psa_algorithm_t alg,
6030 const unsigned char *raw_psk, size_t raw_psk_length,
6031 const unsigned char *seed, size_t seed_length,
6032 const unsigned char *label, size_t label_length,
6033 const unsigned char *other_secret,
6034 size_t other_secret_length,
6035 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006036{
6037 psa_status_t status;
6038
Gilles Peskine449bd832023-01-11 14:50:10 +01006039 status = psa_key_derivation_setup(derivation, alg);
6040 if (status != PSA_SUCCESS) {
6041 return status;
6042 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006043
Gilles Peskine449bd832023-01-11 14:50:10 +01006044 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6045 status = psa_key_derivation_input_bytes(derivation,
6046 PSA_KEY_DERIVATION_INPUT_SEED,
6047 seed, seed_length);
6048 if (status != PSA_SUCCESS) {
6049 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006050 }
6051
Gilles Peskine449bd832023-01-11 14:50:10 +01006052 if (other_secret != NULL) {
6053 status = psa_key_derivation_input_bytes(derivation,
6054 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6055 other_secret, other_secret_length);
6056 if (status != PSA_SUCCESS) {
6057 return status;
6058 }
6059 }
6060
6061 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006062 status = psa_key_derivation_input_bytes(
6063 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006064 raw_psk, raw_psk_length);
6065 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006066 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006067 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006068 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006069 if (status != PSA_SUCCESS) {
6070 return status;
6071 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006072
Gilles Peskine449bd832023-01-11 14:50:10 +01006073 status = psa_key_derivation_input_bytes(derivation,
6074 PSA_KEY_DERIVATION_INPUT_LABEL,
6075 label, label_length);
6076 if (status != PSA_SUCCESS) {
6077 return status;
6078 }
6079 } else {
6080 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006081 }
6082
Gilles Peskine449bd832023-01-11 14:50:10 +01006083 status = psa_key_derivation_set_capacity(derivation, capacity);
6084 if (status != PSA_SUCCESS) {
6085 return status;
6086 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006087
Gilles Peskine449bd832023-01-11 14:50:10 +01006088 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006089}
6090
Andrzej Kurek57d10632022-10-24 10:32:01 -04006091#if defined(PSA_WANT_ALG_SHA_384) || \
6092 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006093MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006094static int tls_prf_generic(mbedtls_md_type_t md_type,
6095 const unsigned char *secret, size_t slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006096 const char *label, size_t label_len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 const unsigned char *random, size_t rlen,
6098 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006099{
6100 psa_status_t status;
6101 psa_algorithm_t alg;
6102 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6103 psa_key_derivation_operation_t derivation =
6104 PSA_KEY_DERIVATION_OPERATION_INIT;
6105
Gilles Peskine449bd832023-01-11 14:50:10 +01006106 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006107 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006108 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006109 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006111
6112 /* Normally a "secret" should be long enough to be impossible to
6113 * find by brute force, and in particular should not be empty. But
6114 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6115 * and for this use case it makes sense to have a 0-length "secret".
6116 * Since the key API doesn't allow importing a key of length 0,
6117 * keep master_key=0, which setup_psa_key_derivation() understands
6118 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006119 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006120 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006121 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6122 psa_set_key_algorithm(&key_attributes, alg);
6123 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006124
Gilles Peskine449bd832023-01-11 14:50:10 +01006125 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6126 if (status != PSA_SUCCESS) {
6127 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6128 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006129 }
6130
Gilles Peskine449bd832023-01-11 14:50:10 +01006131 status = setup_psa_key_derivation(&derivation,
6132 master_key, alg,
6133 NULL, 0,
6134 random, rlen,
6135 (unsigned char const *) label,
Max Fillingerf2dda152024-10-23 15:47:23 +02006136 label_len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006137 NULL, 0,
6138 dlen);
6139 if (status != PSA_SUCCESS) {
6140 psa_key_derivation_abort(&derivation);
6141 psa_destroy_key(master_key);
6142 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006143 }
6144
Gilles Peskine449bd832023-01-11 14:50:10 +01006145 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6146 if (status != PSA_SUCCESS) {
6147 psa_key_derivation_abort(&derivation);
6148 psa_destroy_key(master_key);
6149 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006150 }
6151
Gilles Peskine449bd832023-01-11 14:50:10 +01006152 status = psa_key_derivation_abort(&derivation);
6153 if (status != PSA_SUCCESS) {
6154 psa_destroy_key(master_key);
6155 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006156 }
6157
Gilles Peskine449bd832023-01-11 14:50:10 +01006158 if (!mbedtls_svc_key_id_is_null(master_key)) {
6159 status = psa_destroy_key(master_key);
6160 }
6161 if (status != PSA_SUCCESS) {
6162 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6163 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006164
Gilles Peskine449bd832023-01-11 14:50:10 +01006165 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006166}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006167#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006168
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006169#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006170MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006171static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6172 const char *label,
6173 const unsigned char *random, size_t rlen,
6174 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006175{
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006177 label, strlen(label), random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006178}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006179#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006180
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006181#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006182MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006183static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6184 const char *label,
6185 const unsigned char *random, size_t rlen,
6186 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006187{
Gilles Peskine449bd832023-01-11 14:50:10 +01006188 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006189 label, strlen(label), random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006190}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006191#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006192
Jerry Yuf009d862022-02-17 14:01:37 +08006193/*
6194 * Set appropriate PRF function and other SSL / TLS1.2 functions
6195 *
6196 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006197 * - hash associated with the ciphersuite (only used by TLS 1.2)
6198 *
6199 * Outputs:
6200 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6201 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006202MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006203static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6204 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006205{
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006206#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006208 handshake->tls_prf = tls_prf_sha384;
6209 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6210 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006211 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006212#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006213#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuf009d862022-02-17 14:01:37 +08006214 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006215 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006216 handshake->tls_prf = tls_prf_sha256;
6217 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6218 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6219 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006220#else
Jerry Yuf009d862022-02-17 14:01:37 +08006221 {
Jerry Yuf009d862022-02-17 14:01:37 +08006222 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006223 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006224 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006225 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006226#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006227
Gilles Peskine449bd832023-01-11 14:50:10 +01006228 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006229}
Jerry Yud6ab2352022-02-17 14:03:43 +08006230
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006231/*
6232 * Compute master secret if needed
6233 *
6234 * Parameters:
6235 * [in/out] handshake
6236 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6237 * (PSA-PSK) ciphersuite_info, psk_opaque
6238 * [out] premaster (cleared)
6239 * [out] master
6240 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6241 * debug: conf->f_dbg, conf->p_dbg
6242 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006243 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006244 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006245MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006246static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6247 unsigned char *master,
6248 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006249{
6250 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6251
6252 /* cf. RFC 5246, Section 8.1:
6253 * "The master secret is always exactly 48 bytes in length." */
6254 size_t const master_secret_len = 48;
6255
6256#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6257 unsigned char session_hash[48];
6258#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6259
6260 /* The label for the KDF used for key expansion.
6261 * This is either "master secret" or "extended master secret"
6262 * depending on whether the Extended Master Secret extension
6263 * is used. */
6264 char const *lbl = "master secret";
6265
Przemek Stekielae4ed302022-04-05 17:15:55 +02006266 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006267 * - If the Extended Master Secret extension is not used,
6268 * this is ClientHello.Random + ServerHello.Random
6269 * (see Sect. 8.1 in RFC 5246).
6270 * - If the Extended Master Secret extension is used,
6271 * this is the transcript of the handshake so far.
6272 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006273 unsigned char const *seed = handshake->randbytes;
6274 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006275
6276#if !defined(MBEDTLS_DEBUG_C) && \
6277 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006278 !defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006279 ssl = NULL; /* make sure we don't use it except for those cases */
6280 (void) ssl;
6281#endif
6282
Gilles Peskine449bd832023-01-11 14:50:10 +01006283 if (handshake->resume != 0) {
6284 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6285 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006286 }
6287
6288#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006289 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006290 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006291 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006292 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6293 if (ret != 0) {
6294 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6295 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006296
Gilles Peskine449bd832023-01-11 14:50:10 +01006297 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6298 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006299 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006300#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006301
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006302#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006303 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006304 /* Perform PSK-to-MS expansion in a single step. */
6305 psa_status_t status;
6306 psa_algorithm_t alg;
6307 mbedtls_svc_key_id_t psk;
6308 psa_key_derivation_operation_t derivation =
6309 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006310 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006311
Gilles Peskine449bd832023-01-11 14:50:10 +01006312 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006313
Gilles Peskine449bd832023-01-11 14:50:10 +01006314 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006315
Gilles Peskine449bd832023-01-11 14:50:10 +01006316 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006317 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006318 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006319 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006320 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006321
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006322 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006324
Gilles Peskine449bd832023-01-11 14:50:10 +01006325 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006326 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006327 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006328 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006329 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006330 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
6331 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6332 other_secret = handshake->premaster + 2;
6333 break;
6334 default:
6335 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006336 }
6337
Gilles Peskine449bd832023-01-11 14:50:10 +01006338 status = setup_psa_key_derivation(&derivation, psk, alg,
6339 ssl->conf->psk, ssl->conf->psk_len,
6340 seed, seed_len,
6341 (unsigned char const *) lbl,
6342 (size_t) strlen(lbl),
6343 other_secret, other_secret_len,
6344 master_secret_len);
6345 if (status != PSA_SUCCESS) {
6346 psa_key_derivation_abort(&derivation);
6347 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006348 }
6349
Gilles Peskine449bd832023-01-11 14:50:10 +01006350 status = psa_key_derivation_output_bytes(&derivation,
6351 master,
6352 master_secret_len);
6353 if (status != PSA_SUCCESS) {
6354 psa_key_derivation_abort(&derivation);
6355 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006356 }
6357
Gilles Peskine449bd832023-01-11 14:50:10 +01006358 status = psa_key_derivation_abort(&derivation);
6359 if (status != PSA_SUCCESS) {
6360 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6361 }
6362 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006363#endif
6364 {
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006365#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006366 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006367 psa_status_t status;
6368 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6369 psa_key_derivation_operation_t derivation =
6370 PSA_KEY_DERIVATION_OPERATION_INIT;
6371
Gilles Peskine449bd832023-01-11 14:50:10 +01006372 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006373
6374 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6375
Gilles Peskine449bd832023-01-11 14:50:10 +01006376 status = psa_key_derivation_setup(&derivation, alg);
6377 if (status != PSA_SUCCESS) {
6378 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006379 }
6380
Gilles Peskine449bd832023-01-11 14:50:10 +01006381 status = psa_key_derivation_set_capacity(&derivation,
6382 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6383 if (status != PSA_SUCCESS) {
6384 psa_key_derivation_abort(&derivation);
6385 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006386 }
6387
Gilles Peskine449bd832023-01-11 14:50:10 +01006388 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6389 &derivation);
6390 if (status != PSA_SUCCESS) {
6391 psa_key_derivation_abort(&derivation);
6392 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006393 }
6394
Gilles Peskine449bd832023-01-11 14:50:10 +01006395 status = psa_key_derivation_output_bytes(&derivation,
6396 handshake->premaster,
6397 handshake->pmslen);
6398 if (status != PSA_SUCCESS) {
6399 psa_key_derivation_abort(&derivation);
6400 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6401 }
6402
6403 status = psa_key_derivation_abort(&derivation);
6404 if (status != PSA_SUCCESS) {
6405 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006406 }
6407 }
6408#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006409 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6410 lbl, seed, seed_len,
6411 master,
6412 master_secret_len);
6413 if (ret != 0) {
6414 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6415 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006416 }
6417
Gilles Peskine449bd832023-01-11 14:50:10 +01006418 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6419 handshake->premaster,
6420 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006421
Gilles Peskine449bd832023-01-11 14:50:10 +01006422 mbedtls_platform_zeroize(handshake->premaster,
6423 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006424 }
6425
Gilles Peskine449bd832023-01-11 14:50:10 +01006426 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006427}
6428
Gilles Peskine449bd832023-01-11 14:50:10 +01006429int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006430{
6431 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6432 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6433 ssl->handshake->ciphersuite_info;
6434
Gilles Peskine449bd832023-01-11 14:50:10 +01006435 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006436
6437 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006439 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006440 if (ret != 0) {
6441 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6442 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006443 }
6444
6445 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006446 ret = ssl_compute_master(ssl->handshake,
6447 ssl->session_negotiate->master,
6448 ssl);
6449 if (ret != 0) {
6450 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6451 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006452 }
6453
6454 /* Swap the client and server random values:
6455 * - MS derivation wanted client+server (RFC 5246 8.1)
6456 * - key derivation wants server+client (RFC 5246 6.3) */
6457 {
6458 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006459 memcpy(tmp, ssl->handshake->randbytes, 64);
6460 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6461 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6462 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006463 }
6464
6465 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006466 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6467 ssl->session_negotiate->ciphersuite,
6468 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006469#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006470 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006471#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006472 ssl->handshake->tls_prf,
6473 ssl->handshake->randbytes,
6474 ssl->tls_version,
6475 ssl->conf->endpoint,
6476 ssl);
6477 if (ret != 0) {
6478 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6479 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006480 }
6481
6482 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006483 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6484 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006485
Gilles Peskine449bd832023-01-11 14:50:10 +01006486 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006487
Gilles Peskine449bd832023-01-11 14:50:10 +01006488 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006489}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006490
Gilles Peskine449bd832023-01-11 14:50:10 +01006491int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006492{
Gilles Peskine449bd832023-01-11 14:50:10 +01006493 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006494#if defined(PSA_WANT_ALG_SHA_384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006495 case MBEDTLS_SSL_HASH_SHA384:
6496 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6497 break;
6498#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006499#if defined(PSA_WANT_ALG_SHA_256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006500 case MBEDTLS_SSL_HASH_SHA256:
6501 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6502 break;
6503#endif
6504 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006505 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006506 }
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006507#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006508 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006509 (void) ssl;
6510#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006511 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006512}
6513
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006514static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6515 const psa_hash_operation_t *hs_op,
6516 size_t buffer_size,
6517 unsigned char *hash,
6518 size_t *hlen)
6519{
6520 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006521 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006522
6523#if !defined(MBEDTLS_DEBUG_C)
6524 (void) ssl;
6525#endif
6526 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006527 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006528 if (status != PSA_SUCCESS) {
6529 goto exit;
6530 }
6531
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006532 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006533 if (status != PSA_SUCCESS) {
6534 goto exit;
6535 }
6536
6537 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6538 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6539
6540exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006541 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006542 return mbedtls_md_error_from_psa(status);
6543}
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006544
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006545#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006546int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6547 unsigned char *hash,
6548 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006549{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006550 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6551 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006552}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006553#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006554
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006555#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006556int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6557 unsigned char *hash,
6558 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006559{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006560 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6561 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006562}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006563#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006564
Jerry Yuc2c673d2022-02-17 14:20:39 +08006565#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006566MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006567static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006568
6569#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006570int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006571{
6572 /* If renegotiation is not enforced, retransmit until we would reach max
6573 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006574 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006575 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6576 unsigned char doublings = 1;
6577
Gilles Peskine449bd832023-01-11 14:50:10 +01006578 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006579 ++doublings;
6580 ratio >>= 1;
6581 }
6582
Gilles Peskine449bd832023-01-11 14:50:10 +01006583 if (++ssl->renego_records_seen > doublings) {
6584 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6585 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006586 }
6587 }
6588
Gilles Peskine449bd832023-01-11 14:50:10 +01006589 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006590}
6591#endif
6592#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006593
Jerry Yud9526692022-02-17 14:23:47 +08006594/*
6595 * Handshake functions
6596 */
6597#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6598/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006599int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006600{
6601 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6602 ssl->handshake->ciphersuite_info;
6603
Gilles Peskine449bd832023-01-11 14:50:10 +01006604 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006605
Gilles Peskine449bd832023-01-11 14:50:10 +01006606 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6607 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006608 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006609 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006610 }
6611
Gilles Peskine449bd832023-01-11 14:50:10 +01006612 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6613 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006614}
6615
Gilles Peskine449bd832023-01-11 14:50:10 +01006616int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006617{
6618 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6619 ssl->handshake->ciphersuite_info;
6620
Gilles Peskine449bd832023-01-11 14:50:10 +01006621 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006622
Gilles Peskine449bd832023-01-11 14:50:10 +01006623 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6624 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006625 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006626 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006627 }
6628
Gilles Peskine449bd832023-01-11 14:50:10 +01006629 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6630 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006631}
6632
6633#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6634/* Some certificate support -> implement write and parse */
6635
Gilles Peskine449bd832023-01-11 14:50:10 +01006636int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006637{
6638 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6639 size_t i, n;
6640 const mbedtls_x509_crt *crt;
6641 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6642 ssl->handshake->ciphersuite_info;
6643
Gilles Peskine449bd832023-01-11 14:50:10 +01006644 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006645
Gilles Peskine449bd832023-01-11 14:50:10 +01006646 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6647 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006648 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006649 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006650 }
6651
6652#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006653 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6654 if (ssl->handshake->client_auth == 0) {
6655 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006656 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006657 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006658 }
6659 }
6660#endif /* MBEDTLS_SSL_CLI_C */
6661#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006662 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6663 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006664 /* Should never happen because we shouldn't have picked the
6665 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006666 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006667 }
6668 }
6669#endif
6670
Gilles Peskine449bd832023-01-11 14:50:10 +01006671 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006672
6673 /*
6674 * 0 . 0 handshake type
6675 * 1 . 3 handshake length
6676 * 4 . 6 length of all certs
6677 * 7 . 9 length of cert. 1
6678 * 10 . n-1 peer certificate
6679 * n . n+2 length of cert. 2
6680 * n+3 . ... upper level cert, etc.
6681 */
6682 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006683 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006684
Gilles Peskine449bd832023-01-11 14:50:10 +01006685 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006686 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006687 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6688 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6689 " > %" MBEDTLS_PRINTF_SIZET,
6690 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6691 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006692 }
6693
Gilles Peskine449bd832023-01-11 14:50:10 +01006694 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6695 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6696 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006697
Gilles Peskine449bd832023-01-11 14:50:10 +01006698 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006699 i += n; crt = crt->next;
6700 }
6701
Gilles Peskine449bd832023-01-11 14:50:10 +01006702 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6703 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6704 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006705
6706 ssl->out_msglen = i;
6707 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6708 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6709
Gilles Peskinef670ba52025-03-07 15:09:32 +01006710 mbedtls_ssl_handshake_increment_state(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006711
Gilles Peskine449bd832023-01-11 14:50:10 +01006712 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
6713 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
6714 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006715 }
6716
Gilles Peskine449bd832023-01-11 14:50:10 +01006717 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006718
Gilles Peskine449bd832023-01-11 14:50:10 +01006719 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006720}
6721
6722#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6723
6724#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006725MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006726static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6727 unsigned char *crt_buf,
6728 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006729{
6730 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6731
Gilles Peskine449bd832023-01-11 14:50:10 +01006732 if (peer_crt == NULL) {
6733 return -1;
6734 }
Jerry Yud9526692022-02-17 14:23:47 +08006735
Gilles Peskine449bd832023-01-11 14:50:10 +01006736 if (peer_crt->raw.len != crt_buf_len) {
6737 return -1;
6738 }
Jerry Yud9526692022-02-17 14:23:47 +08006739
Gilles Peskine449bd832023-01-11 14:50:10 +01006740 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08006741}
6742#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006743MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006744static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6745 unsigned char *crt_buf,
6746 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006747{
6748 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6749 unsigned char const * const peer_cert_digest =
6750 ssl->session->peer_cert_digest;
6751 mbedtls_md_type_t const peer_cert_digest_type =
6752 ssl->session->peer_cert_digest_type;
6753 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01006754 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08006755 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6756 size_t digest_len;
6757
Gilles Peskine449bd832023-01-11 14:50:10 +01006758 if (peer_cert_digest == NULL || digest_info == NULL) {
6759 return -1;
6760 }
Jerry Yud9526692022-02-17 14:23:47 +08006761
Gilles Peskine449bd832023-01-11 14:50:10 +01006762 digest_len = mbedtls_md_get_size(digest_info);
6763 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
6764 return -1;
6765 }
Jerry Yud9526692022-02-17 14:23:47 +08006766
Gilles Peskine449bd832023-01-11 14:50:10 +01006767 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
6768 if (ret != 0) {
6769 return -1;
6770 }
Jerry Yud9526692022-02-17 14:23:47 +08006771
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08006773}
6774#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6775#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6776
6777/*
6778 * Once the certificate message is read, parse it into a cert chain and
6779 * perform basic checks, but leave actual verification to the caller
6780 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006781MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006782static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
6783 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08006784{
6785 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6786#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006787 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08006788#endif
6789 size_t i, n;
6790 uint8_t alert;
6791
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
6793 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6794 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6795 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6796 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006797 }
6798
Gilles Peskine449bd832023-01-11 14:50:10 +01006799 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
6800 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6801 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6802 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006803 }
6804
Gilles Peskine449bd832023-01-11 14:50:10 +01006805 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
6806 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6807 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6808 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6809 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006810 }
6811
Gilles Peskine449bd832023-01-11 14:50:10 +01006812 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006813
6814 /*
6815 * Same message structure as in mbedtls_ssl_write_certificate()
6816 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006817 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006818
Gilles Peskine449bd832023-01-11 14:50:10 +01006819 if (ssl->in_msg[i] != 0 ||
6820 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
6821 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6822 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6823 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6824 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006825 }
6826
6827 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6828 i += 3;
6829
6830 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006831 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08006832 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006833 if (i + 3 > ssl->in_hslen) {
6834 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6835 mbedtls_ssl_send_alert_message(ssl,
6836 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6837 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6838 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006839 }
6840 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6841 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 if (ssl->in_msg[i] != 0) {
6843 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6844 mbedtls_ssl_send_alert_message(ssl,
6845 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6846 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
6847 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08006848 }
6849
6850 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006851 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006852 i += 3;
6853
Gilles Peskine449bd832023-01-11 14:50:10 +01006854 if (n < 128 || i + n > ssl->in_hslen) {
6855 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6856 mbedtls_ssl_send_alert_message(ssl,
6857 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6858 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6859 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006860 }
6861
6862 /* Check if we're handling the first CRT in the chain. */
6863#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08006865 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01006866 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08006867 /* During client-side renegotiation, check that the server's
6868 * end-CRTs hasn't changed compared to the initial handshake,
6869 * mitigating the triple handshake attack. On success, reuse
6870 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006871 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
6872 if (ssl_check_peer_crt_unchanged(ssl,
6873 &ssl->in_msg[i],
6874 n) != 0) {
6875 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
6876 mbedtls_ssl_send_alert_message(ssl,
6877 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6878 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
6879 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08006880 }
6881
6882 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006883 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08006884 }
6885#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6886
6887 /* Parse the next certificate in the chain. */
6888#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006889 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08006890#else
6891 /* If we don't need to store the CRT chain permanently, parse
6892 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006893 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08006894#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01006895 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08006896 case 0: /*ok*/
Gilles Peskine4c832212025-05-07 23:05:12 +02006897 case MBEDTLS_ERR_X509_UNKNOWN_OID:
Jerry Yud9526692022-02-17 14:23:47 +08006898 /* Ignore certificate with an unknown algorithm: maybe a
6899 prior certificate was already trusted. */
6900 break;
6901
6902 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6903 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6904 goto crt_parse_der_failed;
6905
6906 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6907 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6908 goto crt_parse_der_failed;
6909
6910 default:
6911 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006912crt_parse_der_failed:
6913 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
6914 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
6915 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006916 }
6917
6918 i += n;
6919 }
6920
Gilles Peskine449bd832023-01-11 14:50:10 +01006921 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
6922 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006923}
6924
6925#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006926MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006927static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006928{
Gilles Peskine449bd832023-01-11 14:50:10 +01006929 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6930 return -1;
6931 }
Jerry Yud9526692022-02-17 14:23:47 +08006932
Gilles Peskine449bd832023-01-11 14:50:10 +01006933 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08006934 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6935 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01006936 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
6937 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
6938 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006939 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006940 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08006941}
6942#endif /* MBEDTLS_SSL_SRV_C */
6943
6944/* Check if a certificate message is expected.
6945 * Return either
6946 * - SSL_CERTIFICATE_EXPECTED, or
6947 * - SSL_CERTIFICATE_SKIP
6948 * indicating whether a Certificate message is expected or not.
6949 */
6950#define SSL_CERTIFICATE_EXPECTED 0
6951#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006952MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006953static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
6954 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08006955{
6956 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6957 ssl->handshake->ciphersuite_info;
6958
Gilles Peskine449bd832023-01-11 14:50:10 +01006959 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6960 return SSL_CERTIFICATE_SKIP;
6961 }
Jerry Yud9526692022-02-17 14:23:47 +08006962
6963#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006964 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006965 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08006966 ssl->session_negotiate->verify_result =
6967 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01006968 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08006969 }
6970 }
6971#else
6972 ((void) authmode);
6973#endif /* MBEDTLS_SSL_SRV_C */
6974
Gilles Peskine449bd832023-01-11 14:50:10 +01006975 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08006976}
6977
Jerry Yud9526692022-02-17 14:23:47 +08006978#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006979MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006980static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
6981 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08006982{
6983 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6984 /* Remember digest of the peer's end-CRT. */
6985 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01006986 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
6987 if (ssl->session_negotiate->peer_cert_digest == NULL) {
6988 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
6989 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
6990 mbedtls_ssl_send_alert_message(ssl,
6991 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6992 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08006993
Gilles Peskine449bd832023-01-11 14:50:10 +01006994 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08006995 }
6996
Gilles Peskine449bd832023-01-11 14:50:10 +01006997 ret = mbedtls_md(mbedtls_md_info_from_type(
6998 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
6999 start, len,
7000 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007001
7002 ssl->session_negotiate->peer_cert_digest_type =
7003 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7004 ssl->session_negotiate->peer_cert_digest_len =
7005 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7006
Gilles Peskine449bd832023-01-11 14:50:10 +01007007 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007008}
7009
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007010MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007011static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7012 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007013{
7014 unsigned char *end = start + len;
7015 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7016
7017 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007018 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7019 ret = mbedtls_pk_parse_subpubkey(&start, end,
7020 &ssl->handshake->peer_pubkey);
7021 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007022 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007023 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007024 }
7025
Gilles Peskine449bd832023-01-11 14:50:10 +01007026 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007027}
7028#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7029
Gilles Peskine449bd832023-01-11 14:50:10 +01007030int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007031{
7032 int ret = 0;
7033 int crt_expected;
Manuel Pégourié-Gonnard58ab9ba2024-08-14 09:47:38 +02007034 /* Authmode: precedence order is SNI if used else configuration */
Jerry Yud9526692022-02-17 14:23:47 +08007035#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7036 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7037 ? ssl->handshake->sni_authmode
7038 : ssl->conf->authmode;
7039#else
7040 const int authmode = ssl->conf->authmode;
7041#endif
7042 void *rs_ctx = NULL;
7043 mbedtls_x509_crt *chain = NULL;
7044
Gilles Peskine449bd832023-01-11 14:50:10 +01007045 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007046
Gilles Peskine449bd832023-01-11 14:50:10 +01007047 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7048 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7049 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007050 goto exit;
7051 }
7052
7053#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007054 if (ssl->handshake->ecrs_enabled &&
7055 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007056 chain = ssl->handshake->ecrs_peer_cert;
7057 ssl->handshake->ecrs_peer_cert = NULL;
7058 goto crt_verify;
7059 }
7060#endif
7061
Gilles Peskine449bd832023-01-11 14:50:10 +01007062 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007063 /* mbedtls_ssl_read_record may have sent an alert already. We
7064 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007065 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007066 goto exit;
7067 }
7068
7069#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007070 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007071 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7072
Gilles Peskine449bd832023-01-11 14:50:10 +01007073 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007074 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007075 }
Jerry Yud9526692022-02-17 14:23:47 +08007076
7077 goto exit;
7078 }
7079#endif /* MBEDTLS_SSL_SRV_C */
7080
7081 /* Clear existing peer CRT structure in case we tried to
7082 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007083 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007084
Gilles Peskine449bd832023-01-11 14:50:10 +01007085 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7086 if (chain == NULL) {
7087 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7088 sizeof(mbedtls_x509_crt)));
7089 mbedtls_ssl_send_alert_message(ssl,
7090 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7091 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007092
7093 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7094 goto exit;
7095 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007096 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007097
Gilles Peskine449bd832023-01-11 14:50:10 +01007098 ret = ssl_parse_certificate_chain(ssl, chain);
7099 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007100 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007101 }
Jerry Yud9526692022-02-17 14:23:47 +08007102
7103#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007104 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007105 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007106 }
Jerry Yud9526692022-02-17 14:23:47 +08007107
7108crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007109 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007110 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007111 }
Jerry Yud9526692022-02-17 14:23:47 +08007112#endif
7113
Manuel Pégourié-Gonnard19dd9f52024-08-16 11:03:42 +02007114 ret = mbedtls_ssl_verify_certificate(ssl, authmode, chain,
7115 ssl->handshake->ciphersuite_info,
7116 rs_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +01007117 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007118 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007119 }
Jerry Yud9526692022-02-17 14:23:47 +08007120
7121#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7122 {
7123 unsigned char *crt_start, *pk_start;
7124 size_t crt_len, pk_len;
7125
7126 /* We parse the CRT chain without copying, so
7127 * these pointers point into the input buffer,
7128 * and are hence still valid after freeing the
7129 * CRT chain. */
7130
7131 crt_start = chain->raw.p;
7132 crt_len = chain->raw.len;
7133
7134 pk_start = chain->pk_raw.p;
7135 pk_len = chain->pk_raw.len;
7136
7137 /* Free the CRT structures before computing
7138 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007139 mbedtls_x509_crt_free(chain);
7140 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007141 chain = NULL;
7142
Gilles Peskine449bd832023-01-11 14:50:10 +01007143 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7144 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007145 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007146 }
Jerry Yud9526692022-02-17 14:23:47 +08007147
Gilles Peskine449bd832023-01-11 14:50:10 +01007148 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7149 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007150 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007151 }
Jerry Yud9526692022-02-17 14:23:47 +08007152 }
7153#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7154 /* Pass ownership to session structure. */
7155 ssl->session_negotiate->peer_cert = chain;
7156 chain = NULL;
7157#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7158
Gilles Peskine449bd832023-01-11 14:50:10 +01007159 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007160
7161exit:
7162
Gilles Peskine449bd832023-01-11 14:50:10 +01007163 if (ret == 0) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007164 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007165 }
Jerry Yud9526692022-02-17 14:23:47 +08007166
7167#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007168 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007169 ssl->handshake->ecrs_peer_cert = chain;
7170 chain = NULL;
7171 }
7172#endif
7173
Gilles Peskine449bd832023-01-11 14:50:10 +01007174 if (chain != NULL) {
7175 mbedtls_x509_crt_free(chain);
7176 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007177 }
7178
Gilles Peskine449bd832023-01-11 14:50:10 +01007179 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007180}
7181#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7182
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007183static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7184 unsigned char *padbuf, size_t hlen,
7185 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007186{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007187 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007188 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007189 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007190 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007191 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007192 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007193
7194 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007195 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007196 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007198
Gilles Peskine449bd832023-01-11 14:50:10 +01007199 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007200 ? "client finished"
7201 : "server finished";
7202
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007203 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007204
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007205 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007206 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007207 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007208 }
7209
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007210 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007212 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007213 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007214 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007215
7216 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7217
Jerry Yu615bd6f2022-02-17 14:25:15 +08007218 /*
7219 * TLSv1.2:
7220 * hash = PRF( master, finished_label,
7221 * Hash( handshake ) )[0.11]
7222 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007223 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007224 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007225
Gilles Peskine449bd832023-01-11 14:50:10 +01007226 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007227
Paul Elliottecb95be2023-08-11 16:41:04 +01007228 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007229
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007230 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007231
7232exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007233 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007234 return mbedtls_md_error_from_psa(status);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007235}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007236
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007237#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007238static int ssl_calc_finished_tls_sha256(
7239 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7240{
7241 unsigned char padbuf[32];
7242 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007243 &ssl->handshake->fin_sha256_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007244 padbuf, sizeof(padbuf),
7245 buf, from);
7246}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007247#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007248
Jerry Yub7ba49e2022-02-17 14:25:53 +08007249
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007250#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007251static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007252 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007253{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007254 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007255 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007256 &ssl->handshake->fin_sha384_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007257 padbuf, sizeof(padbuf),
7258 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007259}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007260#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007261
Gilles Peskine449bd832023-01-11 14:50:10 +01007262void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007263{
Gilles Peskine449bd832023-01-11 14:50:10 +01007264 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007265
7266 /*
7267 * Free our handshake params
7268 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007269 mbedtls_ssl_handshake_free(ssl);
7270 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007271 ssl->handshake = NULL;
7272
7273 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007274 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007275 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007276 if (ssl->transform) {
7277 mbedtls_ssl_transform_free(ssl->transform);
7278 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007279 }
7280 ssl->transform = ssl->transform_negotiate;
7281 ssl->transform_negotiate = NULL;
7282
Gilles Peskine449bd832023-01-11 14:50:10 +01007283 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007284}
7285
Gilles Peskine449bd832023-01-11 14:50:10 +01007286void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007287{
7288 int resume = ssl->handshake->resume;
7289
Gilles Peskine449bd832023-01-11 14:50:10 +01007290 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007291
7292#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007293 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007294 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7295 ssl->renego_records_seen = 0;
7296 }
7297#endif
7298
7299 /*
7300 * Free the previous session and switch in the current one
7301 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007302 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007303#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7304 /* RFC 7366 3.1: keep the EtM state */
7305 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007306 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007307#endif
7308
Gilles Peskine449bd832023-01-11 14:50:10 +01007309 mbedtls_ssl_session_free(ssl->session);
7310 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007311 }
7312 ssl->session = ssl->session_negotiate;
7313 ssl->session_negotiate = NULL;
7314
7315 /*
7316 * Add cache entry
7317 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007318 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007319 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007320 resume == 0) {
7321 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7322 ssl->session->id,
7323 ssl->session->id_len,
7324 ssl->session) != 0) {
7325 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7326 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007327 }
7328
7329#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007330 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7331 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007332 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007333 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007334
7335 /* Keep last flight around in case we need to resend it:
7336 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007337 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7338 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007339#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007340 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007341
Gilles Peskinef670ba52025-03-07 15:09:32 +01007342 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007343
Gilles Peskine449bd832023-01-11 14:50:10 +01007344 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007345}
7346
Gilles Peskine449bd832023-01-11 14:50:10 +01007347int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007348{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007349 int ret;
7350 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007351
Gilles Peskine449bd832023-01-11 14:50:10 +01007352 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007353
Gilles Peskine449bd832023-01-11 14:50:10 +01007354 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007355
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007356 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7357 if (ret != 0) {
7358 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
David Horstmann816b7122025-03-07 17:20:59 +00007359 return ret;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007360 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007361
7362 /*
7363 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7364 * may define some other value. Currently (early 2016), no defined
7365 * ciphersuite does this (and this is unlikely to change as activity has
7366 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7367 */
7368 hash_len = 12;
7369
7370#if defined(MBEDTLS_SSL_RENEGOTIATION)
7371 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007372 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007373#endif
7374
7375 ssl->out_msglen = 4 + hash_len;
7376 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7377 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7378
7379 /*
7380 * In case of session resuming, invert the client and server
7381 * ChangeCipherSpec messages order.
7382 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007383 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007384#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007385 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007386 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
Gilles Peskine449bd832023-01-11 14:50:10 +01007387 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007388#endif
7389#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007390 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007391 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC);
Gilles Peskine449bd832023-01-11 14:50:10 +01007392 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007393#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007394 } else {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007395 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007396 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007397
7398 /*
7399 * Switch to our negotiated transform and session parameters for outbound
7400 * data.
7401 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007402 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007403
7404#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007405 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007406 unsigned char i;
7407
7408 /* Remember current epoch settings for resending */
7409 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007410 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7411 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007412
7413 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007414 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007415
7416
7417 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007418 for (i = 2; i > 0; i--) {
7419 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007420 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007421 }
7422 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007423
7424 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 if (i == 0) {
7426 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7427 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007428 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007429 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007430#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007431 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007432
7433 ssl->transform_out = ssl->transform_negotiate;
7434 ssl->session_out = ssl->session_negotiate;
7435
7436#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007437 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7438 mbedtls_ssl_send_flight_completed(ssl);
7439 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007440#endif
7441
Gilles Peskine449bd832023-01-11 14:50:10 +01007442 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7443 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7444 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007445 }
7446
7447#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007448 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7449 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7450 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7451 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007452 }
7453#endif
7454
Gilles Peskine449bd832023-01-11 14:50:10 +01007455 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007456
Gilles Peskine449bd832023-01-11 14:50:10 +01007457 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007458}
7459
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007460#define SSL_MAX_HASH_LEN 12
7461
Gilles Peskine449bd832023-01-11 14:50:10 +01007462int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007463{
7464 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7465 unsigned int hash_len = 12;
7466 unsigned char buf[SSL_MAX_HASH_LEN];
7467
Gilles Peskine449bd832023-01-11 14:50:10 +01007468 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007469
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007470 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7471 if (ret != 0) {
7472 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
David Horstmann816b7122025-03-07 17:20:59 +00007473 return ret;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007474 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007475
Gilles Peskine449bd832023-01-11 14:50:10 +01007476 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7477 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007478 goto exit;
7479 }
7480
Gilles Peskine449bd832023-01-11 14:50:10 +01007481 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7482 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7483 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7484 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007485 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7486 goto exit;
7487 }
7488
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
7490 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7491 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007492 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7493 goto exit;
7494 }
7495
Gilles Peskine449bd832023-01-11 14:50:10 +01007496 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
7497 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7498 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7499 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007500 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7501 goto exit;
7502 }
7503
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
7505 buf, hash_len) != 0) {
7506 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7507 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7508 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007509 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7510 goto exit;
7511 }
7512
7513#if defined(MBEDTLS_SSL_RENEGOTIATION)
7514 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007515 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007516#endif
7517
Gilles Peskine449bd832023-01-11 14:50:10 +01007518 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007519#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007520 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007521 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC);
Gilles Peskine449bd832023-01-11 14:50:10 +01007522 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007523#endif
7524#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007525 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007526 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
Gilles Peskine449bd832023-01-11 14:50:10 +01007527 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007528#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007529 } else {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007530 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007532
7533#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007534 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7535 mbedtls_ssl_recv_flight_completed(ssl);
7536 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007537#endif
7538
Gilles Peskine449bd832023-01-11 14:50:10 +01007539 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007540
7541exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007542 mbedtls_platform_zeroize(buf, hash_len);
7543 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007544}
7545
Jerry Yu392112c2022-02-17 14:34:10 +08007546#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7547/*
7548 * Helper to get TLS 1.2 PRF from ciphersuite
7549 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7550 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007551static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08007552{
Jerry Yu392112c2022-02-17 14:34:10 +08007553 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007554 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007555#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007556 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
7557 return tls_prf_sha384;
7558 } else
Jerry Yu392112c2022-02-17 14:34:10 +08007559#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007560#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007561 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007562 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
7563 return tls_prf_sha256;
7564 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04007565 }
7566#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007567#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007568 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007569 (void) ciphersuite_info;
7570#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007571
Gilles Peskine449bd832023-01-11 14:50:10 +01007572 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08007573}
7574#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007575
Gilles Peskine449bd832023-01-11 14:50:10 +01007576static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007577{
7578 ((void) tls_prf);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007579#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 if (tls_prf == tls_prf_sha384) {
7581 return MBEDTLS_SSL_TLS_PRF_SHA384;
7582 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007583#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007584#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 if (tls_prf == tls_prf_sha256) {
7586 return MBEDTLS_SSL_TLS_PRF_SHA256;
7587 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007588#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007589 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08007590}
7591
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007592/*
7593 * Populate a transform structure with session keys and all the other
7594 * necessary information.
7595 *
7596 * Parameters:
7597 * - [in/out]: transform: structure to populate
7598 * [in] must be just initialised with mbedtls_ssl_transform_init()
7599 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7600 * - [in] ciphersuite
7601 * - [in] master
7602 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007603 * - [in] tls_prf: pointer to PRF to use for key derivation
7604 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007605 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007606 * - [in] endpoint: client or server
7607 * - [in] ssl: used for:
7608 * - ssl->conf->{f,p}_export_keys
7609 * [in] optionally used for:
7610 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7611 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007612MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007613static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
7614 int ciphersuite,
7615 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007616#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007617 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007618#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 ssl_tls_prf_t tls_prf,
7620 const unsigned char randbytes[64],
7621 mbedtls_ssl_protocol_version tls_version,
7622 unsigned endpoint,
7623 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007624{
7625 int ret = 0;
7626 unsigned char keyblk[256];
7627 unsigned char *key1;
7628 unsigned char *key2;
7629 unsigned char *mac_enc;
7630 unsigned char *mac_dec;
7631 size_t mac_key_len = 0;
7632 size_t iv_copy_len;
7633 size_t keylen;
7634 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007635 mbedtls_ssl_mode_t ssl_mode;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007636
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007637 psa_key_type_t key_type;
7638 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7639 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007640 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007641 size_t key_bits;
7642 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007643
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007644 /*
7645 * Some data just needs copying into the structure
7646 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007647#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007648 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007649#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007650 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007651
Max Fillinger2fe35f62024-10-25 00:52:24 +02007652#if defined(MBEDTLS_SSL_KEEP_RANDBYTES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007653 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007654#endif
7655
7656#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01007657 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007658 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7659 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007660 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007661 }
7662#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7663
7664 /*
7665 * Get various info structures
7666 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007667 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
7668 if (ciphersuite_info == NULL) {
7669 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
7670 ciphersuite));
7671 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007672 }
7673
Neil Armstrongab555e02022-04-04 11:07:59 +02007674 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007675#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007676 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007677#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007678 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007679
Gilles Peskine449bd832023-01-11 14:50:10 +01007680 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007681 transform->taglen =
7682 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01007683 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007684
Dave Rodgman2eab4622023-10-05 13:30:37 +01007685 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 transform->taglen,
7687 &alg,
7688 &key_type,
7689 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007690 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007691 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007692 goto end;
7693 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007694
Dave Rodgman2eab4622023-10-05 13:30:37 +01007695 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007696 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02007697 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01007698 (unsigned) ciphersuite_info->mac));
7699 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01007700 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007701
7702#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7703 /* Copy own and peer's CID if the use of the CID
7704 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007705 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
7706 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007707
7708 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007709 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
7710 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
7711 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007712
7713 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007714 memcpy(transform->out_cid, ssl->handshake->peer_cid,
7715 ssl->handshake->peer_cid_len);
7716 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
7717 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007718 }
7719#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7720
7721 /*
7722 * Compute key block using the PRF
7723 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007724 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
7725 if (ret != 0) {
7726 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7727 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007728 }
7729
Gilles Peskine449bd832023-01-11 14:50:10 +01007730 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
7731 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
7732 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
7733 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
7734 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007735
7736 /*
7737 * Determine the appropriate key, IV and MAC length.
7738 */
7739
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007740 keylen = PSA_BITS_TO_BYTES(key_bits);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007741
Valerio Settie5707042023-10-11 11:54:42 +02007742#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01007743 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007744 size_t explicit_ivlen;
7745
7746 transform->maclen = 0;
7747 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007748
7749 /* All modes haves 96-bit IVs, but the length of the static parts vary
7750 * with mode and version:
7751 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7752 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7753 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7754 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7755 * sequence number).
7756 */
7757 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01007758
7759 int is_chachapoly = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007760 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
David Horstmann3b2276a2022-10-06 14:49:08 +01007761
Gilles Peskine449bd832023-01-11 14:50:10 +01007762 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007763 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01007764 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007765 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01007766 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007767
7768 /* Minimum length of encrypted record */
7769 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7770 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007771 } else
Valerio Settie5707042023-10-11 11:54:42 +02007772#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007773#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007774 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007775 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01007776 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007777 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007778
Neil Armstronge4512952022-03-08 09:08:22 +01007779 /* Get MAC length */
7780 mac_key_len = PSA_HASH_LENGTH(mac_alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007781 transform->maclen = mac_key_len;
7782
7783 /* IV length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007784 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007785
7786 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007787 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007788 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007789 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007790 /*
7791 * GenericBlockCipher:
7792 * 1. if EtM is in use: one block plus MAC
7793 * otherwise: * first multiple of blocklen greater than maclen
7794 * 2. IV
7795 */
7796#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007797 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007798 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007799 + block_size;
7800 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007801#endif
7802 {
7803 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007804 + block_size
7805 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007806 }
7807
Gilles Peskine449bd832023-01-11 14:50:10 +01007808 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007809 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007810 } else {
7811 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007812 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7813 goto end;
7814 }
7815 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007816 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007817#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7818 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007819 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7820 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007821 }
7822
Gilles Peskine449bd832023-01-11 14:50:10 +01007823 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7824 (unsigned) keylen,
7825 (unsigned) transform->minlen,
7826 (unsigned) transform->ivlen,
7827 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007828
7829 /*
7830 * Finally setup the cipher contexts, IVs and MAC secrets.
7831 */
7832#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007833 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007834 key1 = keyblk + mac_key_len * 2;
7835 key2 = keyblk + mac_key_len * 2 + keylen;
7836
7837 mac_enc = keyblk;
7838 mac_dec = keyblk + mac_key_len;
7839
Gilles Peskine449bd832023-01-11 14:50:10 +01007840 iv_copy_len = (transform->fixed_ivlen) ?
7841 transform->fixed_ivlen : transform->ivlen;
7842 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
7843 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
7844 iv_copy_len);
7845 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007846#endif /* MBEDTLS_SSL_CLI_C */
7847#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007848 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007849 key1 = keyblk + mac_key_len * 2 + keylen;
7850 key2 = keyblk + mac_key_len * 2;
7851
7852 mac_enc = keyblk + mac_key_len;
7853 mac_dec = keyblk;
7854
Gilles Peskine449bd832023-01-11 14:50:10 +01007855 iv_copy_len = (transform->fixed_ivlen) ?
7856 transform->fixed_ivlen : transform->ivlen;
7857 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
7858 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
7859 iv_copy_len);
7860 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007861#endif /* MBEDTLS_SSL_SRV_C */
7862 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007863 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007864 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7865 goto end;
7866 }
7867
Paul Elliott4fb19552023-10-18 12:15:30 +01007868 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007869 ssl->f_export_keys(ssl->p_export_keys,
7870 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7871 master, 48,
7872 randbytes + 32,
7873 randbytes,
7874 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007875 }
7876
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007877 transform->psa_alg = alg;
7878
Gilles Peskine449bd832023-01-11 14:50:10 +01007879 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
7880 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
7881 psa_set_key_algorithm(&attributes, alg);
7882 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007883
Gilles Peskine449bd832023-01-11 14:50:10 +01007884 if ((status = psa_import_key(&attributes,
7885 key1,
7886 PSA_BITS_TO_BYTES(key_bits),
7887 &transform->psa_key_enc)) != PSA_SUCCESS) {
7888 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007889 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007890 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007891 goto end;
7892 }
7893
Gilles Peskine449bd832023-01-11 14:50:10 +01007894 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007895
Gilles Peskine449bd832023-01-11 14:50:10 +01007896 if ((status = psa_import_key(&attributes,
7897 key2,
7898 PSA_BITS_TO_BYTES(key_bits),
7899 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007900 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007901 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007902 goto end;
7903 }
7904 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007905
Neil Armstrong29c0c042022-03-17 17:47:28 +01007906#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7907 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7908 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007909 if (mac_key_len != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007910 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01007911
Gilles Peskine449bd832023-01-11 14:50:10 +01007912 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
7913 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
7914 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01007915
Gilles Peskine449bd832023-01-11 14:50:10 +01007916 if ((status = psa_import_key(&attributes,
7917 mac_enc, mac_key_len,
7918 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007919 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007920 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01007921 goto end;
7922 }
7923
Gilles Peskine449bd832023-01-11 14:50:10 +01007924 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
7925 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04007926#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007927 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04007928#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007929 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01007930 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01007931 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
7932 PSA_KEY_USAGE_VERIFY_HASH);
7933 } else {
7934 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
7935 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01007936
Gilles Peskine449bd832023-01-11 14:50:10 +01007937 if ((status = psa_import_key(&attributes,
7938 mac_dec, mac_key_len,
7939 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007940 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007941 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01007942 goto end;
7943 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01007944 }
7945#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7946
7947 ((void) mac_dec);
7948 ((void) mac_enc);
7949
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007950end:
Gilles Peskine449bd832023-01-11 14:50:10 +01007951 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
7952 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007953}
7954
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01007955#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Valerio Setti6b3dab02022-11-17 17:14:54 +01007956int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01007957 psa_pake_operation_t *pake_ctx,
7958 const unsigned char *buf,
7959 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01007960{
7961 psa_status_t status;
7962 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01007963 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01007964 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
7965 * At round two perform a single cycle
7966 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007967 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01007968
Gilles Peskine449bd832023-01-11 14:50:10 +01007969 for (; remaining_steps > 0; remaining_steps--) {
7970 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01007971 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01007972 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01007973 /* Length is stored at the first byte */
7974 size_t length = buf[input_offset];
7975 input_offset += 1;
7976
Gilles Peskine449bd832023-01-11 14:50:10 +01007977 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01007978 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7979 }
7980
Gilles Peskine449bd832023-01-11 14:50:10 +01007981 status = psa_pake_input(pake_ctx, step,
7982 buf + input_offset, length);
7983 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007984 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01007985 }
7986
7987 input_offset += length;
7988 }
7989 }
7990
Gilles Peskine449bd832023-01-11 14:50:10 +01007991 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01007992 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007993 }
Valerio Setti30ebe112022-11-17 16:23:34 +01007994
Gilles Peskine449bd832023-01-11 14:50:10 +01007995 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01007996}
7997
Valerio Setti6b3dab02022-11-17 17:14:54 +01007998int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01007999 psa_pake_operation_t *pake_ctx,
8000 unsigned char *buf,
8001 size_t len, size_t *olen,
8002 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008003{
8004 psa_status_t status;
8005 size_t output_offset = 0;
8006 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008007 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008008 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8009 * At round two perform a single cycle
8010 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008011 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008012
Gilles Peskine449bd832023-01-11 14:50:10 +01008013 for (; remaining_steps > 0; remaining_steps--) {
8014 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8015 step <= PSA_PAKE_STEP_ZK_PROOF;
8016 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008017 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008018 * For each step, prepend 1 byte with the length of the data as
8019 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008020 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008021 status = psa_pake_output(pake_ctx, step,
8022 buf + output_offset + 1,
8023 len - output_offset - 1,
8024 &output_len);
8025 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008026 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008027 }
8028
Valerio Setti99d88c12022-11-22 16:03:43 +01008029 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008030
8031 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008032 }
8033 }
8034
8035 *olen = output_offset;
8036
Gilles Peskine449bd832023-01-11 14:50:10 +01008037 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008038}
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008039#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Valerio Settia08b1a42022-11-17 15:10:02 +01008040
Gilles Peskine449bd832023-01-11 14:50:10 +01008041int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8042 unsigned char *hash, size_t *hashlen,
8043 unsigned char *data, size_t data_len,
8044 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008045{
8046 psa_status_t status;
8047 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008048 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008049
Gilles Peskine449bd832023-01-11 14:50:10 +01008050 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008051
Gilles Peskine449bd832023-01-11 14:50:10 +01008052 if ((status = psa_hash_setup(&hash_operation,
8053 hash_alg)) != PSA_SUCCESS) {
8054 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008055 goto exit;
8056 }
8057
Gilles Peskine449bd832023-01-11 14:50:10 +01008058 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8059 64)) != PSA_SUCCESS) {
8060 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008061 goto exit;
8062 }
8063
Gilles Peskine449bd832023-01-11 14:50:10 +01008064 if ((status = psa_hash_update(&hash_operation,
8065 data, data_len)) != PSA_SUCCESS) {
8066 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008067 goto exit;
8068 }
8069
Gilles Peskine449bd832023-01-11 14:50:10 +01008070 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8071 hashlen)) != PSA_SUCCESS) {
8072 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8073 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008074 }
8075
8076exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008077 if (status != PSA_SUCCESS) {
8078 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8079 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8080 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008081 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008082 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008083 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8084 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008085 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008086 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008087 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008088 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008089 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008090 }
8091 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008092 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008093}
8094
Jerry Yuee40f9d2022-02-17 14:55:16 +08008095
Jerry Yud9d91da2022-02-17 14:57:06 +08008096#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8097
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008098/* Find the preferred hash for a given signature algorithm. */
8099unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008100 mbedtls_ssl_context *ssl,
8101 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008102{
Gabor Mezei078e8032022-04-27 21:17:56 +02008103 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008104 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008105
Gilles Peskine449bd832023-01-11 14:50:10 +01008106 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8107 return MBEDTLS_SSL_HASH_NONE;
8108 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008109
Gilles Peskine449bd832023-01-11 14:50:10 +01008110 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008111 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008112 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8113 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008114 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008115 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8116 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008117
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008118 mbedtls_md_type_t md_alg =
8119 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8120 if (md_alg == MBEDTLS_MD_NONE) {
8121 continue;
8122 }
8123
Gilles Peskine449bd832023-01-11 14:50:10 +01008124 if (sig_alg == sig_alg_received) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008125 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008126 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008127 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008128
Gilles Peskine449bd832023-01-11 14:50:10 +01008129 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8130 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8131 PSA_ALG_ECDSA(psa_hash_alg),
8132 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008133 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008134 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008135
Gilles Peskine449bd832023-01-11 14:50:10 +01008136 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8137 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8138 PSA_ALG_RSA_PKCS1V15_SIGN(
8139 psa_hash_alg),
8140 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008141 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008142 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008143 }
Neil Armstrong96eceb82022-06-30 18:05:05 +02008144
Gilles Peskine449bd832023-01-11 14:50:10 +01008145 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008146 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008147 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008148
Gilles Peskine449bd832023-01-11 14:50:10 +01008149 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008150}
8151
8152#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8153
Jerry Yudc7bd172022-02-17 13:44:15 +08008154#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8155
XiaokangQian75d40ef2022-04-20 11:05:24 +00008156int mbedtls_ssl_validate_ciphersuite(
8157 const mbedtls_ssl_context *ssl,
8158 const mbedtls_ssl_ciphersuite_t *suite_info,
8159 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01008160 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008161{
8162 (void) ssl;
8163
Gilles Peskine449bd832023-01-11 14:50:10 +01008164 if (suite_info == NULL) {
8165 return -1;
8166 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00008167
Gilles Peskine449bd832023-01-11 14:50:10 +01008168 if ((suite_info->min_tls_version > max_tls_version) ||
8169 (suite_info->max_tls_version < min_tls_version)) {
8170 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008171 }
8172
XiaokangQian060d8672022-04-21 09:24:56 +00008173#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008174#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008175 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
Manuel Pégourié-Gonnard88800dd2025-01-23 11:01:35 +01008176 ssl->handshake->psa_pake_ctx_is_ok != 1) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008177 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008178 }
8179#endif
8180
8181 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8182#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008183 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
8184 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
8185 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008186 }
8187#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8188#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8189
Gilles Peskine449bd832023-01-11 14:50:10 +01008190 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008191}
8192
Ronald Crone68ab4f2022-10-05 12:46:29 +02008193#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00008194/*
8195 * Function for writing a signature algorithm extension.
8196 *
8197 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8198 * value (TLS 1.3 RFC8446):
8199 * enum {
8200 * ....
8201 * ecdsa_secp256r1_sha256( 0x0403 ),
8202 * ecdsa_secp384r1_sha384( 0x0503 ),
8203 * ecdsa_secp521r1_sha512( 0x0603 ),
8204 * ....
8205 * } SignatureScheme;
8206 *
8207 * struct {
8208 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8209 * } SignatureSchemeList;
8210 *
8211 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8212 * value (TLS 1.2 RFC5246):
8213 * enum {
8214 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8215 * sha512(6), (255)
8216 * } HashAlgorithm;
8217 *
8218 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8219 * SignatureAlgorithm;
8220 *
8221 * struct {
8222 * HashAlgorithm hash;
8223 * SignatureAlgorithm signature;
8224 * } SignatureAndHashAlgorithm;
8225 *
8226 * SignatureAndHashAlgorithm
8227 * supported_signature_algorithms<2..2^16-2>;
8228 *
8229 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8230 * generalization of the TLS 1.2 signature algorithm extension.
8231 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8232 * `SignatureScheme` field of TLS 1.3
8233 *
8234 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008235int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
8236 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00008237{
8238 unsigned char *p = buf;
8239 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8240 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8241
8242 *out_len = 0;
8243
Gilles Peskine449bd832023-01-11 14:50:10 +01008244 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00008245
8246 /* Check if we have space for header and length field:
8247 * - extension_type (2 bytes)
8248 * - extension_data_length (2 bytes)
8249 * - supported_signature_algorithms_length (2 bytes)
8250 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008251 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00008252 p += 6;
8253
8254 /*
8255 * Write supported_signature_algorithms
8256 */
8257 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01008258 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
8259 if (sig_alg == NULL) {
8260 return MBEDTLS_ERR_SSL_BAD_CONFIG;
8261 }
XiaokangQianeaf36512022-04-24 09:07:44 +00008262
Gilles Peskine449bd832023-01-11 14:50:10 +01008263 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
8264 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
8265 *sig_alg,
8266 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
8267 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00008268 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008269 }
8270 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
8271 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00008272 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008273 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
8274 *sig_alg,
8275 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00008276 }
8277
8278 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008279 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01008280 if (supported_sig_alg_len == 0) {
8281 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
8282 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00008283 }
8284
Gilles Peskine449bd832023-01-11 14:50:10 +01008285 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
8286 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
8287 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00008288
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008289 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00008290
8291#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008292 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00008293#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08008294
Gilles Peskine449bd832023-01-11 14:50:10 +01008295 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00008296}
Ronald Crone68ab4f2022-10-05 12:46:29 +02008297#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00008298
XiaokangQian40a35232022-05-07 09:02:40 +00008299#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008300/*
8301 * mbedtls_ssl_parse_server_name_ext
8302 *
8303 * Structure of server_name extension:
8304 *
8305 * enum {
8306 * host_name(0), (255)
8307 * } NameType;
8308 * opaque HostName<1..2^16-1>;
8309 *
8310 * struct {
8311 * NameType name_type;
8312 * select (name_type) {
8313 * case host_name: HostName;
8314 * } name;
8315 * } ServerName;
8316 * struct {
8317 * ServerName server_name_list<1..2^16-1>
8318 * } ServerNameList;
8319 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008320MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008321int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
8322 const unsigned char *buf,
8323 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00008324{
8325 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8326 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008327 size_t server_name_list_len, hostname_len;
8328 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008329
Gilles Peskine449bd832023-01-11 14:50:10 +01008330 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00008331
Gilles Peskine449bd832023-01-11 14:50:10 +01008332 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
8333 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00008334 p += 2;
8335
Gilles Peskine449bd832023-01-11 14:50:10 +01008336 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00008337 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008338 while (p < server_name_list_end) {
8339 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
8340 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
8341 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
8342 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00008343
Gilles Peskine449bd832023-01-11 14:50:10 +01008344 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008345 /* sni_name is intended to be used only during the parsing of the
8346 * ClientHello message (it is reset to NULL before the end of
8347 * the message parsing). Thus it is ok to just point to the
8348 * reception buffer and not make a copy of it.
8349 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008350 ssl->handshake->sni_name = p + 3;
8351 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008352 if (ssl->conf->f_sni == NULL) {
8353 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008354 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008355 ret = ssl->conf->f_sni(ssl->conf->p_sni,
8356 ssl, p + 3, hostname_len);
8357 if (ret != 0) {
8358 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
8359 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8360 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
8361 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
8362 }
8363 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008364 }
8365
8366 p += hostname_len + 3;
8367 }
8368
Gilles Peskine449bd832023-01-11 14:50:10 +01008369 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008370}
8371#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8372
XiaokangQianacb39922022-06-17 10:18:48 +00008373#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008374MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008375int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
8376 const unsigned char *buf,
8377 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00008378{
8379 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008380 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008381 const unsigned char *protocol_name_list;
8382 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008383 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008384
8385 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01008386 if (ssl->conf->alpn_list == NULL) {
8387 return 0;
8388 }
XiaokangQianacb39922022-06-17 10:18:48 +00008389
8390 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008391 * RFC7301, section 3.1
8392 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008393 *
XiaokangQianc7403452022-06-23 03:24:12 +00008394 * struct {
8395 * ProtocolName protocol_name_list<2..2^16-1>
8396 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008397 */
8398
XiaokangQianc7403452022-06-23 03:24:12 +00008399 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008400 * protocol_name_list_len 2 bytes
8401 * protocol_name_len 1 bytes
8402 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008403 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008404 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00008405
Gilles Peskine449bd832023-01-11 14:50:10 +01008406 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008407 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008408 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00008409 protocol_name_list = p;
8410 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008411
8412 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01008413 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008414 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008415 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
8416 protocol_name_len);
8417 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008418 MBEDTLS_SSL_PEND_FATAL_ALERT(
8419 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01008420 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
8421 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00008422 }
8423
8424 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008425 }
8426
8427 /* Use our order of preference */
Gilles Peskinec4949d12025-05-27 19:45:29 +02008428 for (const char *const *alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008429 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00008430 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01008431 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008432 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008433 if (protocol_name_len == alpn_len &&
8434 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00008435 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01008436 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008437 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008438
8439 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008440 }
8441 }
8442
XiaokangQian95d5f542022-06-24 02:29:26 +00008443 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008444 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01008445 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8446 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
8447 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00008448}
8449
Gilles Peskine449bd832023-01-11 14:50:10 +01008450int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
8451 unsigned char *buf,
8452 unsigned char *end,
8453 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00008454{
8455 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008456 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008457 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008458
Gilles Peskine449bd832023-01-11 14:50:10 +01008459 if (ssl->alpn_chosen == NULL) {
8460 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008461 }
8462
Gilles Peskine449bd832023-01-11 14:50:10 +01008463 protocol_name_len = strlen(ssl->alpn_chosen);
8464 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008465
Gilles Peskine449bd832023-01-11 14:50:10 +01008466 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00008467 /*
8468 * 0 . 1 ext identifier
8469 * 2 . 3 ext length
8470 * 4 . 5 protocol list length
8471 * 6 . 6 protocol name length
8472 * 7 . 7+n protocol name
8473 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008474 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008475
XiaokangQian95d5f542022-06-24 02:29:26 +00008476 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008477
Gilles Peskine449bd832023-01-11 14:50:10 +01008478 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
8479 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00008480 /* Note: the length of the chosen protocol has been checked to be less
8481 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8482 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008483 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008484
Gilles Peskine449bd832023-01-11 14:50:10 +01008485 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08008486
8487#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008488 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08008489#endif
8490
Gilles Peskine449bd832023-01-11 14:50:10 +01008491 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008492}
8493#endif /* MBEDTLS_SSL_ALPN */
8494
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008495#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00008496 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008497 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008498 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008499int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
8500 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008501{
8502 /* Initialize to suppress unnecessary compiler warning */
8503 size_t hostname_len = 0;
8504
8505 /* Check if new hostname is valid before
8506 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008507 if (hostname != NULL) {
8508 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008509
Gilles Peskine449bd832023-01-11 14:50:10 +01008510 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
8511 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8512 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008513 }
8514
8515 /* Now it's clear that we will overwrite the old hostname,
8516 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01008517 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008518 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01008519 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008520 }
8521
8522 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008523 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008524 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01008525 } else {
8526 session->hostname = mbedtls_calloc(1, hostname_len + 1);
8527 if (session->hostname == NULL) {
8528 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8529 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008530
Gilles Peskine449bd832023-01-11 14:50:10 +01008531 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008532 }
8533
Gilles Peskine449bd832023-01-11 14:50:10 +01008534 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008535}
Xiaokang Qian03409292022-10-12 02:49:52 +00008536#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
8537 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008538 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008539 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008540
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008541#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
8542 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008543int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
8544 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008545{
8546 size_t alpn_len = 0;
8547
8548 if (alpn != NULL) {
8549 alpn_len = strlen(alpn);
8550
8551 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
8552 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8553 }
8554 }
8555
8556 if (session->ticket_alpn != NULL) {
8557 mbedtls_zeroize_and_free(session->ticket_alpn,
8558 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008559 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008560 }
8561
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008562 if (alpn != NULL) {
8563 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008564 if (session->ticket_alpn == NULL) {
8565 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8566 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008567 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008568 }
8569
8570 return 0;
8571}
8572#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008573
8574/*
8575 * The following functions are used by 1.2 and 1.3, client and server.
8576 */
8577#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
8578int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
8579 const mbedtls_ssl_ciphersuite_t *ciphersuite,
8580 int recv_endpoint,
8581 mbedtls_ssl_protocol_version tls_version,
8582 uint32_t *flags)
8583{
8584 int ret = 0;
8585 unsigned int usage = 0;
8586 const char *ext_oid;
8587 size_t ext_len;
8588
8589 /*
8590 * keyUsage
8591 */
8592
8593 /* Note: don't guard this with MBEDTLS_SSL_CLI_C because the server wants
8594 * to check what a compliant client will think while choosing which cert
8595 * to send to the client. */
8596#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
8597 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8598 recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8599 /* TLS 1.2 server part of the key exchange */
8600 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008601 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
8602 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
8603 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8604 break;
8605
8606 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
8607 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
8608 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
8609 break;
8610
8611 /* Don't use default: we want warnings when adding new values */
8612 case MBEDTLS_KEY_EXCHANGE_NONE:
8613 case MBEDTLS_KEY_EXCHANGE_PSK:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008614 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
8615 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
8616 usage = 0;
8617 }
8618 } else
8619#endif
8620 {
8621 /* This is either TLS 1.3 authentication, which always uses signatures,
8622 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
8623 * options we implement, both using signatures. */
8624 (void) tls_version;
8625 (void) ciphersuite;
8626 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8627 }
8628
8629 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
8630 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
8631 ret = -1;
8632 }
8633
8634 /*
8635 * extKeyUsage
8636 */
8637
8638 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8639 ext_oid = MBEDTLS_OID_SERVER_AUTH;
8640 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
8641 } else {
8642 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
8643 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
8644 }
8645
8646 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
8647 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
8648 ret = -1;
8649 }
8650
8651 return ret;
8652}
8653
Gilles Peskine4ac40082025-02-20 18:13:58 +01008654static int get_hostname_for_verification(mbedtls_ssl_context *ssl,
8655 const char **hostname)
8656{
8657 if (!mbedtls_ssl_has_set_hostname_been_called(ssl)) {
8658 MBEDTLS_SSL_DEBUG_MSG(1, ("Certificate verification without having set hostname"));
Gilles Peskine488b9192025-02-13 14:39:02 +01008659 if (mbedtls_ssl_conf_get_endpoint(ssl->conf) == MBEDTLS_SSL_IS_CLIENT &&
8660 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8661 return MBEDTLS_ERR_SSL_CERTIFICATE_VERIFICATION_WITHOUT_HOSTNAME;
8662 }
Gilles Peskine4ac40082025-02-20 18:13:58 +01008663 }
8664
8665 *hostname = ssl->hostname;
8666 if (*hostname == NULL) {
8667 MBEDTLS_SSL_DEBUG_MSG(2, ("Certificate verification without CN verification"));
8668 }
8669
8670 return 0;
8671}
8672
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008673int mbedtls_ssl_verify_certificate(mbedtls_ssl_context *ssl,
8674 int authmode,
8675 mbedtls_x509_crt *chain,
8676 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
8677 void *rs_ctx)
8678{
8679 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
8680 return 0;
8681 }
8682
8683 /*
8684 * Primary check: use the appropriate X.509 verification function
8685 */
8686 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
8687 void *p_vrfy;
8688 if (ssl->f_vrfy != NULL) {
8689 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
8690 f_vrfy = ssl->f_vrfy;
8691 p_vrfy = ssl->p_vrfy;
8692 } else {
8693 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
8694 f_vrfy = ssl->conf->f_vrfy;
8695 p_vrfy = ssl->conf->p_vrfy;
8696 }
8697
Gilles Peskine4ac40082025-02-20 18:13:58 +01008698 const char *hostname = "";
8699 int ret = get_hostname_for_verification(ssl, &hostname);
8700 if (ret != 0) {
8701 MBEDTLS_SSL_DEBUG_RET(1, "get_hostname_for_verification", ret);
8702 return ret;
8703 }
8704
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008705 int have_ca_chain_or_callback = 0;
8706#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
8707 if (ssl->conf->f_ca_cb != NULL) {
8708 ((void) rs_ctx);
8709 have_ca_chain_or_callback = 1;
8710
8711 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
8712 ret = mbedtls_x509_crt_verify_with_ca_cb(
8713 chain,
8714 ssl->conf->f_ca_cb,
8715 ssl->conf->p_ca_cb,
8716 ssl->conf->cert_profile,
Gilles Peskine4ac40082025-02-20 18:13:58 +01008717 hostname,
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008718 &ssl->session_negotiate->verify_result,
8719 f_vrfy, p_vrfy);
8720 } else
8721#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
8722 {
8723 mbedtls_x509_crt *ca_chain;
8724 mbedtls_x509_crl *ca_crl;
8725#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8726 if (ssl->handshake->sni_ca_chain != NULL) {
8727 ca_chain = ssl->handshake->sni_ca_chain;
8728 ca_crl = ssl->handshake->sni_ca_crl;
8729 } else
8730#endif
8731 {
8732 ca_chain = ssl->conf->ca_chain;
8733 ca_crl = ssl->conf->ca_crl;
8734 }
8735
8736 if (ca_chain != NULL) {
8737 have_ca_chain_or_callback = 1;
8738 }
8739
8740 ret = mbedtls_x509_crt_verify_restartable(
8741 chain,
8742 ca_chain, ca_crl,
8743 ssl->conf->cert_profile,
Gilles Peskine4ac40082025-02-20 18:13:58 +01008744 hostname,
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008745 &ssl->session_negotiate->verify_result,
8746 f_vrfy, p_vrfy, rs_ctx);
8747 }
8748
8749 if (ret != 0) {
8750 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
8751 }
8752
8753#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
8754 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8755 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8756 }
8757#endif
8758
8759 /*
8760 * Secondary checks: always done, but change 'ret' only if it was 0
8761 */
8762
8763 /* With TLS 1.2 and ECC certs, check that the curve used by the
8764 * certificate is on our list of acceptable curves.
8765 *
8766 * With TLS 1.3 this is not needed because the curve is part of the
8767 * signature algorithm (eg ecdsa_secp256r1_sha256) which is checked when
8768 * we validate the signature made with the key associated to this cert.
8769 */
8770#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
8771 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
8772 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8773 mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY)) {
8774 if (mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
8775 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8776 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
8777 if (ret == 0) {
8778 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8779 }
8780 }
8781 }
8782#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
8783
8784 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
8785 if (mbedtls_ssl_check_cert_usage(chain,
8786 ciphersuite_info,
8787 ssl->conf->endpoint,
8788 ssl->tls_version,
8789 &ssl->session_negotiate->verify_result) != 0) {
8790 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8791 if (ret == 0) {
8792 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8793 }
8794 }
8795
8796 /* With authmode optional, we want to keep going if the certificate was
8797 * unacceptable, but still fail on other errors (out of memory etc),
8798 * including fatal errors from the f_vrfy callback.
8799 *
8800 * The only acceptable errors are:
8801 * - MBEDTLS_ERR_X509_CERT_VERIFY_FAILED: cert rejected by primary check;
8802 * - MBEDTLS_ERR_SSL_BAD_CERTIFICATE: cert rejected by secondary checks.
8803 * Anything else is a fatal error. */
8804 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8805 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8806 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
8807 ret = 0;
8808 }
8809
8810 /* Return a specific error as this is a user error: inconsistent
8811 * configuration - can't verify without trust anchors. */
8812 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8813 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
8814 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8815 }
8816
8817 if (ret != 0) {
8818 uint8_t alert;
8819
8820 /* The certificate may have been rejected for several reasons.
8821 Pick one and send the corresponding alert. Which alert to send
8822 may be a subject of debate in some cases. */
8823 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
8824 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
8825 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
8826 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
8827 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
8828 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8829 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
8830 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8831 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
8832 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8833 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
8834 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8835 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
8836 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
8837 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
8838 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
8839 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
8840 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
8841 } else {
8842 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
8843 }
8844 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8845 alert);
8846 }
8847
8848#if defined(MBEDTLS_DEBUG_C)
8849 if (ssl->session_negotiate->verify_result != 0) {
8850 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8851 (unsigned int) ssl->session_negotiate->verify_result));
8852 } else {
8853 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
8854 }
8855#endif /* MBEDTLS_DEBUG_C */
8856
8857 return ret;
8858}
8859#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
8860
Max Fillinger2fe35f62024-10-25 00:52:24 +02008861#if defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT)
Max Fillinger281fb792024-10-23 18:35:09 +02008862
Max Fillinger29beade2024-09-21 11:06:28 +02008863#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008864static int mbedtls_ssl_tls12_export_keying_material(const mbedtls_ssl_context *ssl,
8865 const mbedtls_md_type_t hash_alg,
Max Fillinger7b722202024-09-21 10:48:57 +02008866 uint8_t *out,
8867 const size_t key_len,
8868 const char *label,
8869 const size_t label_len,
8870 const unsigned char *context,
8871 const size_t context_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008872 const int use_context)
8873{
8874 int ret = 0;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008875 unsigned char *prf_input = NULL;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008876
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008877 /* The input to the PRF is client_random, then server_random.
8878 * If a context is provided, this is then followed by the context length
8879 * as a 16-bit big-endian integer, and then the context itself. */
Max Fillinger155cea02024-10-23 16:32:54 +02008880 const size_t randbytes_len = MBEDTLS_CLIENT_HELLO_RANDOM_LEN + MBEDTLS_SERVER_HELLO_RANDOM_LEN;
8881 size_t prf_input_len = randbytes_len;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008882 if (use_context) {
Max Fillinger155cea02024-10-23 16:32:54 +02008883 if (context_len > UINT16_MAX) {
8884 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8885 }
8886
8887 /* This does not overflow a 32-bit size_t because the current value of
8888 * prf_input_len is 64 (length of client_random + server_random) and
8889 * context_len fits into two bytes (checked above). */
8890 prf_input_len += sizeof(uint16_t) + context_len;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008891 }
Max Fillinger155cea02024-10-23 16:32:54 +02008892
8893 prf_input = mbedtls_calloc(prf_input_len, sizeof(unsigned char));
8894 if (prf_input == NULL) {
8895 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8896 }
8897
8898 memcpy(prf_input,
8899 ssl->transform->randbytes + MBEDTLS_SERVER_HELLO_RANDOM_LEN,
8900 MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
8901 memcpy(prf_input + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
8902 ssl->transform->randbytes,
8903 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
8904 if (use_context) {
8905 MBEDTLS_PUT_UINT16_BE(context_len, prf_input, randbytes_len);
8906 memcpy(prf_input + randbytes_len + sizeof(uint16_t), context, context_len);
8907 }
8908 ret = tls_prf_generic(hash_alg, ssl->session->master, sizeof(ssl->session->master),
Max Fillingerf2dda152024-10-23 15:47:23 +02008909 label, label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008910 prf_input, prf_input_len,
8911 out, key_len);
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008912 mbedtls_free(prf_input);
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008913 return ret;
8914}
Max Fillinger281fb792024-10-23 18:35:09 +02008915#endif /* defined(MBEDTLS_SSL_PROTO_TLS1_2) */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008916
Max Fillinger29beade2024-09-21 11:06:28 +02008917#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008918static int mbedtls_ssl_tls13_export_keying_material(mbedtls_ssl_context *ssl,
8919 const mbedtls_md_type_t hash_alg,
Max Fillinger7b722202024-09-21 10:48:57 +02008920 uint8_t *out,
8921 const size_t key_len,
8922 const char *label,
8923 const size_t label_len,
8924 const unsigned char *context,
8925 const size_t context_len)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008926{
8927 const psa_algorithm_t psa_hash_alg = mbedtls_md_psa_alg_from_type(hash_alg);
8928 const size_t hash_len = PSA_HASH_LENGTH(hash_alg);
8929 const unsigned char *secret = ssl->session->app_secrets.exporter_master_secret;
8930
Max Fillinger9c5bae52024-11-21 12:33:46 +01008931 /* The length of the label must be at most 249 bytes to fit into the HkdfLabel
Max Fillingerc6fd1a22024-11-01 16:05:34 +01008932 * struct as defined in RFC 8446, Section 7.1.
Max Fillinger3e129182024-10-29 19:18:54 +01008933 *
Max Fillingerc6fd1a22024-11-01 16:05:34 +01008934 * The length of the context is unlimited even though the context field in the
Max Fillinger9c5bae52024-11-21 12:33:46 +01008935 * struct can only hold up to 255 bytes. This is because we place a *hash* of
Max Fillingerc6fd1a22024-11-01 16:05:34 +01008936 * the context in the field. */
Max Fillinger9c5bae52024-11-21 12:33:46 +01008937 if (label_len > 249) {
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008938 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8939 }
8940
8941 return mbedtls_ssl_tls13_exporter(psa_hash_alg, secret, hash_len,
Max Fillinger7b722202024-09-21 10:48:57 +02008942 (const unsigned char *) label, label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008943 context, context_len, out, key_len);
8944}
Max Fillinger281fb792024-10-23 18:35:09 +02008945#endif /* defined(MBEDTLS_SSL_PROTO_TLS1_3) */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008946
8947int mbedtls_ssl_export_keying_material(mbedtls_ssl_context *ssl,
Max Fillinger9c9989f2024-08-14 16:44:50 +02008948 uint8_t *out, const size_t key_len,
8949 const char *label, const size_t label_len,
8950 const unsigned char *context, const size_t context_len,
8951 const int use_context)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008952{
8953 if (!mbedtls_ssl_is_handshake_over(ssl)) {
Max Fillinger53d91682024-11-18 18:22:51 +01008954 /* TODO: Change this to a more appropriate error code when one is available. */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008955 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8956 }
8957
Max Fillingerc6fd1a22024-11-01 16:05:34 +01008958 if (key_len > MBEDTLS_SSL_EXPORT_MAX_KEY_LEN) {
8959 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8960 }
8961
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008962 int ciphersuite_id = mbedtls_ssl_get_ciphersuite_id_from_ssl(ssl);
8963 const mbedtls_ssl_ciphersuite_t *ciphersuite = mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
8964 const mbedtls_md_type_t hash_alg = ciphersuite->mac;
8965
8966 switch (mbedtls_ssl_get_version_number(ssl)) {
Max Fillinger29beade2024-09-21 11:06:28 +02008967#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008968 case MBEDTLS_SSL_VERSION_TLS1_2:
8969 return mbedtls_ssl_tls12_export_keying_material(ssl, hash_alg, out, key_len,
8970 label, label_len,
8971 context, context_len, use_context);
Max Fillinger29beade2024-09-21 11:06:28 +02008972#endif
8973#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008974 case MBEDTLS_SSL_VERSION_TLS1_3:
Max Fillinger7b722202024-09-21 10:48:57 +02008975 return mbedtls_ssl_tls13_export_keying_material(ssl,
8976 hash_alg,
8977 out,
8978 key_len,
8979 label,
8980 label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008981 use_context ? context : NULL,
8982 use_context ? context_len : 0);
Max Fillinger29beade2024-09-21 11:06:28 +02008983#endif
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008984 default:
8985 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
8986 }
8987}
8988
Max Fillinger2fe35f62024-10-25 00:52:24 +02008989#endif /* defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT) */
Max Fillinger281fb792024-10-23 18:35:09 +02008990
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008991#endif /* MBEDTLS_SSL_TLS_C */