blob: 39a97325ecc06407f5fa511b27d9ea5a04671c81 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00006 */
7/*
Paul Bakker5121ce52009-01-03 21:22:43 +00008 * http://www.ietf.org/rfc/rfc2246.txt
9 * http://www.ietf.org/rfc/rfc4346.txt
10 */
11
Harry Ramsey0f6bc412024-10-04 10:36:54 +010012#include "ssl_misc.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020014#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000015
SimonBd5800b72016-04-26 07:43:27 +010016#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010017
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000018#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010019#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010020#include "ssl_debug_helpers.h"
Max Fillingerbd81c9d2024-07-22 14:43:56 +020021#include "ssl_tls13_keys.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040022
Valerio Settib4f50762024-01-17 10:24:52 +010023#include "debug_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000024#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050025#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010026#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020027#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020028
Rich Evans00ab4702015-02-06 13:43:58 +000029#include <string.h>
30
Valerio Setti384fbde2024-01-02 13:26:40 +010031#include "mbedtls/psa_util.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020032#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020033#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050034#include "psa/crypto.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050035
Janos Follath23bdca02016-10-07 14:47:14 +010036#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000037#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020038#endif
39
Andrzej Kurek00644842023-05-30 05:45:00 -040040/* Define local translating functions to save code size by not using too many
41 * arguments in each translating place. */
42static int local_err_translation(psa_status_t status)
43{
44 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040045 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040046 psa_generic_status_to_mbedtls);
47}
48#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050049
Ronald Cronad8c17b2022-06-10 17:18:09 +020050#if defined(MBEDTLS_TEST_HOOKS)
51static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
52
53void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010054 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020055{
56 chk_buf_ptr_fail_args.cur = cur;
57 chk_buf_ptr_fail_args.end = end;
58 chk_buf_ptr_fail_args.need = need;
59}
60
Gilles Peskine449bd832023-01-11 14:50:10 +010061void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020062{
Gilles Peskine449bd832023-01-11 14:50:10 +010063 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020064}
65
Gilles Peskine449bd832023-01-11 14:50:10 +010066int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020067{
Gilles Peskine449bd832023-01-11 14:50:10 +010068 return (chk_buf_ptr_fail_args.cur != args->cur) ||
69 (chk_buf_ptr_fail_args.end != args->end) ||
70 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020071}
72#endif /* MBEDTLS_TEST_HOOKS */
73
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020074#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010075
Hanno Beckera0e20d02019-05-15 14:03:01 +010076#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010077/* Top-level Connection ID API */
78
Gilles Peskine449bd832023-01-11 14:50:10 +010079int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
80 size_t len,
81 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010082{
Gilles Peskine449bd832023-01-11 14:50:10 +010083 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
84 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
85 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010086
Gilles Peskine449bd832023-01-11 14:50:10 +010087 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
88 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
89 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010090 }
91
92 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010093 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010094 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010095}
96
Gilles Peskine449bd832023-01-11 14:50:10 +010097int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
98 int enable,
99 unsigned char const *own_cid,
100 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100101{
Gilles Peskine449bd832023-01-11 14:50:10 +0100102 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
103 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
104 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100105
Hanno Beckerca092242019-04-25 16:01:49 +0100106 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100107 if (enable == MBEDTLS_SSL_CID_DISABLED) {
108 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
109 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100110 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100111 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
112 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100113
Gilles Peskine449bd832023-01-11 14:50:10 +0100114 if (own_cid_len != ssl->conf->cid_len) {
115 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
116 (unsigned) own_cid_len,
117 (unsigned) ssl->conf->cid_len));
118 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100119 }
120
Gilles Peskine449bd832023-01-11 14:50:10 +0100121 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100122 /* Truncation is not an issue here because
123 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
124 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100125
Gilles Peskine449bd832023-01-11 14:50:10 +0100126 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100127}
128
Gilles Peskine449bd832023-01-11 14:50:10 +0100129int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
130 int *enabled,
Sam Berry3504c882024-06-11 14:34:17 +0100131 unsigned char own_cid[MBEDTLS_SSL_CID_IN_LEN_MAX],
Gilles Peskine449bd832023-01-11 14:50:10 +0100132 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000133{
134 *enabled = MBEDTLS_SSL_CID_DISABLED;
135
Gilles Peskine449bd832023-01-11 14:50:10 +0100136 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
137 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
138 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000139
140 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
141 * zero as this is indistinguishable from not requesting to use
142 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100143 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
144 return 0;
145 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000146
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000148 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100149 if (own_cid != NULL) {
150 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
151 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000152 }
153
154 *enabled = MBEDTLS_SSL_CID_ENABLED;
155
Gilles Peskine449bd832023-01-11 14:50:10 +0100156 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000157}
158
Gilles Peskine449bd832023-01-11 14:50:10 +0100159int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
160 int *enabled,
161 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
162 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100163{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100164 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100165
Gilles Peskine449bd832023-01-11 14:50:10 +0100166 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
167 mbedtls_ssl_is_handshake_over(ssl) == 0) {
168 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100169 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100170
Hanno Beckerc5f24222019-05-03 12:54:52 +0100171 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
172 * were used, but client and server requested the empty CID.
173 * This is indistinguishable from not using the CID extension
174 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100175 if (ssl->transform_in->in_cid_len == 0 &&
176 ssl->transform_in->out_cid_len == 0) {
177 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100178 }
179
Gilles Peskine449bd832023-01-11 14:50:10 +0100180 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100181 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100182 if (peer_cid != NULL) {
183 memcpy(peer_cid, ssl->transform_in->out_cid,
184 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100185 }
186 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100187
188 *enabled = MBEDTLS_SSL_CID_ENABLED;
189
Gilles Peskine449bd832023-01-11 14:50:10 +0100190 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100191}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100192#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100193
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200194#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200195
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200196#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200197/*
198 * Convert max_fragment_length codes to length.
199 * RFC 6066 says:
200 * enum{
201 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
202 * } MaxFragmentLength;
203 * and we add 0 -> extension unused
204 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100205static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200206{
Gilles Peskine449bd832023-01-11 14:50:10 +0100207 switch (mfl) {
208 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
209 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
210 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
211 return 512;
212 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
213 return 1024;
214 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
215 return 2048;
216 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
217 return 4096;
218 default:
219 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000220 }
221}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200222#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200223
Gilles Peskine449bd832023-01-11 14:50:10 +0100224int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
225 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200226{
Gilles Peskine449bd832023-01-11 14:50:10 +0100227 mbedtls_ssl_session_free(dst);
228 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800229#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
230 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000231#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
232 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000233 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800234#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000235#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800236
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000237#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
238 defined(MBEDTLS_SSL_EARLY_DATA)
239 dst->ticket_alpn = NULL;
240#endif
241
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200242#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000243
244#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100245 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000246 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200247
Gilles Peskine449bd832023-01-11 14:50:10 +0100248 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
249 if (dst->peer_cert == NULL) {
250 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
251 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200252
Gilles Peskine449bd832023-01-11 14:50:10 +0100253 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200254
Gilles Peskine449bd832023-01-11 14:50:10 +0100255 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
256 src->peer_cert->raw.len)) != 0) {
257 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200258 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100259 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200260 }
261 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000262#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000264 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100265 mbedtls_calloc(1, src->peer_cert_digest_len);
266 if (dst->peer_cert_digest == NULL) {
267 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
268 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000269
Gilles Peskine449bd832023-01-11 14:50:10 +0100270 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
271 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000272 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000273 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000274 }
275#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
276
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200277#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200278
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000279#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
280 defined(MBEDTLS_SSL_EARLY_DATA)
281 {
282 int ret = mbedtls_ssl_session_set_ticket_alpn(dst, src->ticket_alpn);
283 if (ret != 0) {
284 return ret;
285 }
286 }
287#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_ALPN && MBEDTLS_SSL_EARLY_DATA */
288
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200289#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100290 if (src->ticket != NULL) {
291 dst->ticket = mbedtls_calloc(1, src->ticket_len);
292 if (dst->ticket == NULL) {
293 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
294 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200295
Gilles Peskine449bd832023-01-11 14:50:10 +0100296 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200297 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000298
299#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
300 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000302 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100303 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
304 if (ret != 0) {
305 return ret;
306 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000307 }
308#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
309 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200310#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200311
Gilles Peskine449bd832023-01-11 14:50:10 +0100312 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200313}
314
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500315#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200316MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100317static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500318{
Gilles Peskine449bd832023-01-11 14:50:10 +0100319 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
320 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800321 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100322 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500323
324 /* We want to copy len_new bytes when downsizing the buffer, and
325 * len_old bytes when upsizing, so we choose the smaller of two sizes,
326 * to fit one buffer into another. Size checks, ensuring that no data is
327 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100328 memcpy(resized_buffer, *buffer,
329 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100330 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500331
332 *buffer = resized_buffer;
333 *len_old = len_new;
334
335 return 0;
336}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200337
Gilles Peskine449bd832023-01-11 14:50:10 +0100338static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
339 size_t in_buf_new_len,
340 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200341{
342 int modified = 0;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000343 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0, hdr_in = 0;
Andrzej Kurek4a063792020-10-21 15:08:44 +0200344 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200346 written_in = ssl->in_msg - ssl->in_buf;
347 iv_offset_in = ssl->in_iv - ssl->in_buf;
348 len_offset_in = ssl->in_len - ssl->in_buf;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000349 hdr_in = ssl->in_hdr - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200351 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100352 ssl->in_buf_len < in_buf_new_len) {
353 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
354 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
355 } else {
356 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
357 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200358 modified = 1;
359 }
360 }
361 }
362
Gilles Peskine449bd832023-01-11 14:50:10 +0100363 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200364 written_out = ssl->out_msg - ssl->out_buf;
365 iv_offset_out = ssl->out_iv - ssl->out_buf;
366 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100367 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200368 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100369 ssl->out_buf_len < out_buf_new_len) {
370 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
371 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
372 } else {
373 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
374 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200375 modified = 1;
376 }
377 }
378 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100379 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200380 /* Update pointers here to avoid doing it twice. */
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000381 ssl->in_hdr = ssl->in_buf + hdr_in;
382 mbedtls_ssl_update_in_pointers(ssl);
383 mbedtls_ssl_reset_out_pointers(ssl);
384
Andrzej Kurek4a063792020-10-21 15:08:44 +0200385 /* Fields below might not be properly updated with record
386 * splitting or with CID, so they are manually updated here. */
387 ssl->out_msg = ssl->out_buf + written_out;
388 ssl->out_len = ssl->out_buf + len_offset_out;
389 ssl->out_iv = ssl->out_buf + iv_offset_out;
390
391 ssl->in_msg = ssl->in_buf + written_in;
392 ssl->in_len = ssl->in_buf + len_offset_in;
393 ssl->in_iv = ssl->in_buf + iv_offset_in;
394 }
395}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500396#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
397
Jerry Yudb8c48a2022-01-27 14:54:54 +0800398#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800399
400#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100401typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
402 const char *label,
403 const unsigned char *random, size_t rlen,
404 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800405
Gilles Peskine449bd832023-01-11 14:50:10 +0100406static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800407
408#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
409
410/* Type for the TLS PRF */
411typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
412 const unsigned char *, size_t,
413 unsigned char *, size_t);
414
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200415MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100416static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
417 int ciphersuite,
418 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200419#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200421#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100422 ssl_tls_prf_t tls_prf,
423 const unsigned char randbytes[64],
424 mbedtls_ssl_protocol_version tls_version,
425 unsigned endpoint,
426 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800427
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100428#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200429MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100430static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300431 const char *label,
432 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100434static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
435static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100436
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100437#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100438
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100439#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100440MBEDTLS_CHECK_RETURN_CRITICAL
441static int tls_prf_sha384(const unsigned char *secret, size_t slen,
442 const char *label,
443 const unsigned char *random, size_t rlen,
444 unsigned char *dstbuf, size_t dlen);
445
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100446static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
447static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100448#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100449
Gilles Peskine449bd832023-01-11 14:50:10 +0100450MBEDTLS_CHECK_RETURN_CRITICAL
451static int ssl_tls12_session_load(mbedtls_ssl_session *session,
452 const unsigned char *buf,
453 size_t len);
454#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
455
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100456static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100457
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100458#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100459static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100460#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100461
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100462#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100463static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100464#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100465
466int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
467 const unsigned char *secret, size_t slen,
468 const char *label,
469 const unsigned char *random, size_t rlen,
470 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300471{
472 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
473
Gilles Peskine449bd832023-01-11 14:50:10 +0100474 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300475#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100476#if defined(PSA_WANT_ALG_SHA_384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477 case MBEDTLS_SSL_TLS_PRF_SHA384:
478 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 break;
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100480#endif /* PSA_WANT_ALG_SHA_384*/
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100481#if defined(PSA_WANT_ALG_SHA_256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300482 case MBEDTLS_SSL_TLS_PRF_SHA256:
483 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100484 break;
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100485#endif /* PSA_WANT_ALG_SHA_256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300486#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 default:
488 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300489 }
490
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300492}
493
Jerry Yuc73c6182022-02-08 20:29:25 +0800494#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100495static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800496{
497#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100498 if (session->peer_cert != NULL) {
499 mbedtls_x509_crt_free(session->peer_cert);
500 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800501 session->peer_cert = NULL;
502 }
503#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100504 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800505 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100506 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800507 session->peer_cert_digest = NULL;
508 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
509 session->peer_cert_digest_len = 0;
510 }
511#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
512}
513#endif /* MBEDTLS_X509_CRT_PARSE_C */
514
Gilles Peskine449bd832023-01-11 14:50:10 +0100515uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800516{
Gilles Peskine449bd832023-01-11 14:50:10 +0100517 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800518 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800520
521 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800523
524 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800526
527 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
581 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800583
584 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800586
587 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800589
590 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100591 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800592
593 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800595
Jan Bruckner151f6422023-02-10 12:45:19 +0100596 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
597 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
598
Jerry Yu7a485c12022-10-31 13:08:18 +0800599 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100600 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800601
602 }
603
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800605}
606
Gilles Peskine449bd832023-01-11 14:50:10 +0100607uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800608{
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800610}
611
Jerry Yud25cab02022-10-31 12:48:30 +0800612#if defined(MBEDTLS_DEBUG_C)
613static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800614 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800615 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
616 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
617 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
618 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
619 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
620 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
621 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
622 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
623 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
624 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
625 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
626 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
627 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
628 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
629 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
630 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
631 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
632 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
633 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
634 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
635 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
636 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
637 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
638 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
639 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
640 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100641 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
642 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800643};
644
Chien Wong4e9683e2023-12-28 17:07:43 +0800645static const unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800646 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
647 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
648 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
649 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
650 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
651 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
652 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
653 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
654 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
655 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
656 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
657 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
658 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
659 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
660 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
661 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
662 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
663 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
664 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
665 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
666 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
667 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
668 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
669 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
670 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
671 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
672 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100673 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
674 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800675};
676
Gilles Peskine449bd832023-01-11 14:50:10 +0100677const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800678{
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 return extension_name_table[
680 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800681}
682
Gilles Peskine449bd832023-01-11 14:50:10 +0100683static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800684{
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800686 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800688 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800690 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100691 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800692 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100693 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800694 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800696 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100697 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800698 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800700 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800702}
703
Gilles Peskine449bd832023-01-11 14:50:10 +0100704void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
705 int level, const char *file, int line,
706 int hs_msg_type, unsigned int extension_type,
707 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800708{
709 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800711 mbedtls_debug_print_msg(
712 ssl, level, file, line,
713 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100714 ssl_tls13_get_hs_msg_name(hs_msg_type),
715 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800716 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800718 return;
719 }
720
721 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100722 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800723 mbedtls_debug_print_msg(
724 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100725 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
726 mbedtls_ssl_get_extension_name(extension_type), extension_type,
727 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800728 return;
729 }
730
731 mbedtls_debug_print_msg(
732 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
734 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800735}
736
Gilles Peskine449bd832023-01-11 14:50:10 +0100737void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
738 int level, const char *file, int line,
739 int hs_msg_type, uint32_t extensions_mask,
740 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800741{
742
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 for (unsigned i = 0;
744 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
745 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800746 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800747 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100748 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800749 }
750}
751
Pengyu Lvee455c02023-01-12 14:37:24 +0800752#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800753static const char *ticket_flag_name_table[] =
754{
755 [0] = "ALLOW_PSK_RESUMPTION",
756 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
757 [3] = "ALLOW_EARLY_DATA",
758};
759
Pengyu Lv4938a562023-01-16 11:28:49 +0800760void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
761 int level, const char *file, int line,
762 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800763{
764 size_t i;
765
766 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800767 "print ticket_flags (0x%02x)", flags);
768
769 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800770
771 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800772 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800773 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
774 ticket_flag_name_table[i]);
775 }
776 }
777}
778#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
779
Jerry Yud25cab02022-10-31 12:48:30 +0800780#endif /* MBEDTLS_DEBUG_C */
781
Gilles Peskine449bd832023-01-11 14:50:10 +0100782void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
783 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800784{
785 ((void) ciphersuite_info);
786
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100787#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100788 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800789 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800791#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100792#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800794 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800796#endif
797 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800799 return;
800 }
801}
802
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100803int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100804 unsigned hs_type,
805 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100806{
807 unsigned char hs_hdr[4];
808
809 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
811 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
812 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
813 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100814
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100815 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100816}
817
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100818int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100819 unsigned hs_type,
820 unsigned char const *msg,
821 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100822{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100823 int ret;
824 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100825 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100826 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100827 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100828 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100829}
830
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100831int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800832{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100833#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100834 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100835 psa_status_t status;
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100836#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800837 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100838#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100839#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100840 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
841 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200842 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100843 }
844 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
845 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200846 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100847 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800848#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100849#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100850 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
851 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200852 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100853 }
854 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
855 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200856 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100857 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800858#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100859 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800860}
861
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100862static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100863 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800864{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100865#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100866 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100867 psa_status_t status;
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100868#else /* SHA-256 or SHA-384 */
869 ((void) ssl);
870 (void) buf;
871 (void) len;
872#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100873#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100874 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
875 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200876 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100877 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800878#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100879#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100880 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
881 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200882 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100883 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800884#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100885 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800886}
887
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100888#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100889static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100890 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800891{
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200892 return mbedtls_md_error_from_psa(psa_hash_update(
893 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800894}
895#endif
896
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100897#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100898static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100899 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800900{
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200901 return mbedtls_md_error_from_psa(psa_hash_update(
902 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800903}
904#endif
905
Gilles Peskine449bd832023-01-11 14:50:10 +0100906static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200907{
Gilles Peskine449bd832023-01-11 14:50:10 +0100908 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200909
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100910#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500911 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500912#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100913#if defined(PSA_WANT_ALG_SHA_384)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500914 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500915#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200916
917 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100918
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200919#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200920 handshake->psa_pake_ctx = psa_pake_operation_init();
921 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200922#if defined(MBEDTLS_SSL_CLI_C)
923 handshake->ecjpake_cache = NULL;
924 handshake->ecjpake_cache_len = 0;
925#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200926#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200927
Gilles Peskineeccd8882020-03-10 12:19:08 +0100928#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100929 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200930#endif
931
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200932#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
933 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
934#endif
Hanno Becker75173122019-02-06 16:18:31 +0000935
936#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
937 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100938 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +0000939#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200940}
941
Gilles Peskine449bd832023-01-11 14:50:10 +0100942void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200943{
Gilles Peskine449bd832023-01-11 14:50:10 +0100944 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +0200945
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100946 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
947 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100948
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000949#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100950 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
951 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100952#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200953}
954
Gilles Peskine449bd832023-01-11 14:50:10 +0100955void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200956{
Gilles Peskine449bd832023-01-11 14:50:10 +0100957 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200958}
959
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200960MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100961static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +0000962{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100963 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
964
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200965 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +0800966#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +0100967 if (ssl->transform_negotiate) {
968 mbedtls_ssl_transform_free(ssl->transform_negotiate);
969 }
Jerry Yu2e199812022-12-01 18:57:19 +0800970#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100971 if (ssl->session_negotiate) {
972 mbedtls_ssl_session_free(ssl->session_negotiate);
973 }
974 if (ssl->handshake) {
975 mbedtls_ssl_handshake_free(ssl);
976 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200977
Jerry Yu2e199812022-12-01 18:57:19 +0800978#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200979 /*
980 * Either the pointers are now NULL or cleared properly and can be freed.
981 * Now allocate missing structures.
982 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 if (ssl->transform_negotiate == NULL) {
984 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200985 }
Jerry Yu2e199812022-12-01 18:57:19 +0800986#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000987
Gilles Peskine449bd832023-01-11 14:50:10 +0100988 if (ssl->session_negotiate == NULL) {
989 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200990 }
Paul Bakker48916f92012-09-16 19:57:18 +0000991
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 if (ssl->handshake == NULL) {
993 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200994 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500995#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
996 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400997
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
999 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001000#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001001
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001002 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001003 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001004#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001005 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001006#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 ssl->session_negotiate == NULL) {
1008 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001009
Gilles Peskine449bd832023-01-11 14:50:10 +01001010 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001011 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001012
1013#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001014 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001015 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001016#endif
1017
Gilles Peskine449bd832023-01-11 14:50:10 +01001018 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001019 ssl->session_negotiate = NULL;
1020
Gilles Peskine449bd832023-01-11 14:50:10 +01001021 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001022 }
1023
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001024#if defined(MBEDTLS_SSL_EARLY_DATA)
1025#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001026 ssl->early_data_state = MBEDTLS_SSL_EARLY_DATA_STATE_IDLE;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001027#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001028#if defined(MBEDTLS_SSL_SRV_C)
1029 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1030#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001031 ssl->total_early_data_size = 0;
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001032#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001033
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001034 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001035 mbedtls_ssl_session_init(ssl->session_negotiate);
1036 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001037
Jerry Yu2e199812022-12-01 18:57:19 +08001038#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001039 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001040#endif
1041
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001042 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001043 ret = mbedtls_ssl_reset_checksum(ssl);
1044 if (ret != 0) {
1045 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1046 return ret;
1047 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001048
Jerry Yud0766ec2022-09-22 10:46:57 +08001049#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1050 defined(MBEDTLS_SSL_SRV_C) && \
1051 defined(MBEDTLS_SSL_SESSION_TICKETS)
1052 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001053 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001054#endif
1055
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001056#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001057 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001058 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001059
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001061 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001062 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001063 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001065
Gilles Peskine449bd832023-01-11 14:50:10 +01001066 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001067 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001068#endif
1069
Ronald Crone68ab4f2022-10-05 12:46:29 +02001070#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001071#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Ben Taylor9db2e912025-08-01 10:34:42 +01001072 ssl->handshake->sig_algs_heap_allocated = 0;
Jerry Yucc539102022-06-27 16:27:35 +08001073#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001074#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001076}
1077
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001078#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001079/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001080MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001081static int ssl_cookie_write_dummy(void *ctx,
1082 unsigned char **p, unsigned char *end,
1083 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001084{
1085 ((void) ctx);
1086 ((void) p);
1087 ((void) end);
1088 ((void) cli_id);
1089 ((void) cli_id_len);
1090
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001092}
1093
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001094MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001095static int ssl_cookie_check_dummy(void *ctx,
1096 const unsigned char *cookie, size_t cookie_len,
1097 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001098{
1099 ((void) ctx);
1100 ((void) cookie);
1101 ((void) cookie_len);
1102 ((void) cli_id);
1103 ((void) cli_id_len);
1104
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001106}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001107#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001108
Paul Bakker5121ce52009-01-03 21:22:43 +00001109/*
1110 * Initialize an SSL context
1111 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001112void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001113{
Gilles Peskine449bd832023-01-11 14:50:10 +01001114 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001115}
1116
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001117MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001118static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001119{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001120 const mbedtls_ssl_config *conf = ssl->conf;
1121
Ronald Cron6f135e12021-12-08 16:57:54 +01001122#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1124 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1125 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1126 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001127 }
1128
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1130 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001131 }
1132#endif
1133
1134#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1136 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1137 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001138 }
1139#endif
1140
Ronald Cron6f135e12021-12-08 16:57:54 +01001141#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001142 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1143 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1144 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1145 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001146 }
1147
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1149 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001150 }
1151#endif
1152
Gilles Peskine449bd832023-01-11 14:50:10 +01001153 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1154 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001155}
1156
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001157MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001158static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1159{
1160 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001161 ret = ssl_conf_version_check(ssl);
1162 if (ret != 0) {
1163 return ret;
1164 }
Jerry Yu60835a82021-08-04 10:13:52 +08001165
1166 /* Space for further checks */
1167
Gilles Peskine449bd832023-01-11 14:50:10 +01001168 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001169}
1170
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001171/*
1172 * Setup an SSL context
1173 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001174
Gilles Peskine449bd832023-01-11 14:50:10 +01001175int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1176 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001177{
Janos Follath865b3eb2019-12-16 11:46:15 +00001178 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001179 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1180 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001181
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001182 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001183
Gilles Peskine449bd832023-01-11 14:50:10 +01001184 if ((ret = ssl_conf_check(ssl)) != 0) {
1185 return ret;
1186 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001187 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001188
Paul Bakker62f2dee2012-09-28 07:31:51 +00001189 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001190 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001191 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001192
1193 /* Set to NULL in case of an error condition */
1194 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001195
Darryl Greenb33cc762019-11-28 14:29:44 +00001196#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1197 ssl->in_buf_len = in_buf_len;
1198#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001199 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1200 if (ssl->in_buf == NULL) {
1201 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001202 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001203 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001204 }
1205
Darryl Greenb33cc762019-11-28 14:29:44 +00001206#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1207 ssl->out_buf_len = out_buf_len;
1208#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001209 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1210 if (ssl->out_buf == NULL) {
1211 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001212 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001213 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001214 }
1215
Deomid rojer Ryabkov3dfe75e2025-01-26 10:43:42 +02001216 mbedtls_ssl_reset_in_pointers(ssl);
1217 mbedtls_ssl_reset_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001218
Johan Pascalb62bb512015-12-03 21:56:45 +01001219#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001221#endif
1222
Gilles Peskine449bd832023-01-11 14:50:10 +01001223 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001224 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001225 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001226
Gilles Peskine449bd832023-01-11 14:50:10 +01001227 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001228
1229error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001230 mbedtls_free(ssl->in_buf);
1231 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001232
1233 ssl->conf = NULL;
1234
Darryl Greenb33cc762019-11-28 14:29:44 +00001235#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1236 ssl->in_buf_len = 0;
1237 ssl->out_buf_len = 0;
1238#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001239 ssl->in_buf = NULL;
1240 ssl->out_buf = NULL;
1241
1242 ssl->in_hdr = NULL;
1243 ssl->in_ctr = NULL;
1244 ssl->in_len = NULL;
1245 ssl->in_iv = NULL;
1246 ssl->in_msg = NULL;
1247
1248 ssl->out_hdr = NULL;
1249 ssl->out_ctr = NULL;
1250 ssl->out_len = NULL;
1251 ssl->out_iv = NULL;
1252 ssl->out_msg = NULL;
1253
Gilles Peskine449bd832023-01-11 14:50:10 +01001254 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001255}
1256
1257/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001258 * Reset an initialized and used SSL context for re-use while retaining
1259 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001260 *
1261 * If partial is non-zero, keep data in the input buffer and client ID.
1262 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001263 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001264void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1265 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001266{
Darryl Greenb33cc762019-11-28 14:29:44 +00001267#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1268 size_t in_buf_len = ssl->in_buf_len;
1269 size_t out_buf_len = ssl->out_buf_len;
1270#else
1271 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1272 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1273#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001274
Hanno Beckerb0302c42021-08-03 09:39:42 +01001275#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1276 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001277#endif
1278
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001279 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001280 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001281
Deomid rojer Ryabkov3dfe75e2025-01-26 10:43:42 +02001282 mbedtls_ssl_reset_in_pointers(ssl);
1283 mbedtls_ssl_reset_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001284
1285 /* Reset incoming message parsing */
1286 ssl->in_offt = NULL;
1287 ssl->nb_zero = 0;
1288 ssl->in_msgtype = 0;
1289 ssl->in_msglen = 0;
1290 ssl->in_hslen = 0;
Deomid rojer Ryabkovdd14c0a2025-02-13 13:41:51 +03001291 ssl->in_hsfraglen = 0;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001292 ssl->keep_current_message = 0;
1293 ssl->transform_in = NULL;
1294
1295#if defined(MBEDTLS_SSL_PROTO_DTLS)
1296 ssl->next_record_offset = 0;
1297 ssl->in_epoch = 0;
1298#endif
1299
1300 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001301 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001302 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001303 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001304 }
1305
Ronald Cronad8c17b2022-06-10 17:18:09 +02001306 ssl->send_alert = 0;
1307
Hanno Beckerb0302c42021-08-03 09:39:42 +01001308 /* Reset outgoing message writing */
1309 ssl->out_msgtype = 0;
1310 ssl->out_msglen = 0;
1311 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001312 memset(ssl->out_buf, 0, out_buf_len);
1313 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001314 ssl->transform_out = NULL;
1315
1316#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001318#endif
1319
XiaokangQian2b01dc32022-01-21 02:53:13 +00001320#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001321 if (ssl->transform) {
1322 mbedtls_ssl_transform_free(ssl->transform);
1323 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001324 ssl->transform = NULL;
1325 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001326#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1327
XiaokangQian2b01dc32022-01-21 02:53:13 +00001328#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001329 mbedtls_ssl_transform_free(ssl->transform_application);
1330 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001331 ssl->transform_application = NULL;
1332
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001334#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1336 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001337 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001338#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001339
Gilles Peskine449bd832023-01-11 14:50:10 +01001340 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1341 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001342 ssl->handshake->transform_handshake = NULL;
1343 }
1344
XiaokangQian2b01dc32022-01-21 02:53:13 +00001345#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001346}
1347
Gilles Peskine449bd832023-01-11 14:50:10 +01001348int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001349{
1350 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1351
Gilles Peskinef670ba52025-03-07 15:09:32 +01001352 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_REQUEST);
Gilles Peskinefd89acc2025-02-24 18:45:49 +01001353 ssl->flags &= MBEDTLS_SSL_CONTEXT_FLAGS_KEEP_AT_SESSION;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001354 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001355
Gilles Peskine449bd832023-01-11 14:50:10 +01001356 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001357
1358 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001359#if defined(MBEDTLS_SSL_RENEGOTIATION)
1360 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001361 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001362
1363 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1365 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001366#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001367 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001368
Hanno Beckerb0302c42021-08-03 09:39:42 +01001369 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001370 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001371 if (ssl->session) {
1372 mbedtls_ssl_session_free(ssl->session);
1373 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001374 ssl->session = NULL;
1375 }
1376
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001377#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001378 ssl->alpn_chosen = NULL;
1379#endif
1380
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001381#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001382 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001383#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001384 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001385#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001386 if (free_cli_id) {
1387 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001388 ssl->cli_id = NULL;
1389 ssl->cli_id_len = 0;
1390 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001391#endif
1392
Gilles Peskine449bd832023-01-11 14:50:10 +01001393 if ((ret = ssl_handshake_init(ssl)) != 0) {
1394 return ret;
1395 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001396
Gilles Peskine449bd832023-01-11 14:50:10 +01001397 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001398}
1399
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001400/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001401 * Reset an initialized and used SSL context for re-use while retaining
1402 * all application-set variables, function pointers and data.
1403 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001404int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001405{
Gilles Peskine449bd832023-01-11 14:50:10 +01001406 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001407}
1408
1409/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001410 * SSL set accessors
1411 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001412void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001413{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001414 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001415}
1416
Gilles Peskine449bd832023-01-11 14:50:10 +01001417void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001418{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001419 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001420}
1421
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001422#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001423void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001424{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001425 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001426}
1427#endif
1428
Gilles Peskine449bd832023-01-11 14:50:10 +01001429void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001430{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001431 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001432}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001433
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001434#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001435
Gilles Peskine449bd832023-01-11 14:50:10 +01001436void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1437 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001438{
1439 ssl->disable_datagram_packing = !allow_packing;
1440}
1441
Gilles Peskine449bd832023-01-11 14:50:10 +01001442void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1443 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001444{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001445 conf->hs_timeout_min = min;
1446 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001447}
1448#endif
1449
Gilles Peskine449bd832023-01-11 14:50:10 +01001450void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001451{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001452 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001453}
1454
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001455#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001456void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1457 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1458 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001459{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001460 conf->f_vrfy = f_vrfy;
1461 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001462}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001463#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001464
Gilles Peskine449bd832023-01-11 14:50:10 +01001465void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1466 void (*f_dbg)(void *, int, const char *, int, const char *),
1467 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001468{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001469 conf->f_dbg = f_dbg;
1470 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001471}
1472
Gilles Peskine449bd832023-01-11 14:50:10 +01001473void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1474 void *p_bio,
1475 mbedtls_ssl_send_t *f_send,
1476 mbedtls_ssl_recv_t *f_recv,
1477 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001478{
1479 ssl->p_bio = p_bio;
1480 ssl->f_send = f_send;
1481 ssl->f_recv = f_recv;
1482 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001483}
1484
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001485#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001486void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001487{
1488 ssl->mtu = mtu;
1489}
1490#endif
1491
Gilles Peskine449bd832023-01-11 14:50:10 +01001492void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001493{
1494 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001495}
1496
Gilles Peskine449bd832023-01-11 14:50:10 +01001497void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1498 void *p_timer,
1499 mbedtls_ssl_set_timer_t *f_set_timer,
1500 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001501{
1502 ssl->p_timer = p_timer;
1503 ssl->f_set_timer = f_set_timer;
1504 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001505
1506 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001507 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001508}
1509
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001510#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001511void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1512 void *p_cache,
1513 mbedtls_ssl_cache_get_t *f_get_cache,
1514 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001515{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001516 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001517 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001518 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001519}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001520#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001521
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001522#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001523int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001524{
Janos Follath865b3eb2019-12-16 11:46:15 +00001525 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001526
Gilles Peskine449bd832023-01-11 14:50:10 +01001527 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001528 session == NULL ||
1529 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1531 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001532 }
1533
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 if (ssl->handshake->resume == 1) {
1535 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1536 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001537
Jerry Yu21092062022-10-10 21:21:31 +08001538#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001539 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron233fcaa2024-04-04 14:05:21 +02001540#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001541 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001542 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001543
Gilles Peskine449bd832023-01-11 14:50:10 +01001544 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001545 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001546 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1547 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1548 session->ciphersuite));
1549 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001550 }
Ronald Cron233fcaa2024-04-04 14:05:21 +02001551#else
1552 /*
1553 * If session tickets are not enabled, it is not possible to resume a
1554 * TLS 1.3 session, thus do not make any change to the SSL context in
1555 * the first place.
1556 */
1557 return 0;
1558#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001559 }
Jerry Yu21092062022-10-10 21:21:31 +08001560#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001561
Gilles Peskine449bd832023-01-11 14:50:10 +01001562 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1563 session)) != 0) {
1564 return ret;
1565 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001566
Paul Bakker0a597072012-09-25 21:55:46 +00001567 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001568
Gilles Peskine449bd832023-01-11 14:50:10 +01001569 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001570}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001571#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001572
Gilles Peskine449bd832023-01-11 14:50:10 +01001573void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1574 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001575{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001576 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001577}
1578
Ronald Cron6f135e12021-12-08 16:57:54 +01001579#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001580void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1581 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001582{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001583 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001584}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001585
1586#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001587void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1588 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001589{
1590 conf->early_data_enabled = early_data_enabled;
1591}
Jerry Yucc4e0072022-11-22 17:22:22 +08001592
1593#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001594void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001595 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001596{
Jerry Yu39da9852022-12-06 16:58:36 +08001597 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001598}
1599#endif /* MBEDTLS_SSL_SRV_C */
1600
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001601#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001602#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001603
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001604#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001605void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1606 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001607{
1608 conf->cert_profile = profile;
1609}
1610
Gilles Peskine449bd832023-01-11 14:50:10 +01001611static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001612{
1613 mbedtls_ssl_key_cert *cur = key_cert, *next;
1614
Gilles Peskine449bd832023-01-11 14:50:10 +01001615 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001616 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001617 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001618 cur = next;
1619 }
1620}
1621
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001622/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001623MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001624static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1625 mbedtls_x509_crt *cert,
1626 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001627{
niisato8ee24222018-06-25 19:05:48 +09001628 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001629
Gilles Peskine449bd832023-01-11 14:50:10 +01001630 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001631 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001632 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001633 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001634 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001635 }
1636
Gilles Peskine449bd832023-01-11 14:50:10 +01001637 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1638 if (new_cert == NULL) {
1639 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1640 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001641
niisato8ee24222018-06-25 19:05:48 +09001642 new_cert->cert = cert;
1643 new_cert->key = key;
1644 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001645
Glenn Strauss36872db2022-01-22 05:06:31 -05001646 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001647 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001648 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001649 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001650 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001651 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001652 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001653 }
niisato8ee24222018-06-25 19:05:48 +09001654 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001655 }
1656
Gilles Peskine449bd832023-01-11 14:50:10 +01001657 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001658}
1659
Gilles Peskine449bd832023-01-11 14:50:10 +01001660int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001661 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001662 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001663{
Gilles Peskine449bd832023-01-11 14:50:10 +01001664 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001665}
1666
Gilles Peskine449bd832023-01-11 14:50:10 +01001667void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001668 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001669 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001670{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001671 conf->ca_chain = ca_chain;
1672 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001673
1674#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1675 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1676 * cannot be used together. */
1677 conf->f_ca_cb = NULL;
1678 conf->p_ca_cb = NULL;
1679#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001680}
Hanno Becker5adaad92019-03-27 16:54:37 +00001681
1682#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001683void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1684 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1685 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001686{
1687 conf->f_ca_cb = f_ca_cb;
1688 conf->p_ca_cb = p_ca_cb;
1689
1690 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1691 * cannot be used together. */
1692 conf->ca_chain = NULL;
1693 conf->ca_crl = NULL;
1694}
1695#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001696#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001697
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001698#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001699const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1700 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001701{
1702 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001703 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001704}
1705
Gilles Peskine449bd832023-01-11 14:50:10 +01001706int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1707 mbedtls_x509_crt *own_cert,
1708 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001709{
Gilles Peskine449bd832023-01-11 14:50:10 +01001710 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1711 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001712}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001713
Gilles Peskine449bd832023-01-11 14:50:10 +01001714void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1715 mbedtls_x509_crt *ca_chain,
1716 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001717{
1718 ssl->handshake->sni_ca_chain = ca_chain;
1719 ssl->handshake->sni_ca_crl = ca_crl;
1720}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001721
Glenn Strauss999ef702022-03-11 01:37:23 -05001722#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001723void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1724 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001725{
1726 ssl->handshake->dn_hints = crt;
1727}
1728#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1729
Gilles Peskine449bd832023-01-11 14:50:10 +01001730void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1731 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001732{
1733 ssl->handshake->sni_authmode = authmode;
1734}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001735#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1736
Hanno Becker8927c832019-04-03 12:52:50 +01001737#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001738void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1739 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1740 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001741{
1742 ssl->f_vrfy = f_vrfy;
1743 ssl->p_vrfy = p_vrfy;
1744}
1745#endif
1746
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001747#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001748
Przemek Stekielfde11282023-03-13 16:06:09 +01001749static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1750static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1751
Valerio Setti016f6822022-12-09 14:17:50 +01001752static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001753 mbedtls_ssl_context *ssl,
1754 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001755{
1756 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001757 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001758 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001759 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001760 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001761 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1763 psa_pake_cs_set_primitive(&cipher_suite,
1764 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1765 PSA_ECC_FAMILY_SECP_R1,
1766 256));
1767 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001768
Anton Matkin72d60302025-03-19 14:56:57 +01001769 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, pwd, &cipher_suite);
Gilles Peskine449bd832023-01-11 14:50:10 +01001770 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001771 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001772 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001773
Gilles Peskine449bd832023-01-11 14:50:10 +01001774 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001775 user = jpake_server_id;
1776 user_len = sizeof(jpake_server_id);
1777 peer = jpake_client_id;
1778 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001779 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001780 user = jpake_client_id;
1781 user_len = sizeof(jpake_client_id);
1782 peer = jpake_server_id;
1783 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001784 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001785
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001786 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1787 if (status != PSA_SUCCESS) {
1788 return status;
1789 }
1790
1791 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001792 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001793 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001794 }
Valerio Setti016f6822022-12-09 14:17:50 +01001795
Valerio Setti016f6822022-12-09 14:17:50 +01001796 ssl->handshake->psa_pake_ctx_is_ok = 1;
1797
Gilles Peskine449bd832023-01-11 14:50:10 +01001798 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001799}
1800
Gilles Peskine449bd832023-01-11 14:50:10 +01001801int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1802 const unsigned char *pw,
1803 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001804{
1805 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1806 psa_status_t status;
1807
Gilles Peskine449bd832023-01-11 14:50:10 +01001808 if (ssl->handshake == NULL || ssl->conf == NULL) {
1809 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001810 }
1811
Gilles Peskine449bd832023-01-11 14:50:10 +01001812 /* Empty password is not valid */
1813 if ((pw == NULL) || (pw_len == 0)) {
1814 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1815 }
1816
1817 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
1818 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
1819 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
1820
1821 status = psa_import_key(&attributes, pw, pw_len,
1822 &ssl->handshake->psa_pake_password);
1823 if (status != PSA_SUCCESS) {
1824 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1825 }
1826
1827 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
1828 ssl->handshake->psa_pake_password);
1829 if (status != PSA_SUCCESS) {
1830 psa_destroy_key(ssl->handshake->psa_pake_password);
1831 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1832 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1833 }
1834
1835 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001836}
Valerio Settia9a97dc2022-11-28 18:26:16 +01001837
Gilles Peskine449bd832023-01-11 14:50:10 +01001838int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
1839 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01001840{
Valerio Settia9a97dc2022-11-28 18:26:16 +01001841 psa_status_t status;
1842
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 if (ssl->handshake == NULL || ssl->conf == NULL) {
1844 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001845 }
1846
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 if (mbedtls_svc_key_id_is_null(pwd)) {
1848 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1849 }
1850
1851 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
1852 if (status != PSA_SUCCESS) {
1853 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1854 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1855 }
1856
1857 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001858}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001859#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001860
Ronald Cron73fe8df2022-10-05 14:31:43 +02001861#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001862int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001863{
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 if (conf->psk_identity == NULL ||
1865 conf->psk_identity_len == 0) {
1866 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02001867 }
1868
Gilles Peskine449bd832023-01-11 14:50:10 +01001869 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
1870 return 1;
1871 }
Ronald Crond29e13e2022-10-19 10:33:48 +02001872
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 if (conf->psk != NULL && conf->psk_len != 0) {
1874 return 1;
1875 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001876
Gilles Peskine449bd832023-01-11 14:50:10 +01001877 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001878}
1879
Gilles Peskine449bd832023-01-11 14:50:10 +01001880static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001881{
1882 /* Remove reference to existing PSK, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001883 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001884 /* The maintenance of the PSK key slot is the
1885 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001886 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001887 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001888 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01001889 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001890 conf->psk = NULL;
1891 conf->psk_len = 0;
1892 }
1893
1894 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001895 if (conf->psk_identity != NULL) {
1896 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001897 conf->psk_identity = NULL;
1898 conf->psk_identity_len = 0;
1899 }
1900}
1901
Hanno Becker7390c712018-11-15 13:33:04 +00001902/* This function assumes that PSK identity in the SSL config is unset.
1903 * It checks that the provided identity is well-formed and attempts
1904 * to make a copy of it in the SSL config.
1905 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001906MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001907static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
1908 unsigned char const *psk_identity,
1909 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001910{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001911 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01001912 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02001913 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001914 (psk_identity_len >> 16) != 0 ||
1915 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
1916 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001917 }
1918
Gilles Peskine449bd832023-01-11 14:50:10 +01001919 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
1920 if (conf->psk_identity == NULL) {
1921 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1922 }
Paul Bakker6db455e2013-09-18 17:29:31 +02001923
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001924 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001925 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02001926
Gilles Peskine449bd832023-01-11 14:50:10 +01001927 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02001928}
1929
Gilles Peskine449bd832023-01-11 14:50:10 +01001930int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
1931 const unsigned char *psk, size_t psk_len,
1932 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00001933{
Janos Follath865b3eb2019-12-16 11:46:15 +00001934 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001935
1936 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001937 if (mbedtls_ssl_conf_has_static_psk(conf)) {
1938 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1939 }
Hanno Becker7390c712018-11-15 13:33:04 +00001940
1941 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01001942 if (psk == NULL) {
1943 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1944 }
1945 if (psk_len == 0) {
1946 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1947 }
1948 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
1949 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1950 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01001951
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
1953 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1954 }
Hanno Becker7390c712018-11-15 13:33:04 +00001955 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001956 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00001957
1958 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
1960 if (ret != 0) {
1961 ssl_conf_remove_psk(conf);
1962 }
Hanno Becker7390c712018-11-15 13:33:04 +00001963
Gilles Peskine449bd832023-01-11 14:50:10 +01001964 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00001965}
1966
Gilles Peskine449bd832023-01-11 14:50:10 +01001967static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001968{
Gilles Peskine449bd832023-01-11 14:50:10 +01001969 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02001970 /* The maintenance of the external PSK key slot is the
1971 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 if (ssl->handshake->psk_opaque_is_internal) {
1973 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02001974 ssl->handshake->psk_opaque_is_internal = 0;
1975 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02001976 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001977 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001978}
1979
Gilles Peskine449bd832023-01-11 14:50:10 +01001980int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
1981 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001982{
Neil Armstrong501c9322022-05-03 09:35:09 +02001983 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08001984 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08001985 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08001986 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02001987
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 if (psk == NULL || ssl->handshake == NULL) {
1989 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1990 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001991
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
1993 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1994 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001995
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001997
Jerry Yuccc68a42022-07-26 16:39:20 +08001998#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001999 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2000 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2001 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2002 } else {
2003 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2004 }
2005 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002006 }
2007#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002008
Jerry Yu568ec252022-07-22 21:27:34 +08002009#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002010 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2011 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2012 psa_set_key_usage_flags(&key_attributes,
2013 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002014 }
2015#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2016
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 psa_set_key_algorithm(&key_attributes, alg);
2018 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002019
Gilles Peskine449bd832023-01-11 14:50:10 +01002020 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2021 if (status != PSA_SUCCESS) {
2022 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2023 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002024
2025 /* Allow calling psa_destroy_key() on psk remove */
2026 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002027 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002028}
2029
Gilles Peskine449bd832023-01-11 14:50:10 +01002030int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2031 mbedtls_svc_key_id_t psk,
2032 const unsigned char *psk_identity,
2033 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002034{
Janos Follath865b3eb2019-12-16 11:46:15 +00002035 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002036
2037 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2039 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2040 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002041
Hanno Becker7390c712018-11-15 13:33:04 +00002042 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002043 if (mbedtls_svc_key_id_is_null(psk)) {
2044 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2045 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002046 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002047
2048 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002049 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2050 psk_identity_len);
2051 if (ret != 0) {
2052 ssl_conf_remove_psk(conf);
2053 }
Hanno Becker7390c712018-11-15 13:33:04 +00002054
Gilles Peskine449bd832023-01-11 14:50:10 +01002055 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002056}
2057
Gilles Peskine449bd832023-01-11 14:50:10 +01002058int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2059 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002060{
Gilles Peskine449bd832023-01-11 14:50:10 +01002061 if ((mbedtls_svc_key_id_is_null(psk)) ||
2062 (ssl->handshake == NULL)) {
2063 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2064 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002065
Gilles Peskine449bd832023-01-11 14:50:10 +01002066 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002067 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002069}
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002070
Jerry Yu8897c072022-08-12 13:56:53 +08002071#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002072void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2073 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2074 size_t),
2075 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002076{
2077 conf->f_psk = f_psk;
2078 conf->p_psk = p_psk;
2079}
Jerry Yu8897c072022-08-12 13:56:53 +08002080#endif /* MBEDTLS_SSL_SRV_C */
2081
Ronald Cron73fe8df2022-10-05 14:31:43 +02002082#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002083
Gilles Peskine301711e2022-04-26 16:57:05 +02002084static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002086{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002087#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002088 if (alg == PSA_ALG_CBC_NO_PADDING) {
2089 return MBEDTLS_SSL_MODE_CBC;
2090 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002091#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002092 if (PSA_ALG_IS_AEAD(alg)) {
2093 return MBEDTLS_SSL_MODE_AEAD;
2094 }
2095 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002096}
2097
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002098
Gilles Peskinee108d982022-04-26 16:50:40 +02002099static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2100 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002102{
2103#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2105 base_mode == MBEDTLS_SSL_MODE_CBC) {
2106 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002107 }
2108#else
2109 (void) encrypt_then_mac;
2110#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002111 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002112}
2113
Neil Armstrongab555e02022-04-04 11:07:59 +02002114mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002115 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002116{
Gilles Peskinee108d982022-04-26 16:50:40 +02002117 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 transform->psa_alg
Gilles Peskinee108d982022-04-26 16:50:40 +02002119 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002120
Gilles Peskinee108d982022-04-26 16:50:40 +02002121 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002122#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002123 encrypt_then_mac = transform->encrypt_then_mac;
2124#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002126}
2127
Neil Armstrongab555e02022-04-04 11:07:59 +02002128mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002129#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002130 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002131#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002133{
Gilles Peskinee108d982022-04-26 16:50:40 +02002134 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2135
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002136 psa_status_t status;
2137 psa_algorithm_t alg;
2138 psa_key_type_t type;
2139 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002140 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2141 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 if (status == PSA_SUCCESS) {
2143 base_mode = mbedtls_ssl_get_base_mode(alg);
2144 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002145
Gilles Peskinee108d982022-04-26 16:50:40 +02002146#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2147 int encrypt_then_mac = 0;
2148#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002150}
2151
Jerry Yu251a12e2022-07-13 15:15:48 +08002152
Ronald Cron8b592d22024-11-12 18:08:25 +01002153const mbedtls_error_pair_t psa_to_ssl_errors[] =
2154{
2155 { PSA_SUCCESS, 0 },
2156 { PSA_ERROR_INSUFFICIENT_MEMORY, MBEDTLS_ERR_SSL_ALLOC_FAILED },
2157 { PSA_ERROR_NOT_SUPPORTED, MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE },
2158 { PSA_ERROR_INVALID_SIGNATURE, MBEDTLS_ERR_SSL_INVALID_MAC },
2159 { PSA_ERROR_INVALID_ARGUMENT, MBEDTLS_ERR_SSL_BAD_INPUT_DATA },
2160 { PSA_ERROR_BAD_STATE, MBEDTLS_ERR_SSL_INTERNAL_ERROR },
2161 { PSA_ERROR_BUFFER_TOO_SMALL, MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL }
2162};
2163
Gilles Peskine449bd832023-01-11 14:50:10 +01002164psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2165 size_t taglen,
2166 psa_algorithm_t *alg,
2167 psa_key_type_t *key_type,
2168 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002169{
Elena Uziunaitec2561722024-07-05 11:37:33 +01002170#if !defined(PSA_WANT_ALG_CCM)
Yanray Wang19e4dc82023-11-16 18:02:05 +08002171 (void) taglen;
2172#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002173 switch (mbedtls_cipher_type) {
Elena Uziunaite74342c72024-07-05 11:31:29 +01002174#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002175 case MBEDTLS_CIPHER_AES_128_CBC:
2176 *alg = PSA_ALG_CBC_NO_PADDING;
2177 *key_type = PSA_KEY_TYPE_AES;
2178 *key_size = 128;
2179 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002180#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002181#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002182 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002183 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002184 *key_type = PSA_KEY_TYPE_AES;
2185 *key_size = 128;
2186 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002187#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002188#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002189 case MBEDTLS_CIPHER_AES_128_GCM:
2190 *alg = PSA_ALG_GCM;
2191 *key_type = PSA_KEY_TYPE_AES;
2192 *key_size = 128;
2193 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002194#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002195#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002196 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002197 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002198 *key_type = PSA_KEY_TYPE_AES;
2199 *key_size = 192;
2200 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002201#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002202#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002203 case MBEDTLS_CIPHER_AES_192_GCM:
2204 *alg = PSA_ALG_GCM;
2205 *key_type = PSA_KEY_TYPE_AES;
2206 *key_size = 192;
2207 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002208#endif
Elena Uziunaite74342c72024-07-05 11:31:29 +01002209#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002210 case MBEDTLS_CIPHER_AES_256_CBC:
2211 *alg = PSA_ALG_CBC_NO_PADDING;
2212 *key_type = PSA_KEY_TYPE_AES;
2213 *key_size = 256;
2214 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002215#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002216#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002217 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002219 *key_type = PSA_KEY_TYPE_AES;
2220 *key_size = 256;
2221 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002222#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002223#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002224 case MBEDTLS_CIPHER_AES_256_GCM:
2225 *alg = PSA_ALG_GCM;
2226 *key_type = PSA_KEY_TYPE_AES;
2227 *key_size = 256;
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_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002231 case MBEDTLS_CIPHER_ARIA_128_CBC:
2232 *alg = PSA_ALG_CBC_NO_PADDING;
2233 *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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002238 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002240 *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_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002245 case MBEDTLS_CIPHER_ARIA_128_GCM:
2246 *alg = PSA_ALG_GCM;
2247 *key_type = PSA_KEY_TYPE_ARIA;
2248 *key_size = 128;
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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002252 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002254 *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_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002259 case MBEDTLS_CIPHER_ARIA_192_GCM:
2260 *alg = PSA_ALG_GCM;
2261 *key_type = PSA_KEY_TYPE_ARIA;
2262 *key_size = 192;
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_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002266 case MBEDTLS_CIPHER_ARIA_256_CBC:
2267 *alg = PSA_ALG_CBC_NO_PADDING;
2268 *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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002273 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002274 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002275 *key_type = PSA_KEY_TYPE_ARIA;
2276 *key_size = 256;
2277 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002278#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002279#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002280 case MBEDTLS_CIPHER_ARIA_256_GCM:
2281 *alg = PSA_ALG_GCM;
2282 *key_type = PSA_KEY_TYPE_ARIA;
2283 *key_size = 256;
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_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002287 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2288 *alg = PSA_ALG_CBC_NO_PADDING;
2289 *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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002294 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002295 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002296 *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_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002301 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2302 *alg = PSA_ALG_GCM;
2303 *key_type = PSA_KEY_TYPE_CAMELLIA;
2304 *key_size = 128;
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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002308 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002309 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002310 *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_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002315 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2316 *alg = PSA_ALG_GCM;
2317 *key_type = PSA_KEY_TYPE_CAMELLIA;
2318 *key_size = 192;
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_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002322 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2323 *alg = PSA_ALG_CBC_NO_PADDING;
2324 *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_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002329 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002330 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002331 *key_type = PSA_KEY_TYPE_CAMELLIA;
2332 *key_size = 256;
2333 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002334#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002335#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002336 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2337 *alg = PSA_ALG_GCM;
2338 *key_type = PSA_KEY_TYPE_CAMELLIA;
2339 *key_size = 256;
2340 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002341#endif
Elena Uziunaite5c70c302024-07-05 11:44:44 +01002342#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002343 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2344 *alg = PSA_ALG_CHACHA20_POLY1305;
2345 *key_type = PSA_KEY_TYPE_CHACHA20;
2346 *key_size = 256;
2347 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002348#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002349 case MBEDTLS_CIPHER_NULL:
2350 *alg = MBEDTLS_SSL_NULL_CIPHER;
2351 *key_type = 0;
2352 *key_size = 0;
2353 break;
2354 default:
2355 return PSA_ERROR_NOT_SUPPORTED;
2356 }
2357
2358 return PSA_SUCCESS;
2359}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002360
Ronald Crone68ab4f2022-10-05 12:46:29 +02002361#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002362
Jerry Yuf017ee42022-01-12 15:49:48 +08002363/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002364void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2365 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002366{
Jerry Yuf017ee42022-01-12 15:49:48 +08002367 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002368}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002369#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002370
Brett Warrene0edc842021-08-17 09:53:13 +01002371/*
2372 * Set the allowed groups
2373 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002374void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2375 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002376{
Brett Warrene0edc842021-08-17 09:53:13 +01002377 conf->group_list = group_list;
2378}
2379
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002380#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine4ac40082025-02-20 18:13:58 +01002381
2382#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2383/** Whether mbedtls_ssl_set_hostname() has been called.
2384 *
2385 * \param[in] ssl SSL context
2386 *
2387 * \return \c 1 if mbedtls_ssl_set_hostname() has been called on \p ssl
2388 * (including `mbedtls_ssl_set_hostname(ssl, NULL)`),
2389 * otherwise \c 0.
2390 */
2391static int mbedtls_ssl_has_set_hostname_been_called(
2392 const mbedtls_ssl_context *ssl)
2393{
Gilles Peskine434016e2025-02-20 18:49:59 +01002394 return (ssl->flags & MBEDTLS_SSL_CONTEXT_FLAG_HOSTNAME_SET) != 0;
Gilles Peskine4ac40082025-02-20 18:13:58 +01002395}
2396#endif
2397
2398static void mbedtls_ssl_free_hostname(mbedtls_ssl_context *ssl)
2399{
2400 if (ssl->hostname != NULL) {
2401 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
2402 }
2403 ssl->hostname = NULL;
2404}
2405
Gilles Peskine449bd832023-01-11 14:50:10 +01002406int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002407{
Hanno Becker947194e2017-04-07 13:25:49 +01002408 /* Initialize to suppress unnecessary compiler warning */
2409 size_t hostname_len = 0;
2410
2411 /* Check if new hostname is valid before
2412 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 if (hostname != NULL) {
2414 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002415
Gilles Peskine449bd832023-01-11 14:50:10 +01002416 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2417 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2418 }
Hanno Becker947194e2017-04-07 13:25:49 +01002419 }
2420
2421 /* Now it's clear that we will overwrite the old hostname,
2422 * so we can free it safely */
Gilles Peskine4ac40082025-02-20 18:13:58 +01002423 mbedtls_ssl_free_hostname(ssl);
Hanno Becker947194e2017-04-07 13:25:49 +01002424
2425 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002426
Gilles Peskine449bd832023-01-11 14:50:10 +01002427 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002428 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002429 } else {
2430 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2431 if (ssl->hostname == NULL) {
2432 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2433 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002434
Gilles Peskine449bd832023-01-11 14:50:10 +01002435 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002436
Hanno Becker947194e2017-04-07 13:25:49 +01002437 ssl->hostname[hostname_len] = '\0';
2438 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002439
Gilles Peskine434016e2025-02-20 18:49:59 +01002440 ssl->flags |= MBEDTLS_SSL_CONTEXT_FLAG_HOSTNAME_SET;
2441
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002443}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002444#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002445
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002446#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002447void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2448 int (*f_sni)(void *, mbedtls_ssl_context *,
2449 const unsigned char *, size_t),
2450 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002451{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002452 conf->f_sni = f_sni;
2453 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002454}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002455#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002456
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002457#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskinec4949d12025-05-27 19:45:29 +02002458int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf,
2459 const char *const *protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002460{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002461 size_t cur_len, tot_len;
Gilles Peskinec4949d12025-05-27 19:45:29 +02002462 const char *const *p;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002463
2464 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002465 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2466 * MUST NOT be truncated."
2467 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002468 */
2469 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002470 for (p = protos; *p != NULL; p++) {
2471 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002472 tot_len += cur_len;
2473
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 if ((cur_len == 0) ||
2475 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2476 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2477 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2478 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002479 }
2480
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002481 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002482
Gilles Peskine449bd832023-01-11 14:50:10 +01002483 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002484}
2485
Gilles Peskine449bd832023-01-11 14:50:10 +01002486const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002487{
Gilles Peskine449bd832023-01-11 14:50:10 +01002488 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002489}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002490#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002491
Johan Pascalb62bb512015-12-03 21:56:45 +01002492#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002493void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2494 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002495{
2496 conf->dtls_srtp_mki_support = support_mki_value;
2497}
2498
Gilles Peskine449bd832023-01-11 14:50:10 +01002499int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2500 unsigned char *mki_value,
2501 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002502{
Gilles Peskine449bd832023-01-11 14:50:10 +01002503 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2504 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002505 }
Ron Eldor591f1622018-01-22 12:30:04 +02002506
Gilles Peskine449bd832023-01-11 14:50:10 +01002507 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2508 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002509 }
Ron Eldor591f1622018-01-22 12:30:04 +02002510
Gilles Peskine449bd832023-01-11 14:50:10 +01002511 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002512 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002513 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002514}
2515
Gilles Peskine449bd832023-01-11 14:50:10 +01002516int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2517 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002518{
Johan Pascal253d0262020-09-22 13:04:45 +02002519 const mbedtls_ssl_srtp_profile *p;
2520 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002521
Johan Pascal253d0262020-09-22 13:04:45 +02002522 /* check the profiles list: all entry must be valid,
2523 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002524 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2525 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2526 p++) {
2527 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002528 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002530 /* unsupported value, stop parsing and set the size to an error value */
2531 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002532 }
2533 }
2534
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2536 conf->dtls_srtp_profile_list = NULL;
2537 conf->dtls_srtp_profile_list_len = 0;
2538 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002539 }
2540
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002541 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002542 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002543
Gilles Peskine449bd832023-01-11 14:50:10 +01002544 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002545}
2546
Gilles Peskine449bd832023-01-11 14:50:10 +01002547void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2548 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002549{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002550 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2551 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002553 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002555 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2557 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002558 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002559}
Johan Pascalb62bb512015-12-03 21:56:45 +01002560#endif /* MBEDTLS_SSL_DTLS_SRTP */
2561
Janos Follath088ce432017-04-10 12:42:31 +01002562#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002563void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2564 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002565{
2566 conf->cert_req_ca_list = cert_req_ca_list;
2567}
2568#endif
2569
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002570#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002571void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002572{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002573 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002574}
2575#endif
2576
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002577#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002578void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002579{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002580 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002581}
2582#endif
2583
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002584#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002585int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002586{
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2588 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2589 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002590 }
2591
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002592 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002593
Gilles Peskine449bd832023-01-11 14:50:10 +01002594 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002595}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002596#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002597
Gilles Peskine449bd832023-01-11 14:50:10 +01002598void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002599{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002600 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002601}
2602
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002603#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002604void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002605{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002606 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002607}
2608
Gilles Peskine449bd832023-01-11 14:50:10 +01002609void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002610{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002611 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002612}
2613
Gilles Peskine449bd832023-01-11 14:50:10 +01002614void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2615 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002616{
Gilles Peskine449bd832023-01-11 14:50:10 +01002617 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002618}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002619#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker490ecc82011-10-06 13:04:09 +00002620
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002621#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002622#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002623void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002624{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002625 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002626}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002627#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002628
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002629#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002630
Jerry Yud0766ec2022-09-22 10:46:57 +08002631#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002632void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2633 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002634{
Jerry Yud0766ec2022-09-22 10:46:57 +08002635 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002636}
2637#endif
2638
Gilles Peskine449bd832023-01-11 14:50:10 +01002639void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2640 mbedtls_ssl_ticket_write_t *f_ticket_write,
2641 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2642 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02002643{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002644 conf->f_ticket_write = f_ticket_write;
2645 conf->f_ticket_parse = f_ticket_parse;
2646 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002647}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002648#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002649#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002650
Gilles Peskine449bd832023-01-11 14:50:10 +01002651void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
2652 mbedtls_ssl_export_keys_t *f_export_keys,
2653 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002654{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002655 ssl->f_export_keys = f_export_keys;
2656 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002657}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002658
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002659#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002660void mbedtls_ssl_conf_async_private_cb(
2661 mbedtls_ssl_config *conf,
2662 mbedtls_ssl_async_sign_t *f_async_sign,
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002663 mbedtls_ssl_async_resume_t *f_async_resume,
2664 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01002665 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002666{
2667 conf->f_async_sign_start = f_async_sign;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002668 conf->f_async_resume = f_async_resume;
2669 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002670 conf->p_async_config_data = async_config_data;
2671}
2672
Gilles Peskine449bd832023-01-11 14:50:10 +01002673void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02002674{
Gilles Peskine449bd832023-01-11 14:50:10 +01002675 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02002676}
2677
Gilles Peskine449bd832023-01-11 14:50:10 +01002678void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002679{
Gilles Peskine449bd832023-01-11 14:50:10 +01002680 if (ssl->handshake == NULL) {
2681 return NULL;
2682 } else {
2683 return ssl->handshake->user_async_ctx;
2684 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002685}
2686
Gilles Peskine449bd832023-01-11 14:50:10 +01002687void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2688 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002689{
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002691 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01002692 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002693}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002694#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002695
Paul Bakker5121ce52009-01-03 21:22:43 +00002696/*
2697 * SSL get accessors
2698 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002699uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002700{
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 if (ssl->session != NULL) {
2702 return ssl->session->verify_result;
2703 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002704
Gilles Peskine449bd832023-01-11 14:50:10 +01002705 if (ssl->session_negotiate != NULL) {
2706 return ssl->session_negotiate->verify_result;
2707 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002708
Gilles Peskine449bd832023-01-11 14:50:10 +01002709 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00002710}
2711
Gilles Peskine449bd832023-01-11 14:50:10 +01002712int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05002713{
Gilles Peskine449bd832023-01-11 14:50:10 +01002714 if (ssl == NULL || ssl->session == NULL) {
2715 return 0;
2716 }
Glenn Strauss8f526902022-01-13 00:04:49 -05002717
Gilles Peskine449bd832023-01-11 14:50:10 +01002718 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05002719}
2720
Gilles Peskine449bd832023-01-11 14:50:10 +01002721const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00002722{
Gilles Peskine449bd832023-01-11 14:50:10 +01002723 if (ssl == NULL || ssl->session == NULL) {
2724 return NULL;
2725 }
Paul Bakker926c8e42013-03-06 10:23:34 +01002726
Gilles Peskine449bd832023-01-11 14:50:10 +01002727 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00002728}
2729
Gilles Peskine449bd832023-01-11 14:50:10 +01002730const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00002731{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002732#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002733 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2734 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002735 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002736 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002737 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002738 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002739 }
2740 }
2741#endif
2742
Gilles Peskine449bd832023-01-11 14:50:10 +01002743 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002744 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002745 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04002746 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01002747 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002748 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002749 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002750 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002751}
2752
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002753#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2754
2755size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
2756{
2757 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2758 size_t record_size_limit = max_len;
2759
2760 if (ssl->session != NULL &&
2761 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2762 ssl->session->record_size_limit < max_len) {
2763 record_size_limit = ssl->session->record_size_limit;
2764 }
2765
2766 // TODO: this is currently untested
2767 /* During a handshake, use the value being negotiated */
2768 if (ssl->session_negotiate != NULL &&
2769 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2770 ssl->session_negotiate->record_size_limit < max_len) {
2771 record_size_limit = ssl->session_negotiate->record_size_limit;
2772 }
2773
2774 return record_size_limit;
2775}
2776#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2777
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002778#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002779size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002780{
David Horstmann95d516f2021-05-04 18:36:56 +01002781 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002782 size_t read_mfl;
2783
Jerry Yuddda0502022-12-01 19:43:12 +08002784#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002785 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01002786 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2787 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
2788 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002789 }
Jerry Yuddda0502022-12-01 19:43:12 +08002790#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002791
2792 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 if (ssl->session_out != NULL) {
2794 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
2795 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002796 max_len = read_mfl;
2797 }
2798 }
2799
Jerry Yuddda0502022-12-01 19:43:12 +08002800 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 if (ssl->session_negotiate != NULL) {
2802 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
2803 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002804 max_len = read_mfl;
2805 }
2806 }
2807
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002809}
2810
Gilles Peskine449bd832023-01-11 14:50:10 +01002811size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002812{
2813 size_t max_len;
2814
2815 /*
2816 * Assume mfl_code is correct since it was checked when set
2817 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002818 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002819
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002820 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 if (ssl->session_out != NULL &&
2822 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
2823 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002824 }
2825
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002826 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 if (ssl->session_negotiate != NULL &&
2828 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
2829 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002830 }
2831
Gilles Peskine449bd832023-01-11 14:50:10 +01002832 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002833}
2834#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2835
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002836#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002837size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002838{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002839 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002840 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2841 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2842 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
2843 return 0;
2844 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002845
Gilles Peskine449bd832023-01-11 14:50:10 +01002846 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
2847 return ssl->mtu;
2848 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002849
Gilles Peskine449bd832023-01-11 14:50:10 +01002850 if (ssl->mtu == 0) {
2851 return ssl->handshake->mtu;
2852 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002853
Gilles Peskine449bd832023-01-11 14:50:10 +01002854 return ssl->mtu < ssl->handshake->mtu ?
2855 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002856}
2857#endif /* MBEDTLS_SSL_PROTO_DTLS */
2858
Gilles Peskine449bd832023-01-11 14:50:10 +01002859int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002860{
2861 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2862
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002863#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002864 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002865 !defined(MBEDTLS_SSL_PROTO_DTLS)
2866 (void) ssl;
2867#endif
2868
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002869#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002870 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002871
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002873 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01002874 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002875#endif
2876
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002877#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2878 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
2879
2880 if (max_len > record_size_limit) {
2881 max_len = record_size_limit;
2882 }
2883#endif
2884
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002885 if (ssl->transform_out != NULL &&
2886 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00002887 /*
2888 * In TLS 1.3 case, when records are protected, `max_len` as computed
2889 * above is the maximum length of the TLSInnerPlaintext structure that
2890 * along the plaintext payload contains the inner content type (one byte)
2891 * and some zero padding. Given the algorithm used for padding
2892 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
2893 * the plaintext payload. Round down to a multiple of
2894 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
2895 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002896 */
2897 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
2898 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
2899 }
2900
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002901#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002902 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
2903 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
2904 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002905 const size_t overhead = (size_t) ret;
2906
Gilles Peskine449bd832023-01-11 14:50:10 +01002907 if (ret < 0) {
2908 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002909 }
2910
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 if (mtu <= overhead) {
2912 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
2913 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2914 }
2915
2916 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002917 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002919 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002920#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002921
Hanno Becker0defedb2018-08-10 12:35:02 +01002922#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00002923 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
2924 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01002925 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002926#endif
2927
Gilles Peskine449bd832023-01-11 14:50:10 +01002928 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002929}
2930
Gilles Peskine449bd832023-01-11 14:50:10 +01002931int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002932{
2933 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
2934
2935#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2936 (void) ssl;
2937#endif
2938
2939#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002940 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002941
Gilles Peskine449bd832023-01-11 14:50:10 +01002942 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002943 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01002944 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002945#endif
2946
Gilles Peskine449bd832023-01-11 14:50:10 +01002947 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01002948}
2949
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002950#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002951const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00002952{
Gilles Peskine449bd832023-01-11 14:50:10 +01002953 if (ssl == NULL || ssl->session == NULL) {
2954 return NULL;
2955 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00002956
Hanno Beckere6824572019-02-07 13:18:46 +00002957#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00002959#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002960 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00002961#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002962}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002963#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002964
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002965#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002966int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
2967 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002968{
Hanno Beckere810bbc2021-05-14 16:01:05 +01002969 int ret;
2970
Gilles Peskine449bd832023-01-11 14:50:10 +01002971 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002972 dst == NULL ||
2973 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
2975 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002976 }
2977
Hanno Beckere810bbc2021-05-14 16:01:05 +01002978 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
2979 * idempotent: Each session can only be exported once.
2980 *
2981 * (This is in preparation for TLS 1.3 support where we will
2982 * need the ability to export multiple sessions (aka tickets),
2983 * which will be achieved by calling mbedtls_ssl_get_session()
2984 * multiple times until it fails.)
2985 *
2986 * Check whether we have already exported the current session,
2987 * and fail if so.
2988 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002989 if (ssl->session->exported == 1) {
2990 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2991 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01002992
Gilles Peskine449bd832023-01-11 14:50:10 +01002993 ret = mbedtls_ssl_session_copy(dst, ssl->session);
2994 if (ret != 0) {
2995 return ret;
2996 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01002997
2998 /* Remember that we've exported the session. */
2999 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003000 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003001}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003002#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003003
David Horstmanncb01b362024-02-29 17:31:46 +00003004#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3005
3006/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003007 *
David Horstmanncb01b362024-02-29 17:31:46 +00003008 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003009 */
3010static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3011 unsigned char *buf,
3012 size_t buf_len)
3013{
3014 unsigned char *p = buf;
3015 size_t used = 0;
3016
3017#if defined(MBEDTLS_HAVE_TIME)
3018 uint64_t start;
3019#endif
3020#if defined(MBEDTLS_X509_CRT_PARSE_C)
3021#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3022 size_t cert_len;
3023#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3024#endif /* MBEDTLS_X509_CRT_PARSE_C */
3025
3026 /*
3027 * Time
3028 */
3029#if defined(MBEDTLS_HAVE_TIME)
3030 used += 8;
3031
3032 if (used <= buf_len) {
3033 start = (uint64_t) session->start;
3034
3035 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3036 p += 8;
3037 }
3038#endif /* MBEDTLS_HAVE_TIME */
3039
3040 /*
3041 * Basic mandatory fields
3042 */
3043 used += 1 /* id_len */
3044 + sizeof(session->id)
3045 + sizeof(session->master)
3046 + 4; /* verify_result */
3047
3048 if (used <= buf_len) {
3049 *p++ = MBEDTLS_BYTE_0(session->id_len);
3050 memcpy(p, session->id, 32);
3051 p += 32;
3052
3053 memcpy(p, session->master, 48);
3054 p += 48;
3055
3056 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3057 p += 4;
3058 }
3059
3060 /*
3061 * Peer's end-entity certificate
3062 */
3063#if defined(MBEDTLS_X509_CRT_PARSE_C)
3064#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3065 if (session->peer_cert == NULL) {
3066 cert_len = 0;
3067 } else {
3068 cert_len = session->peer_cert->raw.len;
3069 }
3070
3071 used += 3 + cert_len;
3072
3073 if (used <= buf_len) {
3074 *p++ = MBEDTLS_BYTE_2(cert_len);
3075 *p++ = MBEDTLS_BYTE_1(cert_len);
3076 *p++ = MBEDTLS_BYTE_0(cert_len);
3077
3078 if (session->peer_cert != NULL) {
3079 memcpy(p, session->peer_cert->raw.p, cert_len);
3080 p += cert_len;
3081 }
3082 }
3083#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3084 if (session->peer_cert_digest != NULL) {
3085 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3086 if (used <= buf_len) {
3087 *p++ = (unsigned char) session->peer_cert_digest_type;
3088 *p++ = (unsigned char) session->peer_cert_digest_len;
3089 memcpy(p, session->peer_cert_digest,
3090 session->peer_cert_digest_len);
3091 p += session->peer_cert_digest_len;
3092 }
3093 } else {
3094 used += 2;
3095 if (used <= buf_len) {
3096 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3097 *p++ = 0;
3098 }
3099 }
3100#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3101#endif /* MBEDTLS_X509_CRT_PARSE_C */
3102
3103 /*
3104 * Session ticket if any, plus associated data
3105 */
3106#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3107#if defined(MBEDTLS_SSL_CLI_C)
3108 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3109 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3110
3111 if (used <= buf_len) {
3112 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3113 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3114 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3115
3116 if (session->ticket != NULL) {
3117 memcpy(p, session->ticket, session->ticket_len);
3118 p += session->ticket_len;
3119 }
3120
3121 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3122 p += 4;
3123 }
3124 }
3125#endif /* MBEDTLS_SSL_CLI_C */
3126#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3127 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3128 used += 8;
3129
3130 if (used <= buf_len) {
3131 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3132 p += 8;
3133 }
3134 }
3135#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3136#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3137
3138 /*
3139 * Misc extension-related info
3140 */
3141#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3142 used += 1;
3143
3144 if (used <= buf_len) {
3145 *p++ = session->mfl_code;
3146 }
3147#endif
3148
3149#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3150 used += 1;
3151
3152 if (used <= buf_len) {
3153 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3154 }
3155#endif
3156
3157 return used;
3158}
3159
3160MBEDTLS_CHECK_RETURN_CRITICAL
3161static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3162 const unsigned char *buf,
3163 size_t len)
3164{
3165#if defined(MBEDTLS_HAVE_TIME)
3166 uint64_t start;
3167#endif
3168#if defined(MBEDTLS_X509_CRT_PARSE_C)
3169#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3170 size_t cert_len;
3171#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3172#endif /* MBEDTLS_X509_CRT_PARSE_C */
3173
3174 const unsigned char *p = buf;
3175 const unsigned char * const end = buf + len;
3176
3177 /*
3178 * Time
3179 */
3180#if defined(MBEDTLS_HAVE_TIME)
3181 if (8 > (size_t) (end - p)) {
3182 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3183 }
3184
3185 start = MBEDTLS_GET_UINT64_BE(p, 0);
3186 p += 8;
3187
3188 session->start = (time_t) start;
3189#endif /* MBEDTLS_HAVE_TIME */
3190
3191 /*
3192 * Basic mandatory fields
3193 */
3194 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3195 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3196 }
3197
3198 session->id_len = *p++;
3199 memcpy(session->id, p, 32);
3200 p += 32;
3201
3202 memcpy(session->master, p, 48);
3203 p += 48;
3204
3205 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3206 p += 4;
3207
3208 /* Immediately clear invalid pointer values that have been read, in case
3209 * we exit early before we replaced them with valid ones. */
3210#if defined(MBEDTLS_X509_CRT_PARSE_C)
3211#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3212 session->peer_cert = NULL;
3213#else
3214 session->peer_cert_digest = NULL;
3215#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3216#endif /* MBEDTLS_X509_CRT_PARSE_C */
3217#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3218 session->ticket = NULL;
3219#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3220
3221 /*
3222 * Peer certificate
3223 */
3224#if defined(MBEDTLS_X509_CRT_PARSE_C)
3225#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3226 /* Deserialize CRT from the end of the ticket. */
3227 if (3 > (size_t) (end - p)) {
3228 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3229 }
3230
3231 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3232 p += 3;
3233
3234 if (cert_len != 0) {
3235 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3236
3237 if (cert_len > (size_t) (end - p)) {
3238 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3239 }
3240
3241 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3242
3243 if (session->peer_cert == NULL) {
3244 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3245 }
3246
3247 mbedtls_x509_crt_init(session->peer_cert);
3248
3249 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3250 p, cert_len)) != 0) {
3251 mbedtls_x509_crt_free(session->peer_cert);
3252 mbedtls_free(session->peer_cert);
3253 session->peer_cert = NULL;
3254 return ret;
3255 }
3256
3257 p += cert_len;
3258 }
3259#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3260 /* Deserialize CRT digest from the end of the ticket. */
3261 if (2 > (size_t) (end - p)) {
3262 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3263 }
3264
3265 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3266 session->peer_cert_digest_len = (size_t) *p++;
3267
3268 if (session->peer_cert_digest_len != 0) {
3269 const mbedtls_md_info_t *md_info =
3270 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3271 if (md_info == NULL) {
3272 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3273 }
3274 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3275 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3276 }
3277
3278 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3279 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3280 }
3281
3282 session->peer_cert_digest =
3283 mbedtls_calloc(1, session->peer_cert_digest_len);
3284 if (session->peer_cert_digest == NULL) {
3285 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3286 }
3287
3288 memcpy(session->peer_cert_digest, p,
3289 session->peer_cert_digest_len);
3290 p += session->peer_cert_digest_len;
3291 }
3292#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3293#endif /* MBEDTLS_X509_CRT_PARSE_C */
3294
3295 /*
3296 * Session ticket and associated data
3297 */
3298#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3299#if defined(MBEDTLS_SSL_CLI_C)
3300 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3301 if (3 > (size_t) (end - p)) {
3302 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3303 }
3304
3305 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3306 p += 3;
3307
3308 if (session->ticket_len != 0) {
3309 if (session->ticket_len > (size_t) (end - p)) {
3310 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3311 }
3312
3313 session->ticket = mbedtls_calloc(1, session->ticket_len);
3314 if (session->ticket == NULL) {
3315 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3316 }
3317
3318 memcpy(session->ticket, p, session->ticket_len);
3319 p += session->ticket_len;
3320 }
3321
3322 if (4 > (size_t) (end - p)) {
3323 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3324 }
3325
3326 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3327 p += 4;
3328 }
3329#endif /* MBEDTLS_SSL_CLI_C */
3330#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3331 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3332 if (8 > (size_t) (end - p)) {
3333 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3334 }
3335 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3336 p += 8;
3337 }
3338#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3339#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3340
3341 /*
3342 * Misc extension-related info
3343 */
3344#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3345 if (1 > (size_t) (end - p)) {
3346 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3347 }
3348
3349 session->mfl_code = *p++;
3350#endif
3351
3352#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3353 if (1 > (size_t) (end - p)) {
3354 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3355 }
3356
3357 session->encrypt_then_mac = *p++;
3358#endif
3359
3360 /* Done, should have consumed entire buffer */
3361 if (p != end) {
3362 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3363 }
3364
3365 return 0;
3366}
3367
3368#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3369
3370#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3371/* Serialization of TLS 1.3 sessions:
3372 *
David Horstmanncb01b362024-02-29 17:31:46 +00003373 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003374 */
3375#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3376MBEDTLS_CHECK_RETURN_CRITICAL
3377static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3378 unsigned char *buf,
3379 size_t buf_len,
3380 size_t *olen)
3381{
3382 unsigned char *p = buf;
3383#if defined(MBEDTLS_SSL_CLI_C) && \
3384 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3385 size_t hostname_len = (session->hostname == NULL) ?
3386 0 : strlen(session->hostname) + 1;
3387#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003388
3389#if defined(MBEDTLS_SSL_SRV_C) && \
3390 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003391 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003392 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003393#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003394 size_t needed = 4 /* ticket_age_add */
3395 + 1 /* ticket_flags */
3396 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003397
David Horstmanne59f9702024-02-29 16:08:57 +00003398 *olen = 0;
3399
3400 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3401 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3402 }
3403 needed += session->resumption_key_len; /* resumption_key */
3404
3405#if defined(MBEDTLS_SSL_EARLY_DATA)
3406 needed += 4; /* max_early_data_size */
3407#endif
3408#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3409 needed += 2; /* record_size_limit */
3410#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3411
3412#if defined(MBEDTLS_HAVE_TIME)
3413 needed += 8; /* ticket_creation_time or ticket_reception_time */
3414#endif
3415
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003416#if defined(MBEDTLS_SSL_SRV_C)
3417 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3418#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003419 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003420 + alpn_len; /* alpn */
3421#endif
3422 }
3423#endif /* MBEDTLS_SSL_SRV_C */
3424
David Horstmanne59f9702024-02-29 16:08:57 +00003425#if defined(MBEDTLS_SSL_CLI_C)
3426 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3427#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3428 needed += 2 /* hostname_len */
3429 + hostname_len; /* hostname */
3430#endif
3431
3432 needed += 4 /* ticket_lifetime */
3433 + 2; /* ticket_len */
3434
3435 /* Check size_t overflow */
3436 if (session->ticket_len > SIZE_MAX - needed) {
3437 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3438 }
3439
3440 needed += session->ticket_len; /* ticket */
3441 }
3442#endif /* MBEDTLS_SSL_CLI_C */
3443
3444 *olen = needed;
3445 if (needed > buf_len) {
3446 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3447 }
3448
3449 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3450 p[4] = session->ticket_flags;
3451
3452 /* save resumption_key */
3453 p[5] = session->resumption_key_len;
3454 p += 6;
3455 memcpy(p, session->resumption_key, session->resumption_key_len);
3456 p += session->resumption_key_len;
3457
3458#if defined(MBEDTLS_SSL_EARLY_DATA)
3459 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3460 p += 4;
3461#endif
3462#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3463 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3464 p += 2;
3465#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3466
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003467#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003468 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003469#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003470 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3471 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003472#endif /* MBEDTLS_HAVE_TIME */
3473
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003474#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003475 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3476 p += 2;
3477
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003478 if (alpn_len > 0) {
3479 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003480 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003481 p += alpn_len;
3482 }
3483#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3484 }
3485#endif /* MBEDTLS_SSL_SRV_C */
3486
David Horstmanne59f9702024-02-29 16:08:57 +00003487#if defined(MBEDTLS_SSL_CLI_C)
3488 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3489#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3490 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3491 p += 2;
3492 if (hostname_len > 0) {
3493 /* save host name */
3494 memcpy(p, session->hostname, hostname_len);
3495 p += hostname_len;
3496 }
3497#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3498
3499#if defined(MBEDTLS_HAVE_TIME)
3500 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3501 p += 8;
3502#endif
3503 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3504 p += 4;
3505
3506 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3507 p += 2;
3508
3509 if (session->ticket != NULL && session->ticket_len > 0) {
3510 memcpy(p, session->ticket, session->ticket_len);
3511 p += session->ticket_len;
3512 }
3513 }
3514#endif /* MBEDTLS_SSL_CLI_C */
3515 return 0;
3516}
3517
3518MBEDTLS_CHECK_RETURN_CRITICAL
3519static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3520 const unsigned char *buf,
3521 size_t len)
3522{
3523 const unsigned char *p = buf;
3524 const unsigned char *end = buf + len;
3525
3526 if (end - p < 6) {
3527 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3528 }
3529 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3530 session->ticket_flags = p[4];
3531
3532 /* load resumption_key */
3533 session->resumption_key_len = p[5];
3534 p += 6;
3535
3536 if (end - p < session->resumption_key_len) {
3537 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3538 }
3539
3540 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3541 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3542 }
3543 memcpy(session->resumption_key, p, session->resumption_key_len);
3544 p += session->resumption_key_len;
3545
3546#if defined(MBEDTLS_SSL_EARLY_DATA)
3547 if (end - p < 4) {
3548 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3549 }
3550 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3551 p += 4;
3552#endif
3553#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3554 if (end - p < 2) {
3555 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3556 }
3557 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3558 p += 2;
3559#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3560
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003561#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003562 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003563#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003564 if (end - p < 8) {
3565 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3566 }
3567 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3568 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003569#endif /* MBEDTLS_HAVE_TIME */
3570
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003571#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003572 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003573
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003574 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003575 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3576 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003577
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003578 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3579 p += 2;
3580
3581 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003582 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3583 }
3584
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003585 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003586 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3587 if (ret != 0) {
3588 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003589 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003590 p += alpn_len;
3591 }
3592#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3593 }
3594#endif /* MBEDTLS_SSL_SRV_C */
3595
David Horstmanne59f9702024-02-29 16:08:57 +00003596#if defined(MBEDTLS_SSL_CLI_C)
3597 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3598#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3599 size_t hostname_len;
3600 /* load host name */
3601 if (end - p < 2) {
3602 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3603 }
3604 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3605 p += 2;
3606
3607 if (end - p < (long int) hostname_len) {
3608 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3609 }
3610 if (hostname_len > 0) {
3611 session->hostname = mbedtls_calloc(1, hostname_len);
3612 if (session->hostname == NULL) {
3613 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3614 }
3615 memcpy(session->hostname, p, hostname_len);
3616 p += hostname_len;
3617 }
3618#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3619
3620#if defined(MBEDTLS_HAVE_TIME)
3621 if (end - p < 8) {
3622 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3623 }
3624 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3625 p += 8;
3626#endif
3627 if (end - p < 4) {
3628 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3629 }
3630 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3631 p += 4;
3632
3633 if (end - p < 2) {
3634 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3635 }
3636 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
3637 p += 2;
3638
3639 if (end - p < (long int) session->ticket_len) {
3640 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3641 }
3642 if (session->ticket_len > 0) {
3643 session->ticket = mbedtls_calloc(1, session->ticket_len);
3644 if (session->ticket == NULL) {
3645 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3646 }
3647 memcpy(session->ticket, p, session->ticket_len);
3648 p += session->ticket_len;
3649 }
3650 }
3651#endif /* MBEDTLS_SSL_CLI_C */
3652
3653 return 0;
3654
3655}
3656#else /* MBEDTLS_SSL_SESSION_TICKETS */
3657MBEDTLS_CHECK_RETURN_CRITICAL
3658static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3659 unsigned char *buf,
3660 size_t buf_len,
3661 size_t *olen)
3662{
3663 ((void) session);
3664 ((void) buf);
3665 ((void) buf_len);
3666 *olen = 0;
3667 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3668}
3669
3670static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01003671 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00003672 size_t buf_len)
3673{
3674 ((void) session);
3675 ((void) buf);
3676 ((void) buf_len);
3677 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3678}
3679#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
3680#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3681
Paul Bakker5121ce52009-01-03 21:22:43 +00003682/*
Hanno Beckera835da52019-05-16 12:39:07 +01003683 * Define ticket header determining Mbed TLS version
3684 * and structure of the ticket.
3685 */
3686
Hanno Becker94ef3b32019-05-16 12:50:45 +01003687/*
Hanno Becker50b59662019-05-28 14:30:45 +01003688 * Define bitflag determining compile-time settings influencing
3689 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003690 */
3691
Hanno Becker50b59662019-05-28 14:30:45 +01003692#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003693#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003694#else
Hanno Becker3e088662019-05-29 11:10:18 +01003695#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003696#endif /* MBEDTLS_HAVE_TIME */
3697
3698#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003699#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003700#else
Hanno Becker3e088662019-05-29 11:10:18 +01003701#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003702#endif /* MBEDTLS_X509_CRT_PARSE_C */
3703
David Horstmann5c5a32f2024-02-13 17:53:35 +00003704#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00003705#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00003706#else
David Horstmannf686f1d2024-03-01 11:20:32 +00003707#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00003708#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3709
Hanno Becker94ef3b32019-05-16 12:50:45 +01003710#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003711#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003712#else
Hanno Becker3e088662019-05-29 11:10:18 +01003713#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003714#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3715
3716#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003717#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003718#else
Hanno Becker3e088662019-05-29 11:10:18 +01003719#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003720#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3721
Hanno Becker94ef3b32019-05-16 12:50:45 +01003722#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003723#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003724#else
Hanno Becker3e088662019-05-29 11:10:18 +01003725#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003726#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3727
Hanno Becker94ef3b32019-05-16 12:50:45 +01003728#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3729#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3730#else
3731#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3732#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3733
David Horstmann92b258b2024-02-13 17:23:34 +00003734#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3735#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
3736#else
3737#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
3738#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3739
3740#if defined(MBEDTLS_SSL_EARLY_DATA)
3741#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
3742#else
3743#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
3744#endif /* MBEDTLS_SSL_EARLY_DATA */
3745
3746#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3747#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
3748#else
3749#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
3750#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3751
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003752#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
3753 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00003754#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
3755#else
3756#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
3757#endif /* MBEDTLS_SSL_ALPN */
3758
Hanno Becker3e088662019-05-29 11:10:18 +01003759#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3760#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3761#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3762#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003763#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3764#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00003765#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00003766#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
3767#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
3768#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00003769#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01003770
Hanno Becker50b59662019-05-28 14:30:45 +01003771#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003772 ((uint16_t) ( \
3773 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3774 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3775 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3776 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3777 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3778 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00003779 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00003780 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
3781 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00003782 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
3783 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
3784 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
3785 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003786 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00003787 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003788 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003789
Chien Wong4e9683e2023-12-28 17:07:43 +08003790static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003791 MBEDTLS_VERSION_MAJOR,
3792 MBEDTLS_VERSION_MINOR,
3793 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003794 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3795 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003796};
Hanno Beckera835da52019-05-16 12:39:07 +01003797
3798/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003799 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003800 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003801 *
David Horstmanncb01b362024-02-29 17:31:46 +00003802 * TLS 1.2 session:
3803 *
3804 * struct {
3805 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
3806 * opaque ticket<0..2^24-1>; // length 0 means no ticket
3807 * uint32 ticket_lifetime;
3808 * #endif
3809 * } ClientOnlyData;
3810 *
3811 * struct {
3812 * #if defined(MBEDTLS_HAVE_TIME)
3813 * uint64 start_time;
3814 * #endif
3815 * uint8 session_id_len; // at most 32
3816 * opaque session_id[32];
3817 * opaque master[48]; // fixed length in the standard
3818 * uint32 verify_result;
3819 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
3820 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
3821 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00003822 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00003823 * opaque peer_cert_digest<0..2^8-1>
3824 * #endif
3825 * select (endpoint) {
3826 * case client: ClientOnlyData;
3827 * case server: uint64 ticket_creation_time;
3828 * };
3829 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3830 * uint8 mfl_code; // up to 255 according to standard
3831 * #endif
3832 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3833 * uint8 encrypt_then_mac; // 0 or 1
3834 * #endif
3835 * } serialized_session_tls12;
3836 *
3837 *
3838 * TLS 1.3 Session:
3839 *
3840 * struct {
3841 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3842 * opaque hostname<0..2^16-1>;
3843 * #endif
3844 * #if defined(MBEDTLS_HAVE_TIME)
3845 * uint64 ticket_reception_time;
3846 * #endif
3847 * uint32 ticket_lifetime;
3848 * opaque ticket<1..2^16-1>;
3849 * } ClientOnlyData;
3850 *
3851 * struct {
3852 * uint32 ticket_age_add;
3853 * uint8 ticket_flags;
3854 * opaque resumption_key<0..255>;
3855 * #if defined(MBEDTLS_SSL_EARLY_DATA)
3856 * uint32 max_early_data_size;
3857 * #endif
3858 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3859 * uint16 record_size_limit;
3860 * #endif
3861 * select ( endpoint ) {
3862 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003863 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00003864 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003865 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00003866 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00003867 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003868 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00003869 * #endif
3870 * };
3871 * } serialized_session_tls13;
3872 *
3873 *
3874 * SSL session:
3875 *
3876 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003877 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003878 * opaque mbedtls_version[3]; // library version: major, minor, patch
3879 * opaque session_format[2]; // library-version specific 16-bit field
3880 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003881 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003882 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003883 * Note: When updating the format, remember to keep
3884 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003885 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003886 * // In this version, `session_format` determines
3887 * // the setting of those compile-time
3888 * // configuration options which influence
3889 * // the structure of mbedtls_ssl_session.
3890 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003891 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003892 * // - TLS 1.2 (0x0303)
3893 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00003894 * uint8_t endpoint;
3895 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003896 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003897 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003898 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003899 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003900 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003901 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003902 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003903 *
3904 * };
3905 *
3906 * } serialized_session;
3907 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003908 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003909
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003910MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003911static int ssl_session_save(const mbedtls_ssl_session *session,
3912 unsigned char omit_header,
3913 unsigned char *buf,
3914 size_t buf_len,
3915 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003916{
3917 unsigned char *p = buf;
3918 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08003919 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08003920#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3921 size_t out_len;
3922 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3923#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01003924 if (session == NULL) {
3925 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
3926 }
Jerry Yu438ddd82022-07-07 06:55:50 +00003927
Gilles Peskine449bd832023-01-11 14:50:10 +01003928 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003929 /*
3930 * Add Mbed TLS version identifier
3931 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003932 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003933
Gilles Peskine449bd832023-01-11 14:50:10 +01003934 if (used <= buf_len) {
3935 memcpy(p, ssl_serialized_session_header,
3936 sizeof(ssl_serialized_session_header));
3937 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003938 }
3939 }
3940
3941 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01003942 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003943 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01003944 used += 1 /* TLS version */
3945 + 1 /* endpoint */
3946 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01003947 if (used <= buf_len) {
3948 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01003949 *p++ = session->endpoint;
3950 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
3951 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003952 }
3953
3954 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08003955 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003956 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003957#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01003958 case MBEDTLS_SSL_VERSION_TLS1_2:
3959 used += ssl_tls12_session_save(session, p, remaining_len);
3960 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003961#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3962
Jerry Yu251a12e2022-07-13 15:15:48 +08003963#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01003964 case MBEDTLS_SSL_VERSION_TLS1_3:
3965 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
3966 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
3967 return ret;
3968 }
3969 used += out_len;
3970 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08003971#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3972
Gilles Peskine449bd832023-01-11 14:50:10 +01003973 default:
3974 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003975 }
3976
3977 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01003978 if (used > buf_len) {
3979 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3980 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003981
Gilles Peskine449bd832023-01-11 14:50:10 +01003982 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003983}
3984
3985/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003986 * Public wrapper for ssl_session_save()
3987 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003988int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3989 unsigned char *buf,
3990 size_t buf_len,
3991 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003992{
Gilles Peskine449bd832023-01-11 14:50:10 +01003993 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02003994}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003995
Jerry Yuf1b23ca2022-02-18 11:48:47 +08003996/*
3997 * Deserialize session, see mbedtls_ssl_session_save() for format.
3998 *
3999 * This internal version is wrapped by a public function that cleans up in
4000 * case of error, and has an extra option omit_header.
4001 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004002MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004003static int ssl_session_load(mbedtls_ssl_session *session,
4004 unsigned char omit_header,
4005 const unsigned char *buf,
4006 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004007{
4008 const unsigned char *p = buf;
4009 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004010 size_t remaining_len;
4011
4012
Gilles Peskine449bd832023-01-11 14:50:10 +01004013 if (session == NULL) {
4014 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4015 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004016
Gilles Peskine449bd832023-01-11 14:50:10 +01004017 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004018 /*
4019 * Check Mbed TLS version identifier
4020 */
4021
Gilles Peskine449bd832023-01-11 14:50:10 +01004022 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4023 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004024 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004025
4026 if (memcmp(p, ssl_serialized_session_header,
4027 sizeof(ssl_serialized_session_header)) != 0) {
4028 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4029 }
4030 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004031 }
4032
4033 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004034 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004035 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004036 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004037 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4038 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004039 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004040 session->endpoint = *p++;
4041 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4042 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004043
4044 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004045 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004046 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004047#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004048 case MBEDTLS_SSL_VERSION_TLS1_2:
4049 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004050#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4051
Jerry Yu438ddd82022-07-07 06:55:50 +00004052#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004053 case MBEDTLS_SSL_VERSION_TLS1_3:
4054 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004055#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4056
Gilles Peskine449bd832023-01-11 14:50:10 +01004057 default:
4058 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004059 }
4060}
4061
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004062/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004063 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004064 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004065int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4066 const unsigned char *buf,
4067 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004068{
Gilles Peskine449bd832023-01-11 14:50:10 +01004069 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004070
Gilles Peskine449bd832023-01-11 14:50:10 +01004071 if (ret != 0) {
4072 mbedtls_ssl_session_free(session);
4073 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004074
Gilles Peskine449bd832023-01-11 14:50:10 +01004075 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004076}
4077
4078/*
Paul Bakker1961b702013-01-25 14:49:24 +01004079 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004080 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004081MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004082static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004083{
4084 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4085
Ronald Cron66dbf912022-02-02 15:33:46 +01004086 /*
4087 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004088 * that were written into the output buffer by the previous handshake step,
4089 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004090 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4091 * We proceed to the next handshake step only when all data from the
4092 * previous one have been sent to the peer, thus we make sure that this is
4093 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4094 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4095 * we have to wait before to go ahead.
4096 * In the case of TLS 1.3, handshake step handlers do not send data to the
4097 * peer. Data are only sent here and through
4098 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004099 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004100 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004101 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4102 return ret;
4103 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004104
4105#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004106 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4107 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4108 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4109 return ret;
4110 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004111 }
4112#endif /* MBEDTLS_SSL_PROTO_DTLS */
4113
Gilles Peskine449bd832023-01-11 14:50:10 +01004114 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004115}
4116
Gilles Peskine449bd832023-01-11 14:50:10 +01004117int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004118{
Hanno Becker41934dd2021-08-07 19:13:43 +01004119 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004120
Gilles Peskine449bd832023-01-11 14:50:10 +01004121 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004122 ssl->conf == NULL ||
4123 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004124 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4125 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004126 }
4127
Gilles Peskine449bd832023-01-11 14:50:10 +01004128 ret = ssl_prepare_handshake_step(ssl);
4129 if (ret != 0) {
4130 return ret;
4131 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004132
Gilles Peskine449bd832023-01-11 14:50:10 +01004133 ret = mbedtls_ssl_handle_pending_alert(ssl);
4134 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004135 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 }
Jerry Yue7047812021-09-13 19:26:39 +08004137
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004138 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4139 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4140 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4141
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004142#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004143 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4144 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004145 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004146
Gilles Peskine449bd832023-01-11 14:50:10 +01004147 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004148 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskinef670ba52025-03-07 15:09:32 +01004149 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004150 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004151 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004152
Ronald Cron9f0fba32022-02-10 16:45:15 +01004153 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004154 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004155 break;
4156
4157 default:
4158#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004159 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4160 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4161 } else {
4162 ret = mbedtls_ssl_handshake_client_step(ssl);
4163 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004164#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004165 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004166#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004167 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004168#endif
4169 }
Jerry Yub9930e72021-08-06 17:11:51 +08004170 }
Ronald Cron6291b232023-03-08 15:51:25 +01004171#endif /* MBEDTLS_SSL_CLI_C */
4172
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004173#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004174 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004175#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4176 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004177 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004178 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004179 ret = mbedtls_ssl_handshake_server_step(ssl);
4180 }
Ronald Cron6291b232023-03-08 15:51:25 +01004181#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4182 ret = mbedtls_ssl_handshake_server_step(ssl);
4183#else
4184 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004185#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004186 }
4187#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004188
Gilles Peskine449bd832023-01-11 14:50:10 +01004189 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004190 /* handshake_step return error. And it is same
4191 * with alert_reason.
4192 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004193 if (ssl->send_alert) {
4194 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004195 goto cleanup;
4196 }
4197 }
4198
4199cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004200 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004201}
4202
4203/*
4204 * Perform the SSL handshake
4205 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004206int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004207{
4208 int ret = 0;
4209
Hanno Beckera817ea42020-10-20 15:20:23 +01004210 /* Sanity checks */
4211
Gilles Peskine449bd832023-01-11 14:50:10 +01004212 if (ssl == NULL || ssl->conf == NULL) {
4213 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4214 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004215
Hanno Beckera817ea42020-10-20 15:20:23 +01004216#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004217 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4218 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4219 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4220 "mbedtls_ssl_set_timer_cb() for DTLS"));
4221 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004222 }
4223#endif /* MBEDTLS_SSL_PROTO_DTLS */
4224
Gilles Peskine449bd832023-01-11 14:50:10 +01004225 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004226
Hanno Beckera817ea42020-10-20 15:20:23 +01004227 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004228 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4229 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004230
Gilles Peskine449bd832023-01-11 14:50:10 +01004231 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004232 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004233 }
Paul Bakker1961b702013-01-25 14:49:24 +01004234 }
4235
Gilles Peskine449bd832023-01-11 14:50:10 +01004236 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004237
Gilles Peskine449bd832023-01-11 14:50:10 +01004238 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004239}
4240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004241#if defined(MBEDTLS_SSL_RENEGOTIATION)
4242#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004243/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004244 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004245 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004246MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004247static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004248{
Janos Follath865b3eb2019-12-16 11:46:15 +00004249 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004250
Gilles Peskine449bd832023-01-11 14:50:10 +01004251 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004252
4253 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004254 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4255 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004256
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4258 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4259 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004260 }
4261
Gilles Peskine449bd832023-01-11 14:50:10 +01004262 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004263
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004265}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004266#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004267
4268/*
4269 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004270 * - any side: calling mbedtls_ssl_renegotiate(),
4271 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4272 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004273 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004274 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004275 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004276 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004277int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004278{
Janos Follath865b3eb2019-12-16 11:46:15 +00004279 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004280
Gilles Peskine449bd832023-01-11 14:50:10 +01004281 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004282
Gilles Peskine449bd832023-01-11 14:50:10 +01004283 if ((ret = ssl_handshake_init(ssl)) != 0) {
4284 return ret;
4285 }
Paul Bakker48916f92012-09-16 19:57:18 +00004286
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004287 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4288 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004289#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4291 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4292 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004293 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004295 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004296 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004297 }
4298#endif
4299
Gilles Peskinef670ba52025-03-07 15:09:32 +01004300 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_REQUEST);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004301 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004302
Gilles Peskine449bd832023-01-11 14:50:10 +01004303 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4304 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4305 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004306 }
4307
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004309
Gilles Peskine449bd832023-01-11 14:50:10 +01004310 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004311}
4312
4313/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004314 * Renegotiate current connection on client,
4315 * or request renegotiation on server
4316 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004317int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004318{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004319 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004320
Gilles Peskine449bd832023-01-11 14:50:10 +01004321 if (ssl == NULL || ssl->conf == NULL) {
4322 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4323 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004324
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004325#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004326 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004327 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4328 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4329 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4330 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004331
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004332 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004333
4334 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004335 if (ssl->out_left != 0) {
4336 return mbedtls_ssl_flush_output(ssl);
4337 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004338
Gilles Peskine449bd832023-01-11 14:50:10 +01004339 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004340 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004341#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004342
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004343#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004344 /*
4345 * On client, either start the renegotiation process or,
4346 * if already in progress, continue the handshake
4347 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004348 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4349 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4350 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004351 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004352
4353 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4354 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4355 return ret;
4356 }
4357 } else {
4358 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4359 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4360 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004361 }
4362 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004363#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004364
Gilles Peskine449bd832023-01-11 14:50:10 +01004365 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004366}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004367#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004368
Gilles Peskine449bd832023-01-11 14:50:10 +01004369void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004370{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004371 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4372
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004374 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004375 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004376
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004377#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Brett Warrene0edc842021-08-17 09:53:13 +01004378#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004379 if (ssl->handshake->group_list_heap_allocated) {
4380 mbedtls_free((void *) handshake->group_list);
4381 }
Brett Warrene0edc842021-08-17 09:53:13 +01004382 handshake->group_list = NULL;
4383#endif /* MBEDTLS_DEPRECATED_REMOVED */
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004384#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Brett Warrene0edc842021-08-17 09:53:13 +01004385
Ronald Crone68ab4f2022-10-05 12:46:29 +02004386#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004387#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004388 if (ssl->handshake->sig_algs_heap_allocated) {
4389 mbedtls_free((void *) handshake->sig_algs);
4390 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004391 handshake->sig_algs = NULL;
4392#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004393#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004394 if (ssl->handshake->certificate_request_context) {
4395 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004396 }
4397#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004398#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004399
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004400#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Ben Taylorcd2660f2025-03-21 13:13:29 +00004401 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
Ben Taylorc12152e2025-03-21 11:03:04 +00004402 ssl->conf->f_async_cancel(ssl);
4403 handshake->async_in_progress = 0;
Ben Taylor1cd1e012025-03-18 11:50:39 +00004404 }
Ben Taylor6ff2da12025-03-17 09:26:20 +00004405
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004406#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4407
Elena Uziunaite0916cd72024-05-23 17:01:07 +01004408#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01004409 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004410#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01004411#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01004412 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004413#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004414
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004415#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004416 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004417 /*
4418 * Opaque keys are not stored in the handshake's data and it's the user
4419 * responsibility to destroy them. Clear ones, instead, are created by
4420 * the TLS library and should be destroyed at the same level
4421 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004422 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4423 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004424 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004425 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004426#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004427 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004428 handshake->ecjpake_cache = NULL;
4429 handshake->ecjpake_cache_len = 0;
4430#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004431#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004432
Valerio Setti7aeec542023-07-05 18:57:21 +02004433#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004434 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004435 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004436 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004438#endif
4439
Ronald Cron73fe8df2022-10-05 14:31:43 +02004440#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004441 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004442 /* The maintenance of the external PSK key slot is the
4443 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 if (ssl->handshake->psk_opaque_is_internal) {
4445 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004446 ssl->handshake->psk_opaque_is_internal = 0;
4447 }
4448 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4449 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02004450#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004451
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004452#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4453 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004454 /*
4455 * Free only the linked list wrapper, not the keys themselves
4456 * since the belong to the SNI callback
4457 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004458 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004459#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004460
Gilles Peskineeccd8882020-03-10 12:19:08 +01004461#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004462 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4463 if (handshake->ecrs_peer_cert != NULL) {
4464 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4465 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004466 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004467#endif
4468
Hanno Becker75173122019-02-06 16:18:31 +00004469#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4470 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004471 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004472#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4473
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004474#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004475 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4476 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004477#endif /* MBEDTLS_SSL_CLI_C &&
4478 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004479
4480#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004481 mbedtls_ssl_flight_free(handshake->flight);
4482 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004483#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004484
Valerio Settiea59c432023-07-25 11:14:03 +02004485#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004486 if (handshake->xxdh_psa_privkey_is_external == 0) {
4487 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 }
Valerio Settiea59c432023-07-25 11:14:03 +02004489#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004490
Ronald Cron6f135e12021-12-08 16:57:54 +01004491#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 mbedtls_ssl_transform_free(handshake->transform_handshake);
4493 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004494#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004495 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4496 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004497#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004498#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004499
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004500
4501#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4502 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4503 * processes datagrams and the fact that a datagram is allowed to have
4504 * several records in it, it is possible that the I/O buffers are not
4505 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4507 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004508#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004509
Jerry Yuba9c7272021-10-30 11:54:10 +08004510 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004511 mbedtls_platform_zeroize(handshake,
4512 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004513}
4514
Gilles Peskine449bd832023-01-11 14:50:10 +01004515void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004516{
Gilles Peskine449bd832023-01-11 14:50:10 +01004517 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004518 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004519 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004520
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004521#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004522 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004523#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004524
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004525#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004526#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4527 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004528 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004529#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004530 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004531#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004532
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004533#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4534 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004535 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004536#endif
4537
Gilles Peskine449bd832023-01-11 14:50:10 +01004538 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004539}
4540
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004541#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004542
4543#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4544#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4545#else
4546#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4547#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4548
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004549#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004550
4551#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4552#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4553#else
4554#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4555#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4556
4557#if defined(MBEDTLS_SSL_ALPN)
4558#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4559#else
4560#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4561#endif /* MBEDTLS_SSL_ALPN */
4562
4563#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4564#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4565#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4566#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4567
4568#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004569 ((uint32_t) ( \
4570 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4571 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4572 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4573 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4574 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4575 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4576 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4577 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004578
Chien Wong4e9683e2023-12-28 17:07:43 +08004579static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004580 MBEDTLS_VERSION_MAJOR,
4581 MBEDTLS_VERSION_MINOR,
4582 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004583 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4584 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4585 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4586 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4587 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004588};
4589
Paul Bakker5121ce52009-01-03 21:22:43 +00004590/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004591 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004592 *
4593 * The format of the serialized data is:
4594 * (in the presentation language of TLS, RFC 8446 section 3)
4595 *
4596 * // header
4597 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004598 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004599 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004600 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004601 * Note: When updating the format, remember to keep these
4602 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004603 *
4604 * // session sub-structure
4605 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4606 * // transform sub-structure
4607 * uint8 random[64]; // ServerHello.random+ClientHello.random
4608 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4609 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4610 * // fields from ssl_context
4611 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4612 * uint64 in_window_top; // DTLS: last validated record seq_num
4613 * uint64 in_window; // DTLS: bitmask for replay protection
4614 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4615 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4616 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4617 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4618 *
4619 * Note that many fields of the ssl_context or sub-structures are not
4620 * serialized, as they fall in one of the following categories:
4621 *
4622 * 1. forced value (eg in_left must be 0)
4623 * 2. pointer to dynamically-allocated memory (eg session, transform)
4624 * 3. value can be re-derived from other data (eg session keys from MS)
4625 * 4. value was temporary (eg content of input buffer)
4626 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004627 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004628int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4629 unsigned char *buf,
4630 size_t buf_len,
4631 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004632{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004633 unsigned char *p = buf;
4634 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004635 size_t session_len;
4636 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004637
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004638 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004639 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4640 * this function's documentation.
4641 *
4642 * These are due to assumptions/limitations in the implementation. Some of
4643 * them are likely to stay (no handshake in progress) some might go away
4644 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004645 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004646 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4648 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4649 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004650 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004651 if (ssl->handshake != NULL) {
4652 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
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 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004656 if (ssl->transform == NULL || ssl->session == NULL) {
4657 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
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 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 if (mbedtls_ssl_check_pending(ssl) != 0) {
4662 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4663 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004664 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004665 if (ssl->out_left != 0) {
4666 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4667 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004668 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004669 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4671 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4672 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004673 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004674 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004675 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4676 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4677 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004678 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004679 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4681 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4682 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004683 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004684 /* Renegotiation must not be enabled */
4685#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4687 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4688 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004689 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004690#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004691
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004692 /*
4693 * Version and format identifier
4694 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004695 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004696
Gilles Peskine449bd832023-01-11 14:50:10 +01004697 if (used <= buf_len) {
4698 memcpy(p, ssl_serialized_context_header,
4699 sizeof(ssl_serialized_context_header));
4700 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004701 }
4702
4703 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004704 * Session (length + data)
4705 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004706 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4707 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4708 return ret;
4709 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004710
4711 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 if (used <= buf_len) {
4713 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004714 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004715
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 ret = ssl_session_save(ssl->session, 1,
4717 p, session_len, &session_len);
4718 if (ret != 0) {
4719 return ret;
4720 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004721
4722 p += session_len;
4723 }
4724
4725 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004726 * Transform
4727 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004728 used += sizeof(ssl->transform->randbytes);
4729 if (used <= buf_len) {
4730 memcpy(p, ssl->transform->randbytes,
4731 sizeof(ssl->transform->randbytes));
4732 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004733 }
4734
4735#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004736 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004738 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004740 p += ssl->transform->in_cid_len;
4741
4742 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004743 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004744 p += ssl->transform->out_cid_len;
4745 }
4746#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4747
4748 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004749 * Saved fields from top-level ssl_context structure
4750 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004751 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004752 if (used <= buf_len) {
4753 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004754 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004755 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004756
4757#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4758 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 if (used <= buf_len) {
4760 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004761 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004762
Gilles Peskine449bd832023-01-11 14:50:10 +01004763 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004764 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004765 }
4766#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4767
4768#if defined(MBEDTLS_SSL_PROTO_DTLS)
4769 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004770 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004771 *p++ = ssl->disable_datagram_packing;
4772 }
4773#endif /* MBEDTLS_SSL_PROTO_DTLS */
4774
Jerry Yuae0b2e22021-10-08 15:21:19 +08004775 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004776 if (used <= buf_len) {
4777 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004778 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004779 }
4780
4781#if defined(MBEDTLS_SSL_PROTO_DTLS)
4782 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004783 if (used <= buf_len) {
4784 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004785 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004786 }
4787#endif /* MBEDTLS_SSL_PROTO_DTLS */
4788
4789#if defined(MBEDTLS_SSL_ALPN)
4790 {
4791 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004792 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004793 : 0;
4794
4795 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004796 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004797 *p++ = alpn_len;
4798
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 if (ssl->alpn_chosen != NULL) {
4800 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004801 p += alpn_len;
4802 }
4803 }
4804 }
4805#endif /* MBEDTLS_SSL_ALPN */
4806
4807 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004808 * Done
4809 */
4810 *olen = used;
4811
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 if (used > buf_len) {
4813 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4814 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004815
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004817
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004819}
4820
4821/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004822 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004823 *
4824 * This internal version is wrapped by a public function that cleans up in
4825 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004826 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004827MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004828static int ssl_context_load(mbedtls_ssl_context *ssl,
4829 const unsigned char *buf,
4830 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004831{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004832 const unsigned char *p = buf;
4833 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004834 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004835 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004836#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004837 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004838#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004839
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004840 /*
4841 * The context should have been freshly setup or reset.
4842 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004843 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004844 * renegotiating, or if the user mistakenly loaded a session first.)
4845 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004846 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4847 ssl->session != NULL) {
4848 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004849 }
4850
4851 /*
4852 * We can't check that the config matches the initial one, but we can at
4853 * least check it matches the requirements for serializing.
4854 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004855 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004856#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004857 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004858#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004859 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4860 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4861 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4862 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004863 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004864 }
4865
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004867
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004868 /*
4869 * Check version identifier
4870 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004871 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4872 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004873 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004874
4875 if (memcmp(p, ssl_serialized_context_header,
4876 sizeof(ssl_serialized_context_header)) != 0) {
4877 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4878 }
4879 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004880
4881 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004882 * Session
4883 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004884 if ((size_t) (end - p) < 4) {
4885 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4886 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004887
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004888 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004889 p += 4;
4890
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004891 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004892 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004893 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004894 ssl->session_in = ssl->session;
4895 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004896 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004897
Gilles Peskine449bd832023-01-11 14:50:10 +01004898 if ((size_t) (end - p) < session_len) {
4899 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4900 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004901
Gilles Peskine449bd832023-01-11 14:50:10 +01004902 ret = ssl_session_load(ssl->session, 1, p, session_len);
4903 if (ret != 0) {
4904 mbedtls_ssl_session_free(ssl->session);
4905 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004906 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004907
4908 p += session_len;
4909
4910 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004911 * Transform
4912 */
4913
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004914 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004915 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08004916#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004917 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004918 ssl->transform_in = ssl->transform;
4919 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004920 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08004921#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004922
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004923#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
4925 if (prf_func == NULL) {
4926 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4927 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04004928
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004929 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
4931 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4932 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004933
Gilles Peskine449bd832023-01-11 14:50:10 +01004934 ret = ssl_tls12_populate_transform(ssl->transform,
4935 ssl->session->ciphersuite,
4936 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004937#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004938 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02004939#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01004940 prf_func,
4941 p, /* currently pointing to randbytes */
4942 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
4943 ssl->conf->endpoint,
4944 ssl);
4945 if (ret != 0) {
4946 return ret;
4947 }
Jerry Yu840fbb22022-02-17 14:59:29 +08004948#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004949 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004950
4951#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4952 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 if ((size_t) (end - p) < 1) {
4954 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4955 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004956
4957 ssl->transform->in_cid_len = *p++;
4958
Gilles Peskine449bd832023-01-11 14:50:10 +01004959 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
4960 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4961 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004962
Gilles Peskine449bd832023-01-11 14:50:10 +01004963 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004964 p += ssl->transform->in_cid_len;
4965
4966 ssl->transform->out_cid_len = *p++;
4967
Gilles Peskine449bd832023-01-11 14:50:10 +01004968 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
4969 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4970 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004971
Gilles Peskine449bd832023-01-11 14:50:10 +01004972 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004973 p += ssl->transform->out_cid_len;
4974#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4975
4976 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004977 * Saved fields from top-level ssl_context structure
4978 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004979 if ((size_t) (end - p) < 4) {
4980 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4981 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004982
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004983 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004984 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004985
4986#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01004987 if ((size_t) (end - p) < 16) {
4988 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4989 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004990
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004991 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004992 p += 8;
4993
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004994 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004995 p += 8;
4996#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4997
4998#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004999 if ((size_t) (end - p) < 1) {
5000 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5001 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005002
5003 ssl->disable_datagram_packing = *p++;
5004#endif /* MBEDTLS_SSL_PROTO_DTLS */
5005
Gilles Peskine449bd832023-01-11 14:50:10 +01005006 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5007 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5008 }
5009 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5010 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005011
5012#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005013 if ((size_t) (end - p) < 2) {
5014 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5015 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005016
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005017 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005018 p += 2;
5019#endif /* MBEDTLS_SSL_PROTO_DTLS */
5020
5021#if defined(MBEDTLS_SSL_ALPN)
5022 {
5023 uint8_t alpn_len;
Gilles Peskinec4949d12025-05-27 19:45:29 +02005024 const char *const *cur;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005025
Gilles Peskine449bd832023-01-11 14:50:10 +01005026 if ((size_t) (end - p) < 1) {
5027 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5028 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005029
5030 alpn_len = *p++;
5031
Gilles Peskine449bd832023-01-11 14:50:10 +01005032 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005033 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005034 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5035 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005036 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005037 ssl->alpn_chosen = *cur;
5038 break;
5039 }
5040 }
5041 }
5042
5043 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005044 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5045 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5046 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005047
5048 p += alpn_len;
5049 }
5050#endif /* MBEDTLS_SSL_ALPN */
5051
5052 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005053 * Forced fields from top-level ssl_context structure
5054 *
5055 * Most of them already set to the correct value by mbedtls_ssl_init() and
5056 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5057 */
Gilles Peskinef670ba52025-03-07 15:09:32 +01005058 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Glenn Strauss60bfe602022-03-14 19:04:24 -04005059 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005060
Hanno Becker361b10d2019-08-30 10:42:49 +01005061 /* Adjust pointers for header fields of outgoing records to
5062 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005063 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005064
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005065#if defined(MBEDTLS_SSL_PROTO_DTLS)
5066 ssl->in_epoch = 1;
5067#endif
5068
5069 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5070 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005071 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5072 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 if (ssl->handshake != NULL) {
5074 mbedtls_ssl_handshake_free(ssl);
5075 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005076 ssl->handshake = NULL;
5077 }
5078
5079 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005080 * Done - should have consumed entire buffer
5081 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005082 if (p != end) {
5083 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5084 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005085
Gilles Peskine449bd832023-01-11 14:50:10 +01005086 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005087}
5088
5089/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005090 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005091 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005092int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5093 const unsigned char *buf,
5094 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005095{
Gilles Peskine449bd832023-01-11 14:50:10 +01005096 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005097
Gilles Peskine449bd832023-01-11 14:50:10 +01005098 if (ret != 0) {
5099 mbedtls_ssl_free(context);
5100 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005101
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005103}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005104#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005105
5106/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005107 * Free an SSL context
5108 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005109void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005110{
Gilles Peskine449bd832023-01-11 14:50:10 +01005111 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005112 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005113 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005114
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005116
Gilles Peskine449bd832023-01-11 14:50:10 +01005117 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005118#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5119 size_t out_buf_len = ssl->out_buf_len;
5120#else
5121 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5122#endif
5123
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005124 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005125 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005126 }
5127
Gilles Peskine449bd832023-01-11 14:50:10 +01005128 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005129#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5130 size_t in_buf_len = ssl->in_buf_len;
5131#else
5132 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5133#endif
5134
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005135 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005136 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005137 }
5138
Gilles Peskine449bd832023-01-11 14:50:10 +01005139 if (ssl->transform) {
5140 mbedtls_ssl_transform_free(ssl->transform);
5141 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005142 }
5143
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 if (ssl->handshake) {
5145 mbedtls_ssl_handshake_free(ssl);
5146 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005147
5148#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005149 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5150 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005151#endif
5152
Gilles Peskine449bd832023-01-11 14:50:10 +01005153 mbedtls_ssl_session_free(ssl->session_negotiate);
5154 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005155 }
5156
Ronald Cron6f135e12021-12-08 16:57:54 +01005157#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005158 mbedtls_ssl_transform_free(ssl->transform_application);
5159 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005160#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005161
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 if (ssl->session) {
5163 mbedtls_ssl_session_free(ssl->session);
5164 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005165 }
5166
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005167#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine4ac40082025-02-20 18:13:58 +01005168 mbedtls_ssl_free_hostname(ssl);
Paul Bakker0be444a2013-08-27 21:55:01 +02005169#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005170
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005171#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005172 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005173#endif
5174
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005176
Paul Bakker86f04f42013-02-14 11:20:09 +01005177 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005178 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005179}
5180
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005181/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005182 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005183 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005184void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005185{
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005187}
5188
Gilles Peskineae270bf2021-06-02 00:05:29 +02005189/* The selection should be the same as mbedtls_x509_crt_profile_default in
5190 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005191 * curves with a lower resource usage come first.
Manuel Pégourié-Gonnard93d45912025-01-14 11:45:44 +01005192 * See the documentation of mbedtls_ssl_conf_groups() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005193 * about this list.
5194 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005195static const uint16_t ssl_preset_default_groups[] = {
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005196#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Brett Warrene0edc842021-08-17 09:53:13 +01005197 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005198#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005199#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005200 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005201#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005202#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005203 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005204#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005205#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Brett Warrene0edc842021-08-17 09:53:13 +01005206 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005207#endif
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005208#if defined(PSA_WANT_ECC_SECP_R1_521)
Brett Warrene0edc842021-08-17 09:53:13 +01005209 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005210#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005211#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005212 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005213#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005214#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005215 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005216#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005217#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Brett Warrene0edc842021-08-17 09:53:13 +01005218 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005219#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005220#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005221 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5222 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5223 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5224 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5225 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5226#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005227 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005228};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005229
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005230static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005231 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5232 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5233 0
5234};
5235
Ronald Crone68ab4f2022-10-05 12:46:29 +02005236#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005237
Jerry Yu909df7b2022-01-22 11:56:27 +08005238/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005239 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005240 * rules SHOULD be upheld.
5241 * - No duplicate entries.
5242 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005243 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005244 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005245 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005246static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005247
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005248#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005249 defined(PSA_WANT_ALG_SHA_256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005250 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005251 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005252 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5253#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005254
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005255#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005256 defined(PSA_WANT_ALG_SHA_384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005257 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005258 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005259 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5260#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005261
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005262#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Gabor Mezeic15ef932024-06-13 12:53:54 +02005263 defined(PSA_WANT_ALG_SHA_512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005264 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005265 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005266 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5267#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005268
Gabor Mezeic15ef932024-06-13 12:53:54 +02005269#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005270 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005271#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005272
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005273#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005274 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005275#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005276
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005277#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005278 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005279#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005280
Gabor Mezeic15ef932024-06-13 12:53:54 +02005281#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005282 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Gabor Mezeic15ef932024-06-13 12:53:54 +02005283#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005284
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005285#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005286 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005287#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005288
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005289#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005290 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005291#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005292
Gabor Mezei15b95a62022-05-09 16:37:58 +02005293 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005294};
5295
5296/* NOTICE: see above */
5297#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Deomid rojer Ryabkove2d71cc2024-03-18 12:32:30 +00005298static const uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005299
Gabor Mezeic15ef932024-06-13 12:53:54 +02005300#if defined(PSA_WANT_ALG_SHA_512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005301#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005302 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005303#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005304#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5305 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005306#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005307#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005308 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005309#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005310#endif /* PSA_WANT_ALG_SHA_512 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005311
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005312#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005313#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005314 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005315#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005316#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5317 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005318#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005319#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005320 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005321#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005322#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005323
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005324#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005325#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005326 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005327#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005328#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5329 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005330#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005331#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005332 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005333#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005334#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005335
Gabor Mezei15b95a62022-05-09 16:37:58 +02005336 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005337};
5338#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005339
Jerry Yu909df7b2022-01-22 11:56:27 +08005340/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005341static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005342
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005343#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005344 defined(PSA_WANT_ALG_SHA_256) && \
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005345 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005346 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005347 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5348#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005349
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005350#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005351 defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005352 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu53037892022-01-25 11:02:06 +08005353 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005354 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5355#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005356
Gabor Mezei15b95a62022-05-09 16:37:58 +02005357 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005358};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005359
Jerry Yu909df7b2022-01-22 11:56:27 +08005360/* NOTICE: see above */
5361#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Deomid rojer Ryabkov7dddc172024-03-20 00:43:34 +00005362static const uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005363
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005364#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005365#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005366 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005367#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005368#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005369
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005370#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005371#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005372 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005373#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005374#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005375
Gabor Mezei15b95a62022-05-09 16:37:58 +02005376 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005377};
Jerry Yu909df7b2022-01-22 11:56:27 +08005378#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5379
Ronald Crone68ab4f2022-10-05 12:46:29 +02005380#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005381
Chien Wong4e9683e2023-12-28 17:07:43 +08005382static const uint16_t ssl_preset_suiteb_groups[] = {
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005383#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005384 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005385#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005386#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005387 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005388#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005389 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005390};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005391
Ronald Crone68ab4f2022-10-05 12:46:29 +02005392#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005393/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005394 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005395MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005396static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005397{
5398 size_t i, j;
5399 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005400
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5402 for (j = 0; j < i; j++) {
5403 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005404 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 }
5406 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5407 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5408 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005409 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005410 }
5411 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005412 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005413}
5414
Ronald Crone68ab4f2022-10-05 12:46:29 +02005415#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005416
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005417/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005418 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005419 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005420int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5421 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005422{
Ronald Crone68ab4f2022-10-05 12:46:29 +02005423#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5425 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5426 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005427 }
5428
Gilles Peskine449bd832023-01-11 14:50:10 +01005429 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5430 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5431 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005432 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005433
5434#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5436 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5437 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005438 }
5439
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5441 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5442 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005443 }
5444#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005445#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005446
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005447 /* Use the functions here so that they are covered in tests,
5448 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 mbedtls_ssl_conf_endpoint(conf, endpoint);
5450 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005451
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005452 /*
5453 * Things that are common to all presets
5454 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005455#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005456 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005457 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5458#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5459 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5460#endif
5461 }
5462#endif
5463
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005464#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5465 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5466#endif
5467
5468#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5469 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5470#endif
5471
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005472#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005473 conf->f_cookie_write = ssl_cookie_write_dummy;
5474 conf->f_cookie_check = ssl_cookie_check_dummy;
5475#endif
5476
5477#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5478 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5479#endif
5480
Janos Follath088ce432017-04-10 12:42:31 +01005481#if defined(MBEDTLS_SSL_SRV_C)
5482 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005483 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005484#endif
5485
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005486#if defined(MBEDTLS_SSL_PROTO_DTLS)
5487 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5488 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5489#endif
5490
5491#if defined(MBEDTLS_SSL_RENEGOTIATION)
5492 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005493 memset(conf->renego_period, 0x00, 2);
5494 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005495#endif
5496
Ronald Cron6f135e12021-12-08 16:57:54 +01005497#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005498
5499#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005500 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005501#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005502 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005503#endif
5504#endif /* MBEDTLS_SSL_EARLY_DATA */
5505
Jerry Yud0766ec2022-09-22 10:46:57 +08005506#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005507 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005509#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005510 /*
5511 * Allow all TLS 1.3 key exchange modes by default.
5512 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005513 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005514#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005515
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005517#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005518 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005519 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005520#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005521 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005522#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005524#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005525 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5526 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005527#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5528 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5529 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5530#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5531 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5532 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5533#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005534 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005535#endif
5536 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005537
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005538 /*
5539 * Preset-specific defaults
5540 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005541 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005542 /*
5543 * NSA Suite B
5544 */
5545 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005546
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005547 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005548
5549#if defined(MBEDTLS_X509_CRT_PARSE_C)
5550 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005551#endif
5552
Ronald Crone68ab4f2022-10-05 12:46:29 +02005553#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005554#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005555 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005556 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005557 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005558#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005559 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005560#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005561
Brett Warrene0edc842021-08-17 09:53:13 +01005562 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005563 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005564
5565 /*
5566 * Default
5567 */
5568 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005569
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005570 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005571
5572#if defined(MBEDTLS_X509_CRT_PARSE_C)
5573 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5574#endif
5575
Ronald Crone68ab4f2022-10-05 12:46:29 +02005576#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005577#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005578 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005579 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005580 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005581#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005583#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005584
Brett Warrene0edc842021-08-17 09:53:13 +01005585 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005586 }
5587
Gilles Peskine449bd832023-01-11 14:50:10 +01005588 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005589}
5590
5591/*
5592 * Free mbedtls_ssl_config
5593 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005594void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005595{
Troy-Butlerda73abc2024-04-02 13:37:31 -04005596 if (conf == NULL) {
5597 return;
5598 }
5599
Ronald Cron73fe8df2022-10-05 14:31:43 +02005600#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005601 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005602 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5603 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005604 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005605 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005606 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005607 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005608 }
5609
Gilles Peskine449bd832023-01-11 14:50:10 +01005610 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005611 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005612 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005613 conf->psk_identity_len = 0;
5614 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005615#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005616
5617#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005619#endif
5620
Gilles Peskine449bd832023-01-11 14:50:10 +01005621 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005622}
5623
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005624#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005625 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005626/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005627 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005628 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005629unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005630{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005631#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005632 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5633 return MBEDTLS_SSL_SIG_RSA;
5634 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005635#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005636#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005637 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5638 return MBEDTLS_SSL_SIG_ECDSA;
5639 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005640#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005641 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005642}
5643
Gilles Peskine449bd832023-01-11 14:50:10 +01005644unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005645{
Gilles Peskine449bd832023-01-11 14:50:10 +01005646 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005647 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005648 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005649 case MBEDTLS_PK_ECDSA:
5650 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005651 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005652 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005653 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005654 }
5655}
5656
Gilles Peskine449bd832023-01-11 14:50:10 +01005657mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005658{
Gilles Peskine449bd832023-01-11 14:50:10 +01005659 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005660#if defined(MBEDTLS_RSA_C)
5661 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005662 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005663#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005664#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005665 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005666 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005667#endif
5668 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005669 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005670 }
5671}
Valerio Settie9646ec2023-08-02 20:02:28 +02005672#endif /* MBEDTLS_PK_C &&
5673 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005674
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005675/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005676 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005677 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005678mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005679{
Gilles Peskine449bd832023-01-11 14:50:10 +01005680 switch (hash) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005681#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005682 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005683 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005684#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005685#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005686 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005687 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005688#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005689#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005690 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005691 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005692#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005693#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005694 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005695 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005696#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005697#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005698 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005699 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005700#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005701#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005702 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005703 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005704#endif
5705 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005706 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005707 }
5708}
5709
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005710/*
5711 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5712 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005713unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005714{
Gilles Peskine449bd832023-01-11 14:50:10 +01005715 switch (md) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005716#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005717 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005718 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005719#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005720#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005721 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005722 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005723#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005724#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005725 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005727#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005728#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005729 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005730 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005731#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005732#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005733 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005734 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005735#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005736#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005737 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005738 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005739#endif
5740 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005741 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005742 }
5743}
5744
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005745/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005746 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005747 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005748 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005749int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005750{
Manuel Pégourié-Gonnard6402c352025-01-14 12:23:56 +01005751 const uint16_t *group_list = ssl->conf->group_list;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005752
Gilles Peskine449bd832023-01-11 14:50:10 +01005753 if (group_list == NULL) {
5754 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005755 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005756
Gilles Peskine449bd832023-01-11 14:50:10 +01005757 for (; *group_list != 0; group_list++) {
5758 if (*group_list == tls_id) {
5759 return 0;
5760 }
5761 }
5762
5763 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005764}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005765
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005766#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005767/*
5768 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5769 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005770int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005771{
Gilles Peskine449bd832023-01-11 14:50:10 +01005772 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005773
Gilles Peskine449bd832023-01-11 14:50:10 +01005774 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005775 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005776 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005777
Gilles Peskine449bd832023-01-11 14:50:10 +01005778 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005779}
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005780#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Valerio Setti67419f02023-01-04 16:12:42 +01005781
Valerio Setti18c9fed2022-12-30 17:44:24 +01005782static const struct {
5783 uint16_t tls_id;
5784 mbedtls_ecp_group_id ecp_group_id;
5785 psa_ecc_family_t psa_family;
5786 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005787} tls_id_match_table[] =
5788{
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005789#if defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02005790 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005791#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005792#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02005793 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005794#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005795#if defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005796 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005797#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005798#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005799 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005800#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005801#if defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005802 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005803#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005804#if defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005805 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005806#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005807#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005808 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005809#endif
Elena Uziunaiteeaa0cf02024-07-04 17:41:25 +01005810#if defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02005811 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005812#endif
Elena Uziunaitea3632862024-07-04 13:52:43 +01005813#if defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005814 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005815#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005816#if defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005817 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005818#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005819#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02005820 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005821#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005822#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005823 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005824#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005825 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005826};
5827
Gilles Peskine449bd832023-01-11 14:50:10 +01005828int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005829 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005830 size_t *bits)
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].tls_id != 0; i++) {
5833 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005834 if (type != NULL) {
5835 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005836 }
5837 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005838 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005839 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005840 return PSA_SUCCESS;
5841 }
5842 }
5843
5844 return PSA_ERROR_NOT_SUPPORTED;
5845}
5846
Gilles Peskine449bd832023-01-11 14:50:10 +01005847mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005848{
Gilles Peskine449bd832023-01-11 14:50:10 +01005849 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5850 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005851 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005852 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005853 }
5854
5855 return MBEDTLS_ECP_DP_NONE;
5856}
5857
Gilles Peskine449bd832023-01-11 14:50:10 +01005858uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005859{
Gilles Peskine449bd832023-01-11 14:50:10 +01005860 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5861 i++) {
5862 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005863 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005864 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005865 }
5866
5867 return 0;
5868}
5869
Valerio Setti67419f02023-01-04 16:12:42 +01005870#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005871static const struct {
5872 uint16_t tls_id;
5873 const char *name;
5874} tls_id_curve_name_table[] =
5875{
Valerio Setti54e23792023-07-07 10:49:27 +02005876 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5877 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5878 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5879 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5880 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5881 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5882 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5883 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5884 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5885 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5886 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5887 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5888 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005889 { 0, NULL },
5890};
5891
Gilles Peskine449bd832023-01-11 14:50:10 +01005892const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005893{
Valerio Settiacd32c02023-06-29 18:06:29 +02005894 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5895 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5896 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005897 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005898 }
5899
5900 return NULL;
5901}
Valerio Setti67419f02023-01-04 16:12:42 +01005902#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005903
Gilles Peskine449bd832023-01-11 14:50:10 +01005904int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5905 const mbedtls_md_type_t md,
5906 unsigned char *dst,
5907 size_t dst_len,
5908 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005909{
Ronald Cronf6893e12022-01-07 22:09:01 +01005910 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5911 psa_hash_operation_t *hash_operation_to_clone;
5912 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5913
Jerry Yu148165c2021-09-24 23:20:59 +08005914 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01005915
Gilles Peskine449bd832023-01-11 14:50:10 +01005916 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005917#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01005918 case MBEDTLS_MD_SHA384:
5919 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
5920 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005921#endif
5922
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005923#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01005924 case MBEDTLS_MD_SHA256:
5925 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
5926 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01005927#endif
5928
Gilles Peskine449bd832023-01-11 14:50:10 +01005929 default:
5930 goto exit;
5931 }
5932
5933 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
5934 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005935 goto exit;
5936 }
5937
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
5939 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01005940 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005941 }
Ronald Cronf6893e12022-01-07 22:09:01 +01005942
5943exit:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005944#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005945 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04005946 (void) ssl;
5947#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05005948 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08005949}
Jerry Yu24c0ec32021-09-09 14:21:07 +08005950
Ronald Crone68ab4f2022-10-05 12:46:29 +02005951#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02005952/* mbedtls_ssl_parse_sig_alg_ext()
5953 *
5954 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
5955 * value (TLS 1.3 RFC8446):
5956 * enum {
5957 * ....
5958 * ecdsa_secp256r1_sha256( 0x0403 ),
5959 * ecdsa_secp384r1_sha384( 0x0503 ),
5960 * ecdsa_secp521r1_sha512( 0x0603 ),
5961 * ....
5962 * } SignatureScheme;
5963 *
5964 * struct {
5965 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
5966 * } SignatureSchemeList;
5967 *
5968 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
5969 * value (TLS 1.2 RFC5246):
5970 * enum {
5971 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
5972 * sha512(6), (255)
5973 * } HashAlgorithm;
5974 *
5975 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
5976 * SignatureAlgorithm;
5977 *
5978 * struct {
5979 * HashAlgorithm hash;
5980 * SignatureAlgorithm signature;
5981 * } SignatureAndHashAlgorithm;
5982 *
5983 * SignatureAndHashAlgorithm
5984 * supported_signature_algorithms<2..2^16-2>;
5985 *
5986 * The TLS 1.3 signature algorithm extension was defined to be a compatible
5987 * generalization of the TLS 1.2 signature algorithm extension.
5988 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
5989 * `SignatureScheme` field of TLS 1.3
5990 *
5991 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005992int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
5993 const unsigned char *buf,
5994 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02005995{
5996 const unsigned char *p = buf;
5997 size_t supported_sig_algs_len = 0;
5998 const unsigned char *supported_sig_algs_end;
5999 uint16_t sig_alg;
6000 uint32_t common_idx = 0;
6001
Gilles Peskine449bd832023-01-11 14:50:10 +01006002 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6003 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006004 p += 2;
6005
Gilles Peskine449bd832023-01-11 14:50:10 +01006006 memset(ssl->handshake->received_sig_algs, 0,
6007 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006008
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006010 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 while (p < supported_sig_algs_end) {
6012 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6013 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006014 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006015 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6016 sig_alg,
6017 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006018#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006019 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6020 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6021 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006022 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006023 }
6024#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006025
Gilles Peskine449bd832023-01-11 14:50:10 +01006026 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6027 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006028
Gilles Peskine449bd832023-01-11 14:50:10 +01006029 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006030 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6031 common_idx += 1;
6032 }
6033 }
6034 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006035 if (p != end) {
6036 MBEDTLS_SSL_DEBUG_MSG(1,
6037 ("Signature algorithms extension length misaligned"));
6038 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6039 MBEDTLS_ERR_SSL_DECODE_ERROR);
6040 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006041 }
6042
Gilles Peskine449bd832023-01-11 14:50:10 +01006043 if (common_idx == 0) {
6044 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6045 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6046 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6047 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006048 }
6049
Gabor Mezei15b95a62022-05-09 16:37:58 +02006050 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006051 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006052}
6053
Ronald Crone68ab4f2022-10-05 12:46:29 +02006054#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006055
Jerry Yudc7bd172022-02-17 13:44:15 +08006056#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6057
Jerry Yudc7bd172022-02-17 13:44:15 +08006058
Gilles Peskine449bd832023-01-11 14:50:10 +01006059static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6060 mbedtls_svc_key_id_t key,
6061 psa_algorithm_t alg,
6062 const unsigned char *raw_psk, size_t raw_psk_length,
6063 const unsigned char *seed, size_t seed_length,
6064 const unsigned char *label, size_t label_length,
6065 const unsigned char *other_secret,
6066 size_t other_secret_length,
6067 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006068{
6069 psa_status_t status;
6070
Gilles Peskine449bd832023-01-11 14:50:10 +01006071 status = psa_key_derivation_setup(derivation, alg);
6072 if (status != PSA_SUCCESS) {
6073 return status;
6074 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006075
Gilles Peskine449bd832023-01-11 14:50:10 +01006076 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6077 status = psa_key_derivation_input_bytes(derivation,
6078 PSA_KEY_DERIVATION_INPUT_SEED,
6079 seed, seed_length);
6080 if (status != PSA_SUCCESS) {
6081 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006082 }
6083
Gilles Peskine449bd832023-01-11 14:50:10 +01006084 if (other_secret != NULL) {
6085 status = psa_key_derivation_input_bytes(derivation,
6086 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6087 other_secret, other_secret_length);
6088 if (status != PSA_SUCCESS) {
6089 return status;
6090 }
6091 }
6092
6093 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006094 status = psa_key_derivation_input_bytes(
6095 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006096 raw_psk, raw_psk_length);
6097 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006098 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006100 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 if (status != PSA_SUCCESS) {
6102 return status;
6103 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006104
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 status = psa_key_derivation_input_bytes(derivation,
6106 PSA_KEY_DERIVATION_INPUT_LABEL,
6107 label, label_length);
6108 if (status != PSA_SUCCESS) {
6109 return status;
6110 }
6111 } else {
6112 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006113 }
6114
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 status = psa_key_derivation_set_capacity(derivation, capacity);
6116 if (status != PSA_SUCCESS) {
6117 return status;
6118 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006119
Gilles Peskine449bd832023-01-11 14:50:10 +01006120 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006121}
6122
Andrzej Kurek57d10632022-10-24 10:32:01 -04006123#if defined(PSA_WANT_ALG_SHA_384) || \
6124 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006125MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006126static int tls_prf_generic(mbedtls_md_type_t md_type,
6127 const unsigned char *secret, size_t slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006128 const char *label, size_t label_len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006129 const unsigned char *random, size_t rlen,
6130 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006131{
6132 psa_status_t status;
6133 psa_algorithm_t alg;
6134 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6135 psa_key_derivation_operation_t derivation =
6136 PSA_KEY_DERIVATION_OPERATION_INIT;
6137
Gilles Peskine449bd832023-01-11 14:50:10 +01006138 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006139 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006140 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006141 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006142 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006143
6144 /* Normally a "secret" should be long enough to be impossible to
6145 * find by brute force, and in particular should not be empty. But
6146 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6147 * and for this use case it makes sense to have a 0-length "secret".
6148 * Since the key API doesn't allow importing a key of length 0,
6149 * keep master_key=0, which setup_psa_key_derivation() understands
6150 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006151 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006152 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006153 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6154 psa_set_key_algorithm(&key_attributes, alg);
6155 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006156
Gilles Peskine449bd832023-01-11 14:50:10 +01006157 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6158 if (status != PSA_SUCCESS) {
6159 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6160 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006161 }
6162
Gilles Peskine449bd832023-01-11 14:50:10 +01006163 status = setup_psa_key_derivation(&derivation,
6164 master_key, alg,
6165 NULL, 0,
6166 random, rlen,
6167 (unsigned char const *) label,
Max Fillingerf2dda152024-10-23 15:47:23 +02006168 label_len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006169 NULL, 0,
6170 dlen);
6171 if (status != PSA_SUCCESS) {
6172 psa_key_derivation_abort(&derivation);
6173 psa_destroy_key(master_key);
6174 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006175 }
6176
Gilles Peskine449bd832023-01-11 14:50:10 +01006177 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6178 if (status != PSA_SUCCESS) {
6179 psa_key_derivation_abort(&derivation);
6180 psa_destroy_key(master_key);
6181 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006182 }
6183
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 status = psa_key_derivation_abort(&derivation);
6185 if (status != PSA_SUCCESS) {
6186 psa_destroy_key(master_key);
6187 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006188 }
6189
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 if (!mbedtls_svc_key_id_is_null(master_key)) {
6191 status = psa_destroy_key(master_key);
6192 }
6193 if (status != PSA_SUCCESS) {
6194 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6195 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006196
Gilles Peskine449bd832023-01-11 14:50:10 +01006197 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006198}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006199#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006200
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006201#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006202MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006203static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6204 const char *label,
6205 const unsigned char *random, size_t rlen,
6206 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006207{
Gilles Peskine449bd832023-01-11 14:50:10 +01006208 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006209 label, strlen(label), random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006210}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006211#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006212
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006213#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006214MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006215static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6216 const char *label,
6217 const unsigned char *random, size_t rlen,
6218 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006219{
Gilles Peskine449bd832023-01-11 14:50:10 +01006220 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006221 label, strlen(label), random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006222}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006223#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006224
Jerry Yuf009d862022-02-17 14:01:37 +08006225/*
6226 * Set appropriate PRF function and other SSL / TLS1.2 functions
6227 *
6228 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006229 * - hash associated with the ciphersuite (only used by TLS 1.2)
6230 *
6231 * Outputs:
6232 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6233 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006234MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006235static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6236 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006237{
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006238#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006239 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006240 handshake->tls_prf = tls_prf_sha384;
6241 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6242 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006244#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006245#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuf009d862022-02-17 14:01:37 +08006246 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006247 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006248 handshake->tls_prf = tls_prf_sha256;
6249 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6250 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6251 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006252#else
Jerry Yuf009d862022-02-17 14:01:37 +08006253 {
Jerry Yuf009d862022-02-17 14:01:37 +08006254 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006255 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006256 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006257 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006258#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006259
Gilles Peskine449bd832023-01-11 14:50:10 +01006260 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006261}
Jerry Yud6ab2352022-02-17 14:03:43 +08006262
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006263/*
6264 * Compute master secret if needed
6265 *
6266 * Parameters:
6267 * [in/out] handshake
6268 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6269 * (PSA-PSK) ciphersuite_info, psk_opaque
6270 * [out] premaster (cleared)
6271 * [out] master
6272 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6273 * debug: conf->f_dbg, conf->p_dbg
6274 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006275 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006276 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006277MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006278static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6279 unsigned char *master,
6280 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006281{
6282 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6283
6284 /* cf. RFC 5246, Section 8.1:
6285 * "The master secret is always exactly 48 bytes in length." */
6286 size_t const master_secret_len = 48;
6287
6288#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6289 unsigned char session_hash[48];
6290#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6291
6292 /* The label for the KDF used for key expansion.
6293 * This is either "master secret" or "extended master secret"
6294 * depending on whether the Extended Master Secret extension
6295 * is used. */
6296 char const *lbl = "master secret";
6297
Przemek Stekielae4ed302022-04-05 17:15:55 +02006298 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006299 * - If the Extended Master Secret extension is not used,
6300 * this is ClientHello.Random + ServerHello.Random
6301 * (see Sect. 8.1 in RFC 5246).
6302 * - If the Extended Master Secret extension is used,
6303 * this is the transcript of the handshake so far.
6304 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006305 unsigned char const *seed = handshake->randbytes;
6306 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006307
6308#if !defined(MBEDTLS_DEBUG_C) && \
6309 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006310 !defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006311 ssl = NULL; /* make sure we don't use it except for those cases */
6312 (void) ssl;
6313#endif
6314
Gilles Peskine449bd832023-01-11 14:50:10 +01006315 if (handshake->resume != 0) {
6316 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6317 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006318 }
6319
6320#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006321 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006322 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006323 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006324 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6325 if (ret != 0) {
6326 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6327 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006328
Gilles Peskine449bd832023-01-11 14:50:10 +01006329 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6330 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006331 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006332#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006333
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006334#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006335 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006336 /* Perform PSK-to-MS expansion in a single step. */
6337 psa_status_t status;
6338 psa_algorithm_t alg;
6339 mbedtls_svc_key_id_t psk;
6340 psa_key_derivation_operation_t derivation =
6341 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006342 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006343
Gilles Peskine449bd832023-01-11 14:50:10 +01006344 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006345
Gilles Peskine449bd832023-01-11 14:50:10 +01006346 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006347
Gilles Peskine449bd832023-01-11 14:50:10 +01006348 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006349 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006350 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006351 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006352 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006353
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006354 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006355 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006356
Gilles Peskine449bd832023-01-11 14:50:10 +01006357 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006358 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006359 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006360 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006361 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006362 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
6363 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6364 other_secret = handshake->premaster + 2;
6365 break;
6366 default:
6367 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006368 }
6369
Gilles Peskine449bd832023-01-11 14:50:10 +01006370 status = setup_psa_key_derivation(&derivation, psk, alg,
6371 ssl->conf->psk, ssl->conf->psk_len,
6372 seed, seed_len,
6373 (unsigned char const *) lbl,
6374 (size_t) strlen(lbl),
6375 other_secret, other_secret_len,
6376 master_secret_len);
6377 if (status != PSA_SUCCESS) {
6378 psa_key_derivation_abort(&derivation);
6379 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006380 }
6381
Gilles Peskine449bd832023-01-11 14:50:10 +01006382 status = psa_key_derivation_output_bytes(&derivation,
6383 master,
6384 master_secret_len);
6385 if (status != PSA_SUCCESS) {
6386 psa_key_derivation_abort(&derivation);
6387 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006388 }
6389
Gilles Peskine449bd832023-01-11 14:50:10 +01006390 status = psa_key_derivation_abort(&derivation);
6391 if (status != PSA_SUCCESS) {
6392 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6393 }
6394 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006395#endif
6396 {
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006397#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006398 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006399 psa_status_t status;
6400 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6401 psa_key_derivation_operation_t derivation =
6402 PSA_KEY_DERIVATION_OPERATION_INIT;
6403
Gilles Peskine449bd832023-01-11 14:50:10 +01006404 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006405
6406 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6407
Gilles Peskine449bd832023-01-11 14:50:10 +01006408 status = psa_key_derivation_setup(&derivation, alg);
6409 if (status != PSA_SUCCESS) {
6410 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006411 }
6412
Gilles Peskine449bd832023-01-11 14:50:10 +01006413 status = psa_key_derivation_set_capacity(&derivation,
6414 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6415 if (status != PSA_SUCCESS) {
6416 psa_key_derivation_abort(&derivation);
6417 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006418 }
6419
Gilles Peskine449bd832023-01-11 14:50:10 +01006420 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6421 &derivation);
6422 if (status != PSA_SUCCESS) {
6423 psa_key_derivation_abort(&derivation);
6424 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006425 }
6426
Gilles Peskine449bd832023-01-11 14:50:10 +01006427 status = psa_key_derivation_output_bytes(&derivation,
6428 handshake->premaster,
6429 handshake->pmslen);
6430 if (status != PSA_SUCCESS) {
6431 psa_key_derivation_abort(&derivation);
6432 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6433 }
6434
6435 status = psa_key_derivation_abort(&derivation);
6436 if (status != PSA_SUCCESS) {
6437 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006438 }
6439 }
6440#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006441 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6442 lbl, seed, seed_len,
6443 master,
6444 master_secret_len);
6445 if (ret != 0) {
6446 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6447 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006448 }
6449
Gilles Peskine449bd832023-01-11 14:50:10 +01006450 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6451 handshake->premaster,
6452 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006453
Gilles Peskine449bd832023-01-11 14:50:10 +01006454 mbedtls_platform_zeroize(handshake->premaster,
6455 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006456 }
6457
Gilles Peskine449bd832023-01-11 14:50:10 +01006458 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006459}
6460
Gilles Peskine449bd832023-01-11 14:50:10 +01006461int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006462{
6463 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6464 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6465 ssl->handshake->ciphersuite_info;
6466
Gilles Peskine449bd832023-01-11 14:50:10 +01006467 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006468
6469 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006470 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006471 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006472 if (ret != 0) {
6473 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6474 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006475 }
6476
6477 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006478 ret = ssl_compute_master(ssl->handshake,
6479 ssl->session_negotiate->master,
6480 ssl);
6481 if (ret != 0) {
6482 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6483 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006484 }
6485
6486 /* Swap the client and server random values:
6487 * - MS derivation wanted client+server (RFC 5246 8.1)
6488 * - key derivation wants server+client (RFC 5246 6.3) */
6489 {
6490 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006491 memcpy(tmp, ssl->handshake->randbytes, 64);
6492 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6493 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6494 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006495 }
6496
6497 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006498 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6499 ssl->session_negotiate->ciphersuite,
6500 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006501#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006502 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006503#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006504 ssl->handshake->tls_prf,
6505 ssl->handshake->randbytes,
6506 ssl->tls_version,
6507 ssl->conf->endpoint,
6508 ssl);
6509 if (ret != 0) {
6510 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6511 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006512 }
6513
6514 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006515 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6516 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006517
Gilles Peskine449bd832023-01-11 14:50:10 +01006518 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006519
Gilles Peskine449bd832023-01-11 14:50:10 +01006520 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006521}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006522
Gilles Peskine449bd832023-01-11 14:50:10 +01006523int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006524{
Gilles Peskine449bd832023-01-11 14:50:10 +01006525 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006526#if defined(PSA_WANT_ALG_SHA_384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006527 case MBEDTLS_SSL_HASH_SHA384:
6528 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6529 break;
6530#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006531#if defined(PSA_WANT_ALG_SHA_256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006532 case MBEDTLS_SSL_HASH_SHA256:
6533 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6534 break;
6535#endif
6536 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006537 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006538 }
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006539#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006540 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006541 (void) ssl;
6542#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006543 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006544}
6545
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006546static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6547 const psa_hash_operation_t *hs_op,
6548 size_t buffer_size,
6549 unsigned char *hash,
6550 size_t *hlen)
6551{
6552 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006553 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006554
6555#if !defined(MBEDTLS_DEBUG_C)
6556 (void) ssl;
6557#endif
6558 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006559 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006560 if (status != PSA_SUCCESS) {
6561 goto exit;
6562 }
6563
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006564 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006565 if (status != PSA_SUCCESS) {
6566 goto exit;
6567 }
6568
6569 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6570 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6571
6572exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006573 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006574 return mbedtls_md_error_from_psa(status);
6575}
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006576
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006577#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006578int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6579 unsigned char *hash,
6580 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006581{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006582 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6583 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006584}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006585#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006586
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006587#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006588int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6589 unsigned char *hash,
6590 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006591{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006592 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6593 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006594}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006595#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006596
Jerry Yuc2c673d2022-02-17 14:20:39 +08006597#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006598MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006599static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006600
6601#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006602int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006603{
6604 /* If renegotiation is not enforced, retransmit until we would reach max
6605 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006606 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006607 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6608 unsigned char doublings = 1;
6609
Gilles Peskine449bd832023-01-11 14:50:10 +01006610 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006611 ++doublings;
6612 ratio >>= 1;
6613 }
6614
Gilles Peskine449bd832023-01-11 14:50:10 +01006615 if (++ssl->renego_records_seen > doublings) {
6616 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6617 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006618 }
6619 }
6620
Gilles Peskine449bd832023-01-11 14:50:10 +01006621 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006622}
6623#endif
6624#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006625
Jerry Yud9526692022-02-17 14:23:47 +08006626/*
6627 * Handshake functions
6628 */
6629#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6630/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006631int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006632{
6633 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6634 ssl->handshake->ciphersuite_info;
6635
Gilles Peskine449bd832023-01-11 14:50:10 +01006636 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006637
Gilles Peskine449bd832023-01-11 14:50:10 +01006638 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6639 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006640 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006641 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006642 }
6643
Gilles Peskine449bd832023-01-11 14:50:10 +01006644 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6645 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006646}
6647
Gilles Peskine449bd832023-01-11 14:50:10 +01006648int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006649{
6650 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6651 ssl->handshake->ciphersuite_info;
6652
Gilles Peskine449bd832023-01-11 14:50:10 +01006653 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006654
Gilles Peskine449bd832023-01-11 14:50:10 +01006655 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6656 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006657 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006658 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006659 }
6660
Gilles Peskine449bd832023-01-11 14:50:10 +01006661 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6662 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006663}
6664
6665#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6666/* Some certificate support -> implement write and parse */
6667
Gilles Peskine449bd832023-01-11 14:50:10 +01006668int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006669{
6670 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6671 size_t i, n;
6672 const mbedtls_x509_crt *crt;
6673 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6674 ssl->handshake->ciphersuite_info;
6675
Gilles Peskine449bd832023-01-11 14:50:10 +01006676 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006677
Gilles Peskine449bd832023-01-11 14:50:10 +01006678 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6679 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006680 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006681 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006682 }
6683
6684#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006685 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6686 if (ssl->handshake->client_auth == 0) {
6687 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006688 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006689 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006690 }
6691 }
6692#endif /* MBEDTLS_SSL_CLI_C */
6693#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006694 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6695 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006696 /* Should never happen because we shouldn't have picked the
6697 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006698 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006699 }
6700 }
6701#endif
6702
Gilles Peskine449bd832023-01-11 14:50:10 +01006703 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006704
6705 /*
6706 * 0 . 0 handshake type
6707 * 1 . 3 handshake length
6708 * 4 . 6 length of all certs
6709 * 7 . 9 length of cert. 1
6710 * 10 . n-1 peer certificate
6711 * n . n+2 length of cert. 2
6712 * n+3 . ... upper level cert, etc.
6713 */
6714 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006715 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006716
Gilles Peskine449bd832023-01-11 14:50:10 +01006717 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006718 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006719 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6720 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6721 " > %" MBEDTLS_PRINTF_SIZET,
6722 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6723 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006724 }
6725
Gilles Peskine449bd832023-01-11 14:50:10 +01006726 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6727 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6728 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006729
Gilles Peskine449bd832023-01-11 14:50:10 +01006730 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006731 i += n; crt = crt->next;
6732 }
6733
Gilles Peskine449bd832023-01-11 14:50:10 +01006734 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6735 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6736 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006737
6738 ssl->out_msglen = i;
6739 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6740 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6741
Gilles Peskinef670ba52025-03-07 15:09:32 +01006742 mbedtls_ssl_handshake_increment_state(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006743
Gilles Peskine449bd832023-01-11 14:50:10 +01006744 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
6745 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
6746 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006747 }
6748
Gilles Peskine449bd832023-01-11 14:50:10 +01006749 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006750
Gilles Peskine449bd832023-01-11 14:50:10 +01006751 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006752}
6753
6754#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6755
6756#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006757MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006758static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6759 unsigned char *crt_buf,
6760 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006761{
6762 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6763
Gilles Peskine449bd832023-01-11 14:50:10 +01006764 if (peer_crt == NULL) {
6765 return -1;
6766 }
Jerry Yud9526692022-02-17 14:23:47 +08006767
Gilles Peskine449bd832023-01-11 14:50:10 +01006768 if (peer_crt->raw.len != crt_buf_len) {
6769 return -1;
6770 }
Jerry Yud9526692022-02-17 14:23:47 +08006771
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08006773}
6774#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006775MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006776static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6777 unsigned char *crt_buf,
6778 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006779{
6780 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6781 unsigned char const * const peer_cert_digest =
6782 ssl->session->peer_cert_digest;
6783 mbedtls_md_type_t const peer_cert_digest_type =
6784 ssl->session->peer_cert_digest_type;
6785 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01006786 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08006787 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6788 size_t digest_len;
6789
Gilles Peskine449bd832023-01-11 14:50:10 +01006790 if (peer_cert_digest == NULL || digest_info == NULL) {
6791 return -1;
6792 }
Jerry Yud9526692022-02-17 14:23:47 +08006793
Gilles Peskine449bd832023-01-11 14:50:10 +01006794 digest_len = mbedtls_md_get_size(digest_info);
6795 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
6796 return -1;
6797 }
Jerry Yud9526692022-02-17 14:23:47 +08006798
Gilles Peskine449bd832023-01-11 14:50:10 +01006799 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
6800 if (ret != 0) {
6801 return -1;
6802 }
Jerry Yud9526692022-02-17 14:23:47 +08006803
Gilles Peskine449bd832023-01-11 14:50:10 +01006804 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08006805}
6806#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6807#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6808
6809/*
6810 * Once the certificate message is read, parse it into a cert chain and
6811 * perform basic checks, but leave actual verification to the caller
6812 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006813MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006814static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
6815 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08006816{
6817 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6818#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006819 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08006820#endif
6821 size_t i, n;
6822 uint8_t alert;
6823
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
6825 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6826 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6827 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6828 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006829 }
6830
Gilles Peskine449bd832023-01-11 14:50:10 +01006831 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
6832 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6833 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6834 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006835 }
6836
Gilles Peskine449bd832023-01-11 14:50:10 +01006837 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
6838 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6839 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6840 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6841 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006842 }
6843
Gilles Peskine449bd832023-01-11 14:50:10 +01006844 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006845
6846 /*
6847 * Same message structure as in mbedtls_ssl_write_certificate()
6848 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006849 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006850
Gilles Peskine449bd832023-01-11 14:50:10 +01006851 if (ssl->in_msg[i] != 0 ||
6852 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
6853 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6854 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6855 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6856 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006857 }
6858
6859 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6860 i += 3;
6861
6862 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08006864 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006865 if (i + 3 > ssl->in_hslen) {
6866 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6867 mbedtls_ssl_send_alert_message(ssl,
6868 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6869 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6870 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006871 }
6872 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6873 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006874 if (ssl->in_msg[i] != 0) {
6875 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6876 mbedtls_ssl_send_alert_message(ssl,
6877 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6878 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
6879 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08006880 }
6881
6882 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006883 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006884 i += 3;
6885
Gilles Peskine449bd832023-01-11 14:50:10 +01006886 if (n < 128 || i + n > ssl->in_hslen) {
6887 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6888 mbedtls_ssl_send_alert_message(ssl,
6889 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6890 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6891 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006892 }
6893
6894 /* Check if we're handling the first CRT in the chain. */
6895#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006896 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08006897 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01006898 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08006899 /* During client-side renegotiation, check that the server's
6900 * end-CRTs hasn't changed compared to the initial handshake,
6901 * mitigating the triple handshake attack. On success, reuse
6902 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006903 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
6904 if (ssl_check_peer_crt_unchanged(ssl,
6905 &ssl->in_msg[i],
6906 n) != 0) {
6907 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
6908 mbedtls_ssl_send_alert_message(ssl,
6909 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6910 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
6911 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08006912 }
6913
6914 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006915 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08006916 }
6917#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6918
6919 /* Parse the next certificate in the chain. */
6920#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006921 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08006922#else
6923 /* If we don't need to store the CRT chain permanently, parse
6924 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006925 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08006926#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01006927 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08006928 case 0: /*ok*/
Gilles Peskine4c832212025-05-07 23:05:12 +02006929 case MBEDTLS_ERR_X509_UNKNOWN_OID:
Jerry Yud9526692022-02-17 14:23:47 +08006930 /* Ignore certificate with an unknown algorithm: maybe a
6931 prior certificate was already trusted. */
6932 break;
6933
6934 case MBEDTLS_ERR_X509_ALLOC_FAILED:
6935 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
6936 goto crt_parse_der_failed;
6937
6938 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
6939 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
6940 goto crt_parse_der_failed;
6941
6942 default:
6943 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006944crt_parse_der_failed:
6945 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
6946 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
6947 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006948 }
6949
6950 i += n;
6951 }
6952
Gilles Peskine449bd832023-01-11 14:50:10 +01006953 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
6954 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006955}
6956
6957#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006958MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006959static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006960{
Gilles Peskine449bd832023-01-11 14:50:10 +01006961 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6962 return -1;
6963 }
Jerry Yud9526692022-02-17 14:23:47 +08006964
Gilles Peskine449bd832023-01-11 14:50:10 +01006965 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08006966 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
6967 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01006968 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
6969 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
6970 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006971 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006972 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08006973}
6974#endif /* MBEDTLS_SSL_SRV_C */
6975
6976/* Check if a certificate message is expected.
6977 * Return either
6978 * - SSL_CERTIFICATE_EXPECTED, or
6979 * - SSL_CERTIFICATE_SKIP
6980 * indicating whether a Certificate message is expected or not.
6981 */
6982#define SSL_CERTIFICATE_EXPECTED 0
6983#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006984MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006985static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
6986 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08006987{
6988 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6989 ssl->handshake->ciphersuite_info;
6990
Gilles Peskine449bd832023-01-11 14:50:10 +01006991 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6992 return SSL_CERTIFICATE_SKIP;
6993 }
Jerry Yud9526692022-02-17 14:23:47 +08006994
6995#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006996 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006997 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08006998 ssl->session_negotiate->verify_result =
6999 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007000 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007001 }
7002 }
7003#else
7004 ((void) authmode);
7005#endif /* MBEDTLS_SSL_SRV_C */
7006
Gilles Peskine449bd832023-01-11 14:50:10 +01007007 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007008}
7009
Jerry Yud9526692022-02-17 14:23:47 +08007010#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007011MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007012static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7013 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007014{
7015 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7016 /* Remember digest of the peer's end-CRT. */
7017 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007018 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7019 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7020 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7021 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7022 mbedtls_ssl_send_alert_message(ssl,
7023 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7024 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007025
Gilles Peskine449bd832023-01-11 14:50:10 +01007026 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007027 }
7028
Gilles Peskine449bd832023-01-11 14:50:10 +01007029 ret = mbedtls_md(mbedtls_md_info_from_type(
7030 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7031 start, len,
7032 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007033
7034 ssl->session_negotiate->peer_cert_digest_type =
7035 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7036 ssl->session_negotiate->peer_cert_digest_len =
7037 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7038
Gilles Peskine449bd832023-01-11 14:50:10 +01007039 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007040}
7041
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007042MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007043static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7044 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007045{
7046 unsigned char *end = start + len;
7047 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7048
7049 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007050 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7051 ret = mbedtls_pk_parse_subpubkey(&start, end,
7052 &ssl->handshake->peer_pubkey);
7053 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007054 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007055 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007056 }
7057
Gilles Peskine449bd832023-01-11 14:50:10 +01007058 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007059}
7060#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7061
Gilles Peskine449bd832023-01-11 14:50:10 +01007062int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007063{
7064 int ret = 0;
7065 int crt_expected;
Manuel Pégourié-Gonnard58ab9ba2024-08-14 09:47:38 +02007066 /* Authmode: precedence order is SNI if used else configuration */
Jerry Yud9526692022-02-17 14:23:47 +08007067#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7068 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7069 ? ssl->handshake->sni_authmode
7070 : ssl->conf->authmode;
7071#else
7072 const int authmode = ssl->conf->authmode;
7073#endif
7074 void *rs_ctx = NULL;
7075 mbedtls_x509_crt *chain = NULL;
7076
Gilles Peskine449bd832023-01-11 14:50:10 +01007077 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007078
Gilles Peskine449bd832023-01-11 14:50:10 +01007079 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7080 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7081 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007082 goto exit;
7083 }
7084
7085#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007086 if (ssl->handshake->ecrs_enabled &&
7087 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007088 chain = ssl->handshake->ecrs_peer_cert;
7089 ssl->handshake->ecrs_peer_cert = NULL;
7090 goto crt_verify;
7091 }
7092#endif
7093
Gilles Peskine449bd832023-01-11 14:50:10 +01007094 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007095 /* mbedtls_ssl_read_record may have sent an alert already. We
7096 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007097 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007098 goto exit;
7099 }
7100
7101#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007102 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007103 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7104
Gilles Peskine449bd832023-01-11 14:50:10 +01007105 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007106 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007107 }
Jerry Yud9526692022-02-17 14:23:47 +08007108
7109 goto exit;
7110 }
7111#endif /* MBEDTLS_SSL_SRV_C */
7112
7113 /* Clear existing peer CRT structure in case we tried to
7114 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007115 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007116
Gilles Peskine449bd832023-01-11 14:50:10 +01007117 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7118 if (chain == NULL) {
7119 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7120 sizeof(mbedtls_x509_crt)));
7121 mbedtls_ssl_send_alert_message(ssl,
7122 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7123 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007124
7125 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7126 goto exit;
7127 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007128 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007129
Gilles Peskine449bd832023-01-11 14:50:10 +01007130 ret = ssl_parse_certificate_chain(ssl, chain);
7131 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007132 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007133 }
Jerry Yud9526692022-02-17 14:23:47 +08007134
7135#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007136 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007137 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007138 }
Jerry Yud9526692022-02-17 14:23:47 +08007139
7140crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007141 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007142 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007143 }
Jerry Yud9526692022-02-17 14:23:47 +08007144#endif
7145
Manuel Pégourié-Gonnard19dd9f52024-08-16 11:03:42 +02007146 ret = mbedtls_ssl_verify_certificate(ssl, authmode, chain,
7147 ssl->handshake->ciphersuite_info,
7148 rs_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +01007149 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#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7154 {
7155 unsigned char *crt_start, *pk_start;
7156 size_t crt_len, pk_len;
7157
7158 /* We parse the CRT chain without copying, so
7159 * these pointers point into the input buffer,
7160 * and are hence still valid after freeing the
7161 * CRT chain. */
7162
7163 crt_start = chain->raw.p;
7164 crt_len = chain->raw.len;
7165
7166 pk_start = chain->pk_raw.p;
7167 pk_len = chain->pk_raw.len;
7168
7169 /* Free the CRT structures before computing
7170 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007171 mbedtls_x509_crt_free(chain);
7172 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007173 chain = NULL;
7174
Gilles Peskine449bd832023-01-11 14:50:10 +01007175 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7176 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007177 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007178 }
Jerry Yud9526692022-02-17 14:23:47 +08007179
Gilles Peskine449bd832023-01-11 14:50:10 +01007180 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7181 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007182 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007183 }
Jerry Yud9526692022-02-17 14:23:47 +08007184 }
7185#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7186 /* Pass ownership to session structure. */
7187 ssl->session_negotiate->peer_cert = chain;
7188 chain = NULL;
7189#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7190
Gilles Peskine449bd832023-01-11 14:50:10 +01007191 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007192
7193exit:
7194
Gilles Peskine449bd832023-01-11 14:50:10 +01007195 if (ret == 0) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007196 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 }
Jerry Yud9526692022-02-17 14:23:47 +08007198
7199#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007200 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007201 ssl->handshake->ecrs_peer_cert = chain;
7202 chain = NULL;
7203 }
7204#endif
7205
Gilles Peskine449bd832023-01-11 14:50:10 +01007206 if (chain != NULL) {
7207 mbedtls_x509_crt_free(chain);
7208 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007209 }
7210
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007212}
7213#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7214
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007215static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7216 unsigned char *padbuf, size_t hlen,
7217 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007218{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007219 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007220 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007221 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007222 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007223 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007224 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007225
7226 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007227 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007228 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007229 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007230
Gilles Peskine449bd832023-01-11 14:50:10 +01007231 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007232 ? "client finished"
7233 : "server finished";
7234
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007235 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007236
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007237 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007238 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007239 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007240 }
7241
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007242 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007243 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007244 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007245 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007246 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007247
7248 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7249
Jerry Yu615bd6f2022-02-17 14:25:15 +08007250 /*
7251 * TLSv1.2:
7252 * hash = PRF( master, finished_label,
7253 * Hash( handshake ) )[0.11]
7254 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007255 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007256 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007257
Gilles Peskine449bd832023-01-11 14:50:10 +01007258 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007259
Paul Elliottecb95be2023-08-11 16:41:04 +01007260 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007261
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007262 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007263
7264exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007265 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007266 return mbedtls_md_error_from_psa(status);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007267}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007268
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007269#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007270static int ssl_calc_finished_tls_sha256(
7271 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7272{
7273 unsigned char padbuf[32];
7274 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007275 &ssl->handshake->fin_sha256_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007276 padbuf, sizeof(padbuf),
7277 buf, from);
7278}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007279#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007280
Jerry Yub7ba49e2022-02-17 14:25:53 +08007281
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007282#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007283static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007284 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007285{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007286 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007287 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007288 &ssl->handshake->fin_sha384_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007289 padbuf, sizeof(padbuf),
7290 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007291}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007292#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007293
Gilles Peskine449bd832023-01-11 14:50:10 +01007294void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007295{
Gilles Peskine449bd832023-01-11 14:50:10 +01007296 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007297
7298 /*
7299 * Free our handshake params
7300 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007301 mbedtls_ssl_handshake_free(ssl);
7302 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007303 ssl->handshake = NULL;
7304
7305 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007306 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007307 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007308 if (ssl->transform) {
7309 mbedtls_ssl_transform_free(ssl->transform);
7310 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007311 }
7312 ssl->transform = ssl->transform_negotiate;
7313 ssl->transform_negotiate = NULL;
7314
Gilles Peskine449bd832023-01-11 14:50:10 +01007315 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007316}
7317
Gilles Peskine449bd832023-01-11 14:50:10 +01007318void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007319{
7320 int resume = ssl->handshake->resume;
7321
Gilles Peskine449bd832023-01-11 14:50:10 +01007322 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007323
7324#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007325 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007326 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7327 ssl->renego_records_seen = 0;
7328 }
7329#endif
7330
7331 /*
7332 * Free the previous session and switch in the current one
7333 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007334 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007335#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7336 /* RFC 7366 3.1: keep the EtM state */
7337 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007338 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007339#endif
7340
Gilles Peskine449bd832023-01-11 14:50:10 +01007341 mbedtls_ssl_session_free(ssl->session);
7342 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007343 }
7344 ssl->session = ssl->session_negotiate;
7345 ssl->session_negotiate = NULL;
7346
7347 /*
7348 * Add cache entry
7349 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007350 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007351 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007352 resume == 0) {
7353 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7354 ssl->session->id,
7355 ssl->session->id_len,
7356 ssl->session) != 0) {
7357 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7358 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007359 }
7360
7361#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007362 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7363 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007364 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007365 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007366
7367 /* Keep last flight around in case we need to resend it:
7368 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007369 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7370 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007371#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007372 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007373
Gilles Peskinef670ba52025-03-07 15:09:32 +01007374 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007375
Gilles Peskine449bd832023-01-11 14:50:10 +01007376 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007377}
7378
Gilles Peskine449bd832023-01-11 14:50:10 +01007379int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007380{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007381 int ret;
7382 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007383
Gilles Peskine449bd832023-01-11 14:50:10 +01007384 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007385
Gilles Peskine449bd832023-01-11 14:50:10 +01007386 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007387
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007388 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7389 if (ret != 0) {
7390 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
David Horstmann816b7122025-03-07 17:20:59 +00007391 return ret;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007392 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007393
7394 /*
7395 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7396 * may define some other value. Currently (early 2016), no defined
7397 * ciphersuite does this (and this is unlikely to change as activity has
7398 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7399 */
7400 hash_len = 12;
7401
7402#if defined(MBEDTLS_SSL_RENEGOTIATION)
7403 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007404 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007405#endif
7406
7407 ssl->out_msglen = 4 + hash_len;
7408 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7409 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7410
7411 /*
7412 * In case of session resuming, invert the client and server
7413 * ChangeCipherSpec messages order.
7414 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007415 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007416#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007417 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007418 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
Gilles Peskine449bd832023-01-11 14:50:10 +01007419 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007420#endif
7421#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007422 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007423 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC);
Gilles Peskine449bd832023-01-11 14:50:10 +01007424 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007425#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007426 } else {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007427 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007428 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007429
7430 /*
7431 * Switch to our negotiated transform and session parameters for outbound
7432 * data.
7433 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007434 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007435
7436#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007437 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007438 unsigned char i;
7439
7440 /* Remember current epoch settings for resending */
7441 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007442 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7443 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007444
7445 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007446 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007447
7448
7449 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 for (i = 2; i > 0; i--) {
7451 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007452 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007453 }
7454 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007455
7456 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007457 if (i == 0) {
7458 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7459 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007460 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007461 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007462#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007463 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007464
7465 ssl->transform_out = ssl->transform_negotiate;
7466 ssl->session_out = ssl->session_negotiate;
7467
7468#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007469 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7470 mbedtls_ssl_send_flight_completed(ssl);
7471 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007472#endif
7473
Gilles Peskine449bd832023-01-11 14:50:10 +01007474 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7475 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7476 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007477 }
7478
7479#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7481 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7482 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7483 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007484 }
7485#endif
7486
Gilles Peskine449bd832023-01-11 14:50:10 +01007487 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007488
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007490}
7491
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007492#define SSL_MAX_HASH_LEN 12
7493
Gilles Peskine449bd832023-01-11 14:50:10 +01007494int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007495{
7496 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7497 unsigned int hash_len = 12;
7498 unsigned char buf[SSL_MAX_HASH_LEN];
7499
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007501
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007502 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7503 if (ret != 0) {
7504 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
David Horstmann816b7122025-03-07 17:20:59 +00007505 return ret;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007506 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007507
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7509 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007510 goto exit;
7511 }
7512
Gilles Peskine449bd832023-01-11 14:50:10 +01007513 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7514 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7515 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7516 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007517 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7518 goto exit;
7519 }
7520
Gilles Peskine449bd832023-01-11 14:50:10 +01007521 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
7522 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7523 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007524 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7525 goto exit;
7526 }
7527
Gilles Peskine449bd832023-01-11 14:50:10 +01007528 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
7529 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7530 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7531 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007532 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7533 goto exit;
7534 }
7535
Gilles Peskine449bd832023-01-11 14:50:10 +01007536 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
7537 buf, hash_len) != 0) {
7538 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7539 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7540 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007541 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7542 goto exit;
7543 }
7544
7545#if defined(MBEDTLS_SSL_RENEGOTIATION)
7546 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007547 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007548#endif
7549
Gilles Peskine449bd832023-01-11 14:50:10 +01007550 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007551#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007552 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007553 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC);
Gilles Peskine449bd832023-01-11 14:50:10 +01007554 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007555#endif
7556#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007557 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007558 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
Gilles Peskine449bd832023-01-11 14:50:10 +01007559 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007560#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007561 } else {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007562 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007563 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007564
7565#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007566 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7567 mbedtls_ssl_recv_flight_completed(ssl);
7568 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007569#endif
7570
Gilles Peskine449bd832023-01-11 14:50:10 +01007571 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007572
7573exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007574 mbedtls_platform_zeroize(buf, hash_len);
7575 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007576}
7577
Jerry Yu392112c2022-02-17 14:34:10 +08007578#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7579/*
7580 * Helper to get TLS 1.2 PRF from ciphersuite
7581 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7582 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007583static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08007584{
Jerry Yu392112c2022-02-17 14:34:10 +08007585 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007586 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007587#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007588 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
7589 return tls_prf_sha384;
7590 } else
Jerry Yu392112c2022-02-17 14:34:10 +08007591#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007592#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007593 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007594 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
7595 return tls_prf_sha256;
7596 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04007597 }
7598#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007599#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007600 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007601 (void) ciphersuite_info;
7602#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007603
Gilles Peskine449bd832023-01-11 14:50:10 +01007604 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08007605}
7606#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007607
Gilles Peskine449bd832023-01-11 14:50:10 +01007608static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007609{
7610 ((void) tls_prf);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007611#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007612 if (tls_prf == tls_prf_sha384) {
7613 return MBEDTLS_SSL_TLS_PRF_SHA384;
7614 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007615#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007616#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01007617 if (tls_prf == tls_prf_sha256) {
7618 return MBEDTLS_SSL_TLS_PRF_SHA256;
7619 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007620#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08007622}
7623
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007624/*
7625 * Populate a transform structure with session keys and all the other
7626 * necessary information.
7627 *
7628 * Parameters:
7629 * - [in/out]: transform: structure to populate
7630 * [in] must be just initialised with mbedtls_ssl_transform_init()
7631 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7632 * - [in] ciphersuite
7633 * - [in] master
7634 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007635 * - [in] tls_prf: pointer to PRF to use for key derivation
7636 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007637 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007638 * - [in] endpoint: client or server
7639 * - [in] ssl: used for:
7640 * - ssl->conf->{f,p}_export_keys
7641 * [in] optionally used for:
7642 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7643 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007644MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007645static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
7646 int ciphersuite,
7647 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007648#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007649 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007650#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007651 ssl_tls_prf_t tls_prf,
7652 const unsigned char randbytes[64],
7653 mbedtls_ssl_protocol_version tls_version,
7654 unsigned endpoint,
7655 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007656{
7657 int ret = 0;
7658 unsigned char keyblk[256];
7659 unsigned char *key1;
7660 unsigned char *key2;
7661 unsigned char *mac_enc;
7662 unsigned char *mac_dec;
7663 size_t mac_key_len = 0;
7664 size_t iv_copy_len;
7665 size_t keylen;
7666 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007667 mbedtls_ssl_mode_t ssl_mode;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007668
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007669 psa_key_type_t key_type;
7670 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7671 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007672 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007673 size_t key_bits;
7674 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007675
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007676 /*
7677 * Some data just needs copying into the structure
7678 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007679#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007680 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007681#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007682 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007683
Max Fillinger2fe35f62024-10-25 00:52:24 +02007684#if defined(MBEDTLS_SSL_KEEP_RANDBYTES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007685 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007686#endif
7687
7688#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01007689 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007690 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7691 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007692 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007693 }
7694#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7695
7696 /*
7697 * Get various info structures
7698 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007699 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
7700 if (ciphersuite_info == NULL) {
7701 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
7702 ciphersuite));
7703 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007704 }
7705
Neil Armstrongab555e02022-04-04 11:07:59 +02007706 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007707#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007708 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007709#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007710 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007711
Gilles Peskine449bd832023-01-11 14:50:10 +01007712 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007713 transform->taglen =
7714 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01007715 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007716
Dave Rodgman2eab4622023-10-05 13:30:37 +01007717 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01007718 transform->taglen,
7719 &alg,
7720 &key_type,
7721 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007722 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007723 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007724 goto end;
7725 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007726
Dave Rodgman2eab4622023-10-05 13:30:37 +01007727 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007728 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02007729 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01007730 (unsigned) ciphersuite_info->mac));
7731 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01007732 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007733
7734#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7735 /* Copy own and peer's CID if the use of the CID
7736 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007737 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
7738 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007739
7740 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007741 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
7742 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
7743 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007744
7745 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007746 memcpy(transform->out_cid, ssl->handshake->peer_cid,
7747 ssl->handshake->peer_cid_len);
7748 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
7749 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007750 }
7751#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7752
7753 /*
7754 * Compute key block using the PRF
7755 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007756 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
7757 if (ret != 0) {
7758 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7759 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007760 }
7761
Gilles Peskine449bd832023-01-11 14:50:10 +01007762 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
7763 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
7764 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
7765 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
7766 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007767
7768 /*
7769 * Determine the appropriate key, IV and MAC length.
7770 */
7771
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007772 keylen = PSA_BITS_TO_BYTES(key_bits);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007773
Valerio Settie5707042023-10-11 11:54:42 +02007774#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01007775 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007776 size_t explicit_ivlen;
7777
7778 transform->maclen = 0;
7779 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007780
7781 /* All modes haves 96-bit IVs, but the length of the static parts vary
7782 * with mode and version:
7783 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7784 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7785 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7786 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7787 * sequence number).
7788 */
7789 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01007790
7791 int is_chachapoly = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007792 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
David Horstmann3b2276a2022-10-06 14:49:08 +01007793
Gilles Peskine449bd832023-01-11 14:50:10 +01007794 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007795 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01007796 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007797 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01007798 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007799
7800 /* Minimum length of encrypted record */
7801 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7802 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007803 } else
Valerio Settie5707042023-10-11 11:54:42 +02007804#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007805#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007806 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007807 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01007808 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007809 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007810
Neil Armstronge4512952022-03-08 09:08:22 +01007811 /* Get MAC length */
7812 mac_key_len = PSA_HASH_LENGTH(mac_alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007813 transform->maclen = mac_key_len;
7814
7815 /* IV length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007816 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007817
7818 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007819 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007820 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007821 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007822 /*
7823 * GenericBlockCipher:
7824 * 1. if EtM is in use: one block plus MAC
7825 * otherwise: * first multiple of blocklen greater than maclen
7826 * 2. IV
7827 */
7828#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007829 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007830 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007831 + block_size;
7832 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007833#endif
7834 {
7835 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007836 + block_size
7837 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007838 }
7839
Gilles Peskine449bd832023-01-11 14:50:10 +01007840 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007841 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007842 } else {
7843 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007844 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7845 goto end;
7846 }
7847 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007848 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007849#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7850 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007851 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7852 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007853 }
7854
Gilles Peskine449bd832023-01-11 14:50:10 +01007855 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7856 (unsigned) keylen,
7857 (unsigned) transform->minlen,
7858 (unsigned) transform->ivlen,
7859 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007860
7861 /*
7862 * Finally setup the cipher contexts, IVs and MAC secrets.
7863 */
7864#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007865 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007866 key1 = keyblk + mac_key_len * 2;
7867 key2 = keyblk + mac_key_len * 2 + keylen;
7868
7869 mac_enc = keyblk;
7870 mac_dec = keyblk + mac_key_len;
7871
Gilles Peskine449bd832023-01-11 14:50:10 +01007872 iv_copy_len = (transform->fixed_ivlen) ?
7873 transform->fixed_ivlen : transform->ivlen;
7874 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
7875 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
7876 iv_copy_len);
7877 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007878#endif /* MBEDTLS_SSL_CLI_C */
7879#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007880 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007881 key1 = keyblk + mac_key_len * 2 + keylen;
7882 key2 = keyblk + mac_key_len * 2;
7883
7884 mac_enc = keyblk + mac_key_len;
7885 mac_dec = keyblk;
7886
Gilles Peskine449bd832023-01-11 14:50:10 +01007887 iv_copy_len = (transform->fixed_ivlen) ?
7888 transform->fixed_ivlen : transform->ivlen;
7889 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
7890 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
7891 iv_copy_len);
7892 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007893#endif /* MBEDTLS_SSL_SRV_C */
7894 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007895 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007896 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7897 goto end;
7898 }
7899
Paul Elliott4fb19552023-10-18 12:15:30 +01007900 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007901 ssl->f_export_keys(ssl->p_export_keys,
7902 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7903 master, 48,
7904 randbytes + 32,
7905 randbytes,
7906 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007907 }
7908
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007909 transform->psa_alg = alg;
7910
Gilles Peskine449bd832023-01-11 14:50:10 +01007911 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
7912 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
7913 psa_set_key_algorithm(&attributes, alg);
7914 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007915
Gilles Peskine449bd832023-01-11 14:50:10 +01007916 if ((status = psa_import_key(&attributes,
7917 key1,
7918 PSA_BITS_TO_BYTES(key_bits),
7919 &transform->psa_key_enc)) != PSA_SUCCESS) {
7920 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007921 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007922 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007923 goto end;
7924 }
7925
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007927
Gilles Peskine449bd832023-01-11 14:50:10 +01007928 if ((status = psa_import_key(&attributes,
7929 key2,
7930 PSA_BITS_TO_BYTES(key_bits),
7931 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007932 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007933 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007934 goto end;
7935 }
7936 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007937
Neil Armstrong29c0c042022-03-17 17:47:28 +01007938#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
7939 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
7940 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007941 if (mac_key_len != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007942 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01007943
Gilles Peskine449bd832023-01-11 14:50:10 +01007944 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
7945 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
7946 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01007947
Gilles Peskine449bd832023-01-11 14:50:10 +01007948 if ((status = psa_import_key(&attributes,
7949 mac_enc, mac_key_len,
7950 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007951 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007952 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01007953 goto end;
7954 }
7955
Gilles Peskine449bd832023-01-11 14:50:10 +01007956 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
7957 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04007958#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007959 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04007960#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007961 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01007962 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01007963 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
7964 PSA_KEY_USAGE_VERIFY_HASH);
7965 } else {
7966 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
7967 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01007968
Gilles Peskine449bd832023-01-11 14:50:10 +01007969 if ((status = psa_import_key(&attributes,
7970 mac_dec, mac_key_len,
7971 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007972 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007973 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01007974 goto end;
7975 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01007976 }
7977#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7978
7979 ((void) mac_dec);
7980 ((void) mac_enc);
7981
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007982end:
Gilles Peskine449bd832023-01-11 14:50:10 +01007983 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
7984 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007985}
7986
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01007987#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Valerio Setti6b3dab02022-11-17 17:14:54 +01007988int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01007989 psa_pake_operation_t *pake_ctx,
7990 const unsigned char *buf,
7991 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01007992{
7993 psa_status_t status;
7994 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01007995 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01007996 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
7997 * At round two perform a single cycle
7998 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007999 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008000
Gilles Peskine449bd832023-01-11 14:50:10 +01008001 for (; remaining_steps > 0; remaining_steps--) {
8002 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008003 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008004 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008005 /* Length is stored at the first byte */
8006 size_t length = buf[input_offset];
8007 input_offset += 1;
8008
Gilles Peskine449bd832023-01-11 14:50:10 +01008009 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008010 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8011 }
8012
Gilles Peskine449bd832023-01-11 14:50:10 +01008013 status = psa_pake_input(pake_ctx, step,
8014 buf + input_offset, length);
8015 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008016 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008017 }
8018
8019 input_offset += length;
8020 }
8021 }
8022
Gilles Peskine449bd832023-01-11 14:50:10 +01008023 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008024 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008025 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008026
Gilles Peskine449bd832023-01-11 14:50:10 +01008027 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008028}
8029
Valerio Setti6b3dab02022-11-17 17:14:54 +01008030int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008031 psa_pake_operation_t *pake_ctx,
8032 unsigned char *buf,
8033 size_t len, size_t *olen,
8034 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008035{
8036 psa_status_t status;
8037 size_t output_offset = 0;
8038 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008039 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008040 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8041 * At round two perform a single cycle
8042 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008043 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008044
Gilles Peskine449bd832023-01-11 14:50:10 +01008045 for (; remaining_steps > 0; remaining_steps--) {
8046 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8047 step <= PSA_PAKE_STEP_ZK_PROOF;
8048 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008049 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008050 * For each step, prepend 1 byte with the length of the data as
8051 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008052 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008053 status = psa_pake_output(pake_ctx, step,
8054 buf + output_offset + 1,
8055 len - output_offset - 1,
8056 &output_len);
8057 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008058 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008059 }
8060
Valerio Setti99d88c12022-11-22 16:03:43 +01008061 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008062
8063 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008064 }
8065 }
8066
8067 *olen = output_offset;
8068
Gilles Peskine449bd832023-01-11 14:50:10 +01008069 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008070}
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008071#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Valerio Settia08b1a42022-11-17 15:10:02 +01008072
Gilles Peskine449bd832023-01-11 14:50:10 +01008073int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8074 unsigned char *hash, size_t *hashlen,
8075 unsigned char *data, size_t data_len,
8076 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008077{
8078 psa_status_t status;
8079 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008080 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008081
Gilles Peskine449bd832023-01-11 14:50:10 +01008082 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008083
Gilles Peskine449bd832023-01-11 14:50:10 +01008084 if ((status = psa_hash_setup(&hash_operation,
8085 hash_alg)) != PSA_SUCCESS) {
8086 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008087 goto exit;
8088 }
8089
Gilles Peskine449bd832023-01-11 14:50:10 +01008090 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8091 64)) != PSA_SUCCESS) {
8092 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008093 goto exit;
8094 }
8095
Gilles Peskine449bd832023-01-11 14:50:10 +01008096 if ((status = psa_hash_update(&hash_operation,
8097 data, data_len)) != PSA_SUCCESS) {
8098 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008099 goto exit;
8100 }
8101
Gilles Peskine449bd832023-01-11 14:50:10 +01008102 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8103 hashlen)) != PSA_SUCCESS) {
8104 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8105 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008106 }
8107
8108exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008109 if (status != PSA_SUCCESS) {
8110 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8111 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8112 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008113 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008114 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008115 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8116 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008117 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008118 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008119 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008120 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008121 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008122 }
8123 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008124 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008125}
8126
Jerry Yuee40f9d2022-02-17 14:55:16 +08008127
Jerry Yud9d91da2022-02-17 14:57:06 +08008128#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8129
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008130/* Find the preferred hash for a given signature algorithm. */
8131unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008132 mbedtls_ssl_context *ssl,
8133 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008134{
Gabor Mezei078e8032022-04-27 21:17:56 +02008135 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008136 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008137
Gilles Peskine449bd832023-01-11 14:50:10 +01008138 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8139 return MBEDTLS_SSL_HASH_NONE;
8140 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008141
Gilles Peskine449bd832023-01-11 14:50:10 +01008142 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008143 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008144 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8145 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008146 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008147 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8148 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008149
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008150 mbedtls_md_type_t md_alg =
8151 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8152 if (md_alg == MBEDTLS_MD_NONE) {
8153 continue;
8154 }
8155
Gilles Peskine449bd832023-01-11 14:50:10 +01008156 if (sig_alg == sig_alg_received) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008157 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008158 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008159 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008160
Gilles Peskine449bd832023-01-11 14:50:10 +01008161 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8162 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8163 PSA_ALG_ECDSA(psa_hash_alg),
8164 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008165 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008166 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008167
Gilles Peskine449bd832023-01-11 14:50:10 +01008168 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8169 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8170 PSA_ALG_RSA_PKCS1V15_SIGN(
8171 psa_hash_alg),
8172 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008173 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008174 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008175 }
Neil Armstrong96eceb82022-06-30 18:05:05 +02008176
Gilles Peskine449bd832023-01-11 14:50:10 +01008177 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008178 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008179 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008180
Gilles Peskine449bd832023-01-11 14:50:10 +01008181 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008182}
8183
8184#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8185
Jerry Yudc7bd172022-02-17 13:44:15 +08008186#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8187
XiaokangQian75d40ef2022-04-20 11:05:24 +00008188int mbedtls_ssl_validate_ciphersuite(
8189 const mbedtls_ssl_context *ssl,
8190 const mbedtls_ssl_ciphersuite_t *suite_info,
8191 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01008192 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008193{
8194 (void) ssl;
8195
Gilles Peskine449bd832023-01-11 14:50:10 +01008196 if (suite_info == NULL) {
8197 return -1;
8198 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00008199
Gilles Peskine449bd832023-01-11 14:50:10 +01008200 if ((suite_info->min_tls_version > max_tls_version) ||
8201 (suite_info->max_tls_version < min_tls_version)) {
8202 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008203 }
8204
XiaokangQian060d8672022-04-21 09:24:56 +00008205#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008206#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008207 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
Manuel Pégourié-Gonnard88800dd2025-01-23 11:01:35 +01008208 ssl->handshake->psa_pake_ctx_is_ok != 1) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008209 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008210 }
8211#endif
8212
8213 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8214#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008215 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
8216 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
8217 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008218 }
8219#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8220#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8221
Gilles Peskine449bd832023-01-11 14:50:10 +01008222 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008223}
8224
Ronald Crone68ab4f2022-10-05 12:46:29 +02008225#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00008226/*
8227 * Function for writing a signature algorithm extension.
8228 *
8229 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8230 * value (TLS 1.3 RFC8446):
8231 * enum {
8232 * ....
8233 * ecdsa_secp256r1_sha256( 0x0403 ),
8234 * ecdsa_secp384r1_sha384( 0x0503 ),
8235 * ecdsa_secp521r1_sha512( 0x0603 ),
8236 * ....
8237 * } SignatureScheme;
8238 *
8239 * struct {
8240 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8241 * } SignatureSchemeList;
8242 *
8243 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8244 * value (TLS 1.2 RFC5246):
8245 * enum {
8246 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8247 * sha512(6), (255)
8248 * } HashAlgorithm;
8249 *
8250 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8251 * SignatureAlgorithm;
8252 *
8253 * struct {
8254 * HashAlgorithm hash;
8255 * SignatureAlgorithm signature;
8256 * } SignatureAndHashAlgorithm;
8257 *
8258 * SignatureAndHashAlgorithm
8259 * supported_signature_algorithms<2..2^16-2>;
8260 *
8261 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8262 * generalization of the TLS 1.2 signature algorithm extension.
8263 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8264 * `SignatureScheme` field of TLS 1.3
8265 *
8266 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008267int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
8268 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00008269{
8270 unsigned char *p = buf;
8271 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8272 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8273
8274 *out_len = 0;
8275
Gilles Peskine449bd832023-01-11 14:50:10 +01008276 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00008277
8278 /* Check if we have space for header and length field:
8279 * - extension_type (2 bytes)
8280 * - extension_data_length (2 bytes)
8281 * - supported_signature_algorithms_length (2 bytes)
8282 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008283 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00008284 p += 6;
8285
8286 /*
8287 * Write supported_signature_algorithms
8288 */
8289 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01008290 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
8291 if (sig_alg == NULL) {
8292 return MBEDTLS_ERR_SSL_BAD_CONFIG;
8293 }
XiaokangQianeaf36512022-04-24 09:07:44 +00008294
Gilles Peskine449bd832023-01-11 14:50:10 +01008295 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
8296 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
8297 *sig_alg,
8298 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
8299 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00008300 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008301 }
8302 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
8303 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00008304 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008305 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
8306 *sig_alg,
8307 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00008308 }
8309
8310 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008311 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01008312 if (supported_sig_alg_len == 0) {
8313 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
8314 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00008315 }
8316
Gilles Peskine449bd832023-01-11 14:50:10 +01008317 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
8318 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
8319 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00008320
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008321 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00008322
8323#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008324 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00008325#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08008326
Gilles Peskine449bd832023-01-11 14:50:10 +01008327 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00008328}
Ronald Crone68ab4f2022-10-05 12:46:29 +02008329#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00008330
XiaokangQian40a35232022-05-07 09:02:40 +00008331#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008332/*
8333 * mbedtls_ssl_parse_server_name_ext
8334 *
8335 * Structure of server_name extension:
8336 *
8337 * enum {
8338 * host_name(0), (255)
8339 * } NameType;
8340 * opaque HostName<1..2^16-1>;
8341 *
8342 * struct {
8343 * NameType name_type;
8344 * select (name_type) {
8345 * case host_name: HostName;
8346 * } name;
8347 * } ServerName;
8348 * struct {
8349 * ServerName server_name_list<1..2^16-1>
8350 * } ServerNameList;
8351 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008352MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008353int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
8354 const unsigned char *buf,
8355 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00008356{
8357 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8358 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008359 size_t server_name_list_len, hostname_len;
8360 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008361
Gilles Peskine449bd832023-01-11 14:50:10 +01008362 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00008363
Gilles Peskine449bd832023-01-11 14:50:10 +01008364 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
8365 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00008366 p += 2;
8367
Gilles Peskine449bd832023-01-11 14:50:10 +01008368 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00008369 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008370 while (p < server_name_list_end) {
8371 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
8372 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
8373 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
8374 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00008375
Gilles Peskine449bd832023-01-11 14:50:10 +01008376 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008377 /* sni_name is intended to be used only during the parsing of the
8378 * ClientHello message (it is reset to NULL before the end of
8379 * the message parsing). Thus it is ok to just point to the
8380 * reception buffer and not make a copy of it.
8381 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008382 ssl->handshake->sni_name = p + 3;
8383 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008384 if (ssl->conf->f_sni == NULL) {
8385 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008386 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008387 ret = ssl->conf->f_sni(ssl->conf->p_sni,
8388 ssl, p + 3, hostname_len);
8389 if (ret != 0) {
8390 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
8391 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8392 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
8393 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
8394 }
8395 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008396 }
8397
8398 p += hostname_len + 3;
8399 }
8400
Gilles Peskine449bd832023-01-11 14:50:10 +01008401 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008402}
8403#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8404
XiaokangQianacb39922022-06-17 10:18:48 +00008405#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008406MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008407int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
8408 const unsigned char *buf,
8409 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00008410{
8411 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008412 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008413 const unsigned char *protocol_name_list;
8414 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008415 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008416
8417 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01008418 if (ssl->conf->alpn_list == NULL) {
8419 return 0;
8420 }
XiaokangQianacb39922022-06-17 10:18:48 +00008421
8422 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008423 * RFC7301, section 3.1
8424 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008425 *
XiaokangQianc7403452022-06-23 03:24:12 +00008426 * struct {
8427 * ProtocolName protocol_name_list<2..2^16-1>
8428 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008429 */
8430
XiaokangQianc7403452022-06-23 03:24:12 +00008431 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008432 * protocol_name_list_len 2 bytes
8433 * protocol_name_len 1 bytes
8434 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008435 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008436 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00008437
Gilles Peskine449bd832023-01-11 14:50:10 +01008438 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008439 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008440 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00008441 protocol_name_list = p;
8442 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008443
8444 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01008445 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008446 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008447 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
8448 protocol_name_len);
8449 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008450 MBEDTLS_SSL_PEND_FATAL_ALERT(
8451 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01008452 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
8453 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00008454 }
8455
8456 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008457 }
8458
8459 /* Use our order of preference */
Gilles Peskinec4949d12025-05-27 19:45:29 +02008460 for (const char *const *alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008461 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00008462 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01008463 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008464 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008465 if (protocol_name_len == alpn_len &&
8466 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00008467 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01008468 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008469 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008470
8471 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008472 }
8473 }
8474
XiaokangQian95d5f542022-06-24 02:29:26 +00008475 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008476 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01008477 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8478 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
8479 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00008480}
8481
Gilles Peskine449bd832023-01-11 14:50:10 +01008482int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
8483 unsigned char *buf,
8484 unsigned char *end,
8485 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00008486{
8487 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008488 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008489 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008490
Gilles Peskine449bd832023-01-11 14:50:10 +01008491 if (ssl->alpn_chosen == NULL) {
8492 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008493 }
8494
Gilles Peskine449bd832023-01-11 14:50:10 +01008495 protocol_name_len = strlen(ssl->alpn_chosen);
8496 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008497
Gilles Peskine449bd832023-01-11 14:50:10 +01008498 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00008499 /*
8500 * 0 . 1 ext identifier
8501 * 2 . 3 ext length
8502 * 4 . 5 protocol list length
8503 * 6 . 6 protocol name length
8504 * 7 . 7+n protocol name
8505 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008506 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008507
XiaokangQian95d5f542022-06-24 02:29:26 +00008508 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008509
Gilles Peskine449bd832023-01-11 14:50:10 +01008510 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
8511 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00008512 /* Note: the length of the chosen protocol has been checked to be less
8513 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8514 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008515 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008516
Gilles Peskine449bd832023-01-11 14:50:10 +01008517 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08008518
8519#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008520 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08008521#endif
8522
Gilles Peskine449bd832023-01-11 14:50:10 +01008523 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008524}
8525#endif /* MBEDTLS_SSL_ALPN */
8526
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008527#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00008528 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008529 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008530 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008531int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
8532 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008533{
8534 /* Initialize to suppress unnecessary compiler warning */
8535 size_t hostname_len = 0;
8536
8537 /* Check if new hostname is valid before
8538 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008539 if (hostname != NULL) {
8540 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008541
Gilles Peskine449bd832023-01-11 14:50:10 +01008542 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
8543 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8544 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008545 }
8546
8547 /* Now it's clear that we will overwrite the old hostname,
8548 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01008549 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008550 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01008551 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008552 }
8553
8554 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008555 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008556 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01008557 } else {
8558 session->hostname = mbedtls_calloc(1, hostname_len + 1);
8559 if (session->hostname == NULL) {
8560 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8561 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008562
Gilles Peskine449bd832023-01-11 14:50:10 +01008563 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008564 }
8565
Gilles Peskine449bd832023-01-11 14:50:10 +01008566 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008567}
Xiaokang Qian03409292022-10-12 02:49:52 +00008568#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
8569 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008570 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008571 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008572
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008573#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
8574 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008575int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
8576 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008577{
8578 size_t alpn_len = 0;
8579
8580 if (alpn != NULL) {
8581 alpn_len = strlen(alpn);
8582
8583 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
8584 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8585 }
8586 }
8587
8588 if (session->ticket_alpn != NULL) {
8589 mbedtls_zeroize_and_free(session->ticket_alpn,
8590 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008591 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008592 }
8593
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008594 if (alpn != NULL) {
8595 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008596 if (session->ticket_alpn == NULL) {
8597 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8598 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008599 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008600 }
8601
8602 return 0;
8603}
8604#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008605
8606/*
8607 * The following functions are used by 1.2 and 1.3, client and server.
8608 */
8609#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
8610int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
8611 const mbedtls_ssl_ciphersuite_t *ciphersuite,
8612 int recv_endpoint,
8613 mbedtls_ssl_protocol_version tls_version,
8614 uint32_t *flags)
8615{
8616 int ret = 0;
8617 unsigned int usage = 0;
8618 const char *ext_oid;
8619 size_t ext_len;
8620
8621 /*
8622 * keyUsage
8623 */
8624
8625 /* Note: don't guard this with MBEDTLS_SSL_CLI_C because the server wants
8626 * to check what a compliant client will think while choosing which cert
8627 * to send to the client. */
8628#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
8629 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8630 recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8631 /* TLS 1.2 server part of the key exchange */
8632 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008633 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
8634 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
8635 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8636 break;
8637
8638 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
8639 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
8640 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
8641 break;
8642
8643 /* Don't use default: we want warnings when adding new values */
8644 case MBEDTLS_KEY_EXCHANGE_NONE:
8645 case MBEDTLS_KEY_EXCHANGE_PSK:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008646 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
8647 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
8648 usage = 0;
8649 }
8650 } else
8651#endif
8652 {
8653 /* This is either TLS 1.3 authentication, which always uses signatures,
8654 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
8655 * options we implement, both using signatures. */
8656 (void) tls_version;
8657 (void) ciphersuite;
8658 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8659 }
8660
8661 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
8662 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
8663 ret = -1;
8664 }
8665
8666 /*
8667 * extKeyUsage
8668 */
8669
8670 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8671 ext_oid = MBEDTLS_OID_SERVER_AUTH;
8672 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
8673 } else {
8674 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
8675 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
8676 }
8677
8678 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
8679 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
8680 ret = -1;
8681 }
8682
8683 return ret;
8684}
8685
Gilles Peskine4ac40082025-02-20 18:13:58 +01008686static int get_hostname_for_verification(mbedtls_ssl_context *ssl,
8687 const char **hostname)
8688{
8689 if (!mbedtls_ssl_has_set_hostname_been_called(ssl)) {
8690 MBEDTLS_SSL_DEBUG_MSG(1, ("Certificate verification without having set hostname"));
Gilles Peskine488b9192025-02-13 14:39:02 +01008691 if (mbedtls_ssl_conf_get_endpoint(ssl->conf) == MBEDTLS_SSL_IS_CLIENT &&
8692 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8693 return MBEDTLS_ERR_SSL_CERTIFICATE_VERIFICATION_WITHOUT_HOSTNAME;
8694 }
Gilles Peskine4ac40082025-02-20 18:13:58 +01008695 }
8696
8697 *hostname = ssl->hostname;
8698 if (*hostname == NULL) {
8699 MBEDTLS_SSL_DEBUG_MSG(2, ("Certificate verification without CN verification"));
8700 }
8701
8702 return 0;
8703}
8704
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008705int mbedtls_ssl_verify_certificate(mbedtls_ssl_context *ssl,
8706 int authmode,
8707 mbedtls_x509_crt *chain,
8708 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
8709 void *rs_ctx)
8710{
8711 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
8712 return 0;
8713 }
8714
8715 /*
8716 * Primary check: use the appropriate X.509 verification function
8717 */
8718 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
8719 void *p_vrfy;
8720 if (ssl->f_vrfy != NULL) {
8721 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
8722 f_vrfy = ssl->f_vrfy;
8723 p_vrfy = ssl->p_vrfy;
8724 } else {
8725 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
8726 f_vrfy = ssl->conf->f_vrfy;
8727 p_vrfy = ssl->conf->p_vrfy;
8728 }
8729
Gilles Peskine4ac40082025-02-20 18:13:58 +01008730 const char *hostname = "";
8731 int ret = get_hostname_for_verification(ssl, &hostname);
8732 if (ret != 0) {
8733 MBEDTLS_SSL_DEBUG_RET(1, "get_hostname_for_verification", ret);
8734 return ret;
8735 }
8736
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008737 int have_ca_chain_or_callback = 0;
8738#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
8739 if (ssl->conf->f_ca_cb != NULL) {
8740 ((void) rs_ctx);
8741 have_ca_chain_or_callback = 1;
8742
8743 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
8744 ret = mbedtls_x509_crt_verify_with_ca_cb(
8745 chain,
8746 ssl->conf->f_ca_cb,
8747 ssl->conf->p_ca_cb,
8748 ssl->conf->cert_profile,
Gilles Peskine4ac40082025-02-20 18:13:58 +01008749 hostname,
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008750 &ssl->session_negotiate->verify_result,
8751 f_vrfy, p_vrfy);
8752 } else
8753#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
8754 {
8755 mbedtls_x509_crt *ca_chain;
8756 mbedtls_x509_crl *ca_crl;
8757#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8758 if (ssl->handshake->sni_ca_chain != NULL) {
8759 ca_chain = ssl->handshake->sni_ca_chain;
8760 ca_crl = ssl->handshake->sni_ca_crl;
8761 } else
8762#endif
8763 {
8764 ca_chain = ssl->conf->ca_chain;
8765 ca_crl = ssl->conf->ca_crl;
8766 }
8767
8768 if (ca_chain != NULL) {
8769 have_ca_chain_or_callback = 1;
8770 }
8771
8772 ret = mbedtls_x509_crt_verify_restartable(
8773 chain,
8774 ca_chain, ca_crl,
8775 ssl->conf->cert_profile,
Gilles Peskine4ac40082025-02-20 18:13:58 +01008776 hostname,
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008777 &ssl->session_negotiate->verify_result,
8778 f_vrfy, p_vrfy, rs_ctx);
8779 }
8780
8781 if (ret != 0) {
8782 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
8783 }
8784
8785#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
8786 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8787 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8788 }
8789#endif
8790
8791 /*
8792 * Secondary checks: always done, but change 'ret' only if it was 0
8793 */
8794
8795 /* With TLS 1.2 and ECC certs, check that the curve used by the
8796 * certificate is on our list of acceptable curves.
8797 *
8798 * With TLS 1.3 this is not needed because the curve is part of the
8799 * signature algorithm (eg ecdsa_secp256r1_sha256) which is checked when
8800 * we validate the signature made with the key associated to this cert.
8801 */
8802#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
8803 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
8804 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8805 mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY)) {
8806 if (mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
8807 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8808 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
8809 if (ret == 0) {
8810 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8811 }
8812 }
8813 }
8814#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
8815
8816 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
8817 if (mbedtls_ssl_check_cert_usage(chain,
8818 ciphersuite_info,
8819 ssl->conf->endpoint,
8820 ssl->tls_version,
8821 &ssl->session_negotiate->verify_result) != 0) {
8822 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8823 if (ret == 0) {
8824 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8825 }
8826 }
8827
8828 /* With authmode optional, we want to keep going if the certificate was
8829 * unacceptable, but still fail on other errors (out of memory etc),
8830 * including fatal errors from the f_vrfy callback.
8831 *
8832 * The only acceptable errors are:
8833 * - MBEDTLS_ERR_X509_CERT_VERIFY_FAILED: cert rejected by primary check;
8834 * - MBEDTLS_ERR_SSL_BAD_CERTIFICATE: cert rejected by secondary checks.
8835 * Anything else is a fatal error. */
8836 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8837 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8838 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
8839 ret = 0;
8840 }
8841
8842 /* Return a specific error as this is a user error: inconsistent
8843 * configuration - can't verify without trust anchors. */
8844 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8845 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
8846 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8847 }
8848
8849 if (ret != 0) {
8850 uint8_t alert;
8851
8852 /* The certificate may have been rejected for several reasons.
8853 Pick one and send the corresponding alert. Which alert to send
8854 may be a subject of debate in some cases. */
8855 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
8856 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
8857 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
8858 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
8859 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
8860 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8861 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
8862 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8863 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
8864 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8865 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
8866 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8867 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
8868 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
8869 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
8870 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
8871 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
8872 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
8873 } else {
8874 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
8875 }
8876 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8877 alert);
8878 }
8879
8880#if defined(MBEDTLS_DEBUG_C)
8881 if (ssl->session_negotiate->verify_result != 0) {
8882 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8883 (unsigned int) ssl->session_negotiate->verify_result));
8884 } else {
8885 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
8886 }
8887#endif /* MBEDTLS_DEBUG_C */
8888
8889 return ret;
8890}
8891#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
8892
Max Fillinger2fe35f62024-10-25 00:52:24 +02008893#if defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT)
Max Fillinger281fb792024-10-23 18:35:09 +02008894
Max Fillinger29beade2024-09-21 11:06:28 +02008895#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008896static int mbedtls_ssl_tls12_export_keying_material(const mbedtls_ssl_context *ssl,
8897 const mbedtls_md_type_t hash_alg,
Max Fillinger7b722202024-09-21 10:48:57 +02008898 uint8_t *out,
8899 const size_t key_len,
8900 const char *label,
8901 const size_t label_len,
8902 const unsigned char *context,
8903 const size_t context_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008904 const int use_context)
8905{
8906 int ret = 0;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008907 unsigned char *prf_input = NULL;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008908
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008909 /* The input to the PRF is client_random, then server_random.
8910 * If a context is provided, this is then followed by the context length
8911 * as a 16-bit big-endian integer, and then the context itself. */
Max Fillinger155cea02024-10-23 16:32:54 +02008912 const size_t randbytes_len = MBEDTLS_CLIENT_HELLO_RANDOM_LEN + MBEDTLS_SERVER_HELLO_RANDOM_LEN;
8913 size_t prf_input_len = randbytes_len;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008914 if (use_context) {
Max Fillinger155cea02024-10-23 16:32:54 +02008915 if (context_len > UINT16_MAX) {
8916 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8917 }
8918
8919 /* This does not overflow a 32-bit size_t because the current value of
8920 * prf_input_len is 64 (length of client_random + server_random) and
8921 * context_len fits into two bytes (checked above). */
8922 prf_input_len += sizeof(uint16_t) + context_len;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008923 }
Max Fillinger155cea02024-10-23 16:32:54 +02008924
8925 prf_input = mbedtls_calloc(prf_input_len, sizeof(unsigned char));
8926 if (prf_input == NULL) {
8927 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8928 }
8929
8930 memcpy(prf_input,
8931 ssl->transform->randbytes + MBEDTLS_SERVER_HELLO_RANDOM_LEN,
8932 MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
8933 memcpy(prf_input + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
8934 ssl->transform->randbytes,
8935 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
8936 if (use_context) {
8937 MBEDTLS_PUT_UINT16_BE(context_len, prf_input, randbytes_len);
8938 memcpy(prf_input + randbytes_len + sizeof(uint16_t), context, context_len);
8939 }
8940 ret = tls_prf_generic(hash_alg, ssl->session->master, sizeof(ssl->session->master),
Max Fillingerf2dda152024-10-23 15:47:23 +02008941 label, label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008942 prf_input, prf_input_len,
8943 out, key_len);
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008944 mbedtls_free(prf_input);
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008945 return ret;
8946}
Max Fillinger281fb792024-10-23 18:35:09 +02008947#endif /* defined(MBEDTLS_SSL_PROTO_TLS1_2) */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008948
Max Fillinger29beade2024-09-21 11:06:28 +02008949#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008950static int mbedtls_ssl_tls13_export_keying_material(mbedtls_ssl_context *ssl,
8951 const mbedtls_md_type_t hash_alg,
Max Fillinger7b722202024-09-21 10:48:57 +02008952 uint8_t *out,
8953 const size_t key_len,
8954 const char *label,
8955 const size_t label_len,
8956 const unsigned char *context,
8957 const size_t context_len)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008958{
8959 const psa_algorithm_t psa_hash_alg = mbedtls_md_psa_alg_from_type(hash_alg);
8960 const size_t hash_len = PSA_HASH_LENGTH(hash_alg);
8961 const unsigned char *secret = ssl->session->app_secrets.exporter_master_secret;
8962
Max Fillinger9c5bae52024-11-21 12:33:46 +01008963 /* The length of the label must be at most 249 bytes to fit into the HkdfLabel
Max Fillingerc6fd1a22024-11-01 16:05:34 +01008964 * struct as defined in RFC 8446, Section 7.1.
Max Fillinger3e129182024-10-29 19:18:54 +01008965 *
Max Fillingerc6fd1a22024-11-01 16:05:34 +01008966 * The length of the context is unlimited even though the context field in the
Max Fillinger9c5bae52024-11-21 12:33:46 +01008967 * struct can only hold up to 255 bytes. This is because we place a *hash* of
Max Fillingerc6fd1a22024-11-01 16:05:34 +01008968 * the context in the field. */
Max Fillinger9c5bae52024-11-21 12:33:46 +01008969 if (label_len > 249) {
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008970 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8971 }
8972
8973 return mbedtls_ssl_tls13_exporter(psa_hash_alg, secret, hash_len,
Max Fillinger7b722202024-09-21 10:48:57 +02008974 (const unsigned char *) label, label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008975 context, context_len, out, key_len);
8976}
Max Fillinger281fb792024-10-23 18:35:09 +02008977#endif /* defined(MBEDTLS_SSL_PROTO_TLS1_3) */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008978
8979int mbedtls_ssl_export_keying_material(mbedtls_ssl_context *ssl,
Max Fillinger9c9989f2024-08-14 16:44:50 +02008980 uint8_t *out, const size_t key_len,
8981 const char *label, const size_t label_len,
8982 const unsigned char *context, const size_t context_len,
8983 const int use_context)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008984{
8985 if (!mbedtls_ssl_is_handshake_over(ssl)) {
Max Fillinger53d91682024-11-18 18:22:51 +01008986 /* TODO: Change this to a more appropriate error code when one is available. */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008987 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8988 }
8989
Max Fillingerc6fd1a22024-11-01 16:05:34 +01008990 if (key_len > MBEDTLS_SSL_EXPORT_MAX_KEY_LEN) {
8991 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8992 }
8993
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008994 int ciphersuite_id = mbedtls_ssl_get_ciphersuite_id_from_ssl(ssl);
8995 const mbedtls_ssl_ciphersuite_t *ciphersuite = mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
8996 const mbedtls_md_type_t hash_alg = ciphersuite->mac;
8997
8998 switch (mbedtls_ssl_get_version_number(ssl)) {
Max Fillinger29beade2024-09-21 11:06:28 +02008999#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009000 case MBEDTLS_SSL_VERSION_TLS1_2:
9001 return mbedtls_ssl_tls12_export_keying_material(ssl, hash_alg, out, key_len,
9002 label, label_len,
9003 context, context_len, use_context);
Max Fillinger29beade2024-09-21 11:06:28 +02009004#endif
9005#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009006 case MBEDTLS_SSL_VERSION_TLS1_3:
Max Fillinger7b722202024-09-21 10:48:57 +02009007 return mbedtls_ssl_tls13_export_keying_material(ssl,
9008 hash_alg,
9009 out,
9010 key_len,
9011 label,
9012 label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009013 use_context ? context : NULL,
9014 use_context ? context_len : 0);
Max Fillinger29beade2024-09-21 11:06:28 +02009015#endif
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009016 default:
9017 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
9018 }
9019}
9020
Max Fillinger2fe35f62024-10-25 00:52:24 +02009021#endif /* defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT) */
Max Fillinger281fb792024-10-23 18:35:09 +02009022
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009023#endif /* MBEDTLS_SSL_TLS_C */