blob: dee80292e2657066f556a2ef45af7eb8a188efb9 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002 * TLS shared functions
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00006 */
7/*
Paul Bakker5121ce52009-01-03 21:22:43 +00008 * http://www.ietf.org/rfc/rfc2246.txt
9 * http://www.ietf.org/rfc/rfc4346.txt
10 */
11
Harry Ramsey0f6bc412024-10-04 10:36:54 +010012#include "ssl_misc.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020014#if defined(MBEDTLS_SSL_TLS_C)
Paul Bakker5121ce52009-01-03 21:22:43 +000015
SimonBd5800b72016-04-26 07:43:27 +010016#include "mbedtls/platform.h"
SimonBd5800b72016-04-26 07:43:27 +010017
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000018#include "mbedtls/ssl.h"
Ronald Cron9f0fba32022-02-10 16:45:15 +010019#include "ssl_client.h"
Ronald Cron27c85e72022-03-08 11:37:55 +010020#include "ssl_debug_helpers.h"
Max Fillingerbd81c9d2024-07-22 14:43:56 +020021#include "ssl_tls13_keys.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040022
Valerio Settib4f50762024-01-17 10:24:52 +010023#include "debug_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000024#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050025#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010026#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020027#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020028
Rich Evans00ab4702015-02-06 13:43:58 +000029#include <string.h>
30
Valerio Setti384fbde2024-01-02 13:26:40 +010031#include "mbedtls/psa_util.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020032#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020033#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050034#include "psa/crypto.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050035
Janos Follath23bdca02016-10-07 14:47:14 +010036#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000037#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020038#endif
39
Andrzej Kurek00644842023-05-30 05:45:00 -040040/* Define local translating functions to save code size by not using too many
41 * arguments in each translating place. */
42static int local_err_translation(psa_status_t status)
43{
44 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040045 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040046 psa_generic_status_to_mbedtls);
47}
48#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050049
Ronald Cronad8c17b2022-06-10 17:18:09 +020050#if defined(MBEDTLS_TEST_HOOKS)
51static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
52
53void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010054 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020055{
56 chk_buf_ptr_fail_args.cur = cur;
57 chk_buf_ptr_fail_args.end = end;
58 chk_buf_ptr_fail_args.need = need;
59}
60
Gilles Peskine449bd832023-01-11 14:50:10 +010061void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020062{
Gilles Peskine449bd832023-01-11 14:50:10 +010063 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020064}
65
Gilles Peskine449bd832023-01-11 14:50:10 +010066int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020067{
Gilles Peskine449bd832023-01-11 14:50:10 +010068 return (chk_buf_ptr_fail_args.cur != args->cur) ||
69 (chk_buf_ptr_fail_args.end != args->end) ||
70 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020071}
72#endif /* MBEDTLS_TEST_HOOKS */
73
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020074#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010075
Hanno Beckera0e20d02019-05-15 14:03:01 +010076#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010077/* Top-level Connection ID API */
78
Gilles Peskine449bd832023-01-11 14:50:10 +010079int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
80 size_t len,
81 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010082{
Gilles Peskine449bd832023-01-11 14:50:10 +010083 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
84 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
85 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010086
Gilles Peskine449bd832023-01-11 14:50:10 +010087 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
88 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
89 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010090 }
91
92 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010093 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010094 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010095}
96
Gilles Peskine449bd832023-01-11 14:50:10 +010097int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
98 int enable,
99 unsigned char const *own_cid,
100 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100101{
Gilles Peskine449bd832023-01-11 14:50:10 +0100102 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
103 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
104 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100105
Hanno Beckerca092242019-04-25 16:01:49 +0100106 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100107 if (enable == MBEDTLS_SSL_CID_DISABLED) {
108 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
109 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100110 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100111 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
112 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100113
Gilles Peskine449bd832023-01-11 14:50:10 +0100114 if (own_cid_len != ssl->conf->cid_len) {
115 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
116 (unsigned) own_cid_len,
117 (unsigned) ssl->conf->cid_len));
118 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100119 }
120
Gilles Peskine449bd832023-01-11 14:50:10 +0100121 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100122 /* Truncation is not an issue here because
123 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
124 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100125
Gilles Peskine449bd832023-01-11 14:50:10 +0100126 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100127}
128
Gilles Peskine449bd832023-01-11 14:50:10 +0100129int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
130 int *enabled,
Sam Berry3504c882024-06-11 14:34:17 +0100131 unsigned char own_cid[MBEDTLS_SSL_CID_IN_LEN_MAX],
Gilles Peskine449bd832023-01-11 14:50:10 +0100132 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000133{
134 *enabled = MBEDTLS_SSL_CID_DISABLED;
135
Gilles Peskine449bd832023-01-11 14:50:10 +0100136 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
137 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
138 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000139
140 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
141 * zero as this is indistinguishable from not requesting to use
142 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100143 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
144 return 0;
145 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000146
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000148 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100149 if (own_cid != NULL) {
150 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
151 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000152 }
153
154 *enabled = MBEDTLS_SSL_CID_ENABLED;
155
Gilles Peskine449bd832023-01-11 14:50:10 +0100156 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000157}
158
Gilles Peskine449bd832023-01-11 14:50:10 +0100159int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
160 int *enabled,
161 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
162 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100163{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100164 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100165
Gilles Peskine449bd832023-01-11 14:50:10 +0100166 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
167 mbedtls_ssl_is_handshake_over(ssl) == 0) {
168 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100169 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100170
Hanno Beckerc5f24222019-05-03 12:54:52 +0100171 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
172 * were used, but client and server requested the empty CID.
173 * This is indistinguishable from not using the CID extension
174 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100175 if (ssl->transform_in->in_cid_len == 0 &&
176 ssl->transform_in->out_cid_len == 0) {
177 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100178 }
179
Gilles Peskine449bd832023-01-11 14:50:10 +0100180 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100181 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100182 if (peer_cid != NULL) {
183 memcpy(peer_cid, ssl->transform_in->out_cid,
184 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100185 }
186 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100187
188 *enabled = MBEDTLS_SSL_CID_ENABLED;
189
Gilles Peskine449bd832023-01-11 14:50:10 +0100190 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100191}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100192#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100193
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200194#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200195
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200196#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200197/*
198 * Convert max_fragment_length codes to length.
199 * RFC 6066 says:
200 * enum{
201 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
202 * } MaxFragmentLength;
203 * and we add 0 -> extension unused
204 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100205static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200206{
Gilles Peskine449bd832023-01-11 14:50:10 +0100207 switch (mfl) {
208 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
209 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
210 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
211 return 512;
212 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
213 return 1024;
214 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
215 return 2048;
216 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
217 return 4096;
218 default:
219 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000220 }
221}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200222#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200223
Gilles Peskine449bd832023-01-11 14:50:10 +0100224int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
225 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200226{
Gilles Peskine449bd832023-01-11 14:50:10 +0100227 mbedtls_ssl_session_free(dst);
228 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800229#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
230 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000231#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
232 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000233 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800234#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000235#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800236
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000237#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
238 defined(MBEDTLS_SSL_EARLY_DATA)
239 dst->ticket_alpn = NULL;
240#endif
241
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200242#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000243
244#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100245 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000246 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200247
Gilles Peskine449bd832023-01-11 14:50:10 +0100248 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
249 if (dst->peer_cert == NULL) {
250 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
251 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200252
Gilles Peskine449bd832023-01-11 14:50:10 +0100253 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200254
Gilles Peskine449bd832023-01-11 14:50:10 +0100255 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
256 src->peer_cert->raw.len)) != 0) {
257 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200258 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100259 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200260 }
261 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000262#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000264 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100265 mbedtls_calloc(1, src->peer_cert_digest_len);
266 if (dst->peer_cert_digest == NULL) {
267 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
268 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000269
Gilles Peskine449bd832023-01-11 14:50:10 +0100270 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
271 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000272 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000273 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000274 }
275#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
276
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200277#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200278
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000279#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
280 defined(MBEDTLS_SSL_EARLY_DATA)
281 {
282 int ret = mbedtls_ssl_session_set_ticket_alpn(dst, src->ticket_alpn);
283 if (ret != 0) {
284 return ret;
285 }
286 }
287#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_ALPN && MBEDTLS_SSL_EARLY_DATA */
288
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200289#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100290 if (src->ticket != NULL) {
291 dst->ticket = mbedtls_calloc(1, src->ticket_len);
292 if (dst->ticket == NULL) {
293 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
294 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200295
Gilles Peskine449bd832023-01-11 14:50:10 +0100296 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200297 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000298
299#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
300 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000302 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100303 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
304 if (ret != 0) {
305 return ret;
306 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000307 }
308#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
309 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200310#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200311
Gilles Peskine449bd832023-01-11 14:50:10 +0100312 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200313}
314
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500315#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200316MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100317static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500318{
Gilles Peskine449bd832023-01-11 14:50:10 +0100319 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
320 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800321 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100322 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500323
324 /* We want to copy len_new bytes when downsizing the buffer, and
325 * len_old bytes when upsizing, so we choose the smaller of two sizes,
326 * to fit one buffer into another. Size checks, ensuring that no data is
327 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100328 memcpy(resized_buffer, *buffer,
329 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100330 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500331
332 *buffer = resized_buffer;
333 *len_old = len_new;
334
335 return 0;
336}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200337
Gilles Peskine449bd832023-01-11 14:50:10 +0100338static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
339 size_t in_buf_new_len,
340 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200341{
342 int modified = 0;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000343 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0, hdr_in = 0;
Andrzej Kurek4a063792020-10-21 15:08:44 +0200344 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200346 written_in = ssl->in_msg - ssl->in_buf;
347 iv_offset_in = ssl->in_iv - ssl->in_buf;
348 len_offset_in = ssl->in_len - ssl->in_buf;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000349 hdr_in = ssl->in_hdr - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200351 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100352 ssl->in_buf_len < in_buf_new_len) {
353 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
354 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
355 } else {
356 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
357 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200358 modified = 1;
359 }
360 }
361 }
362
Gilles Peskine449bd832023-01-11 14:50:10 +0100363 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200364 written_out = ssl->out_msg - ssl->out_buf;
365 iv_offset_out = ssl->out_iv - ssl->out_buf;
366 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100367 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200368 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100369 ssl->out_buf_len < out_buf_new_len) {
370 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
371 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
372 } else {
373 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
374 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200375 modified = 1;
376 }
377 }
378 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100379 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200380 /* Update pointers here to avoid doing it twice. */
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000381 ssl->in_hdr = ssl->in_buf + hdr_in;
382 mbedtls_ssl_update_in_pointers(ssl);
383 mbedtls_ssl_reset_out_pointers(ssl);
384
Andrzej Kurek4a063792020-10-21 15:08:44 +0200385 /* Fields below might not be properly updated with record
386 * splitting or with CID, so they are manually updated here. */
387 ssl->out_msg = ssl->out_buf + written_out;
388 ssl->out_len = ssl->out_buf + len_offset_out;
389 ssl->out_iv = ssl->out_buf + iv_offset_out;
390
391 ssl->in_msg = ssl->in_buf + written_in;
392 ssl->in_len = ssl->in_buf + len_offset_in;
393 ssl->in_iv = ssl->in_buf + iv_offset_in;
394 }
395}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500396#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
397
Jerry Yudb8c48a2022-01-27 14:54:54 +0800398#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800399
400#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100401typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
402 const char *label,
403 const unsigned char *random, size_t rlen,
404 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800405
Gilles Peskine449bd832023-01-11 14:50:10 +0100406static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800407
408#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
409
410/* Type for the TLS PRF */
411typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
412 const unsigned char *, size_t,
413 unsigned char *, size_t);
414
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200415MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100416static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
417 int ciphersuite,
418 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200419#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200421#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100422 ssl_tls_prf_t tls_prf,
423 const unsigned char randbytes[64],
424 mbedtls_ssl_protocol_version tls_version,
425 unsigned endpoint,
426 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800427
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100428#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200429MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100430static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300431 const char *label,
432 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100434static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
435static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100436
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100437#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100438
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100439#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100440MBEDTLS_CHECK_RETURN_CRITICAL
441static int tls_prf_sha384(const unsigned char *secret, size_t slen,
442 const char *label,
443 const unsigned char *random, size_t rlen,
444 unsigned char *dstbuf, size_t dlen);
445
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100446static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
447static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100448#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100449
Gilles Peskine449bd832023-01-11 14:50:10 +0100450MBEDTLS_CHECK_RETURN_CRITICAL
451static int ssl_tls12_session_load(mbedtls_ssl_session *session,
452 const unsigned char *buf,
453 size_t len);
454#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
455
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100456static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100457
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100458#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100459static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100460#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100461
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100462#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100463static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100464#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100465
466int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
467 const unsigned char *secret, size_t slen,
468 const char *label,
469 const unsigned char *random, size_t rlen,
470 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300471{
472 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
473
Gilles Peskine449bd832023-01-11 14:50:10 +0100474 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300475#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100476#if defined(PSA_WANT_ALG_SHA_384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477 case MBEDTLS_SSL_TLS_PRF_SHA384:
478 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 break;
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100480#endif /* PSA_WANT_ALG_SHA_384*/
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100481#if defined(PSA_WANT_ALG_SHA_256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300482 case MBEDTLS_SSL_TLS_PRF_SHA256:
483 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100484 break;
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100485#endif /* PSA_WANT_ALG_SHA_256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300486#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 default:
488 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300489 }
490
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300492}
493
Jerry Yuc73c6182022-02-08 20:29:25 +0800494#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100495static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800496{
497#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100498 if (session->peer_cert != NULL) {
499 mbedtls_x509_crt_free(session->peer_cert);
500 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800501 session->peer_cert = NULL;
502 }
503#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100504 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800505 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100506 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800507 session->peer_cert_digest = NULL;
508 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
509 session->peer_cert_digest_len = 0;
510 }
511#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
512}
513#endif /* MBEDTLS_X509_CRT_PARSE_C */
514
Gilles Peskine449bd832023-01-11 14:50:10 +0100515uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800516{
Gilles Peskine449bd832023-01-11 14:50:10 +0100517 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800518 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800520
521 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800523
524 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800526
527 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
581 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800583
584 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800586
587 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800589
590 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100591 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800592
593 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800595
Jan Bruckner151f6422023-02-10 12:45:19 +0100596 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
597 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
598
Jerry Yu7a485c12022-10-31 13:08:18 +0800599 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100600 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800601
602 }
603
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800605}
606
Gilles Peskine449bd832023-01-11 14:50:10 +0100607uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800608{
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800610}
611
Jerry Yud25cab02022-10-31 12:48:30 +0800612#if defined(MBEDTLS_DEBUG_C)
613static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800614 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800615 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
616 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
617 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
618 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
619 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
620 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
621 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
622 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
623 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
624 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
625 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
626 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
627 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
628 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
629 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
630 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
631 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
632 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
633 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
634 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
635 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
636 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
637 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
638 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
639 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
640 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100641 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
642 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800643};
644
Chien Wong4e9683e2023-12-28 17:07:43 +0800645static const unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800646 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
647 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
648 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
649 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
650 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
651 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
652 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
653 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
654 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
655 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
656 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
657 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
658 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
659 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
660 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
661 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
662 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
663 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
664 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
665 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
666 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
667 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
668 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
669 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
670 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
671 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
672 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100673 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
674 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800675};
676
Gilles Peskine449bd832023-01-11 14:50:10 +0100677const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800678{
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 return extension_name_table[
680 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800681}
682
Gilles Peskine449bd832023-01-11 14:50:10 +0100683static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800684{
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800686 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800688 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800690 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100691 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800692 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100693 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800694 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800696 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100697 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800698 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800700 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800702}
703
Gilles Peskine449bd832023-01-11 14:50:10 +0100704void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
705 int level, const char *file, int line,
706 int hs_msg_type, unsigned int extension_type,
707 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800708{
709 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800711 mbedtls_debug_print_msg(
712 ssl, level, file, line,
713 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100714 ssl_tls13_get_hs_msg_name(hs_msg_type),
715 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800716 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800718 return;
719 }
720
721 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100722 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800723 mbedtls_debug_print_msg(
724 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100725 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
726 mbedtls_ssl_get_extension_name(extension_type), extension_type,
727 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800728 return;
729 }
730
731 mbedtls_debug_print_msg(
732 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
734 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800735}
736
Gilles Peskine449bd832023-01-11 14:50:10 +0100737void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
738 int level, const char *file, int line,
739 int hs_msg_type, uint32_t extensions_mask,
740 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800741{
742
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 for (unsigned i = 0;
744 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
745 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800746 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800747 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100748 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800749 }
750}
751
Pengyu Lvee455c02023-01-12 14:37:24 +0800752#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800753static const char *ticket_flag_name_table[] =
754{
755 [0] = "ALLOW_PSK_RESUMPTION",
756 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
757 [3] = "ALLOW_EARLY_DATA",
758};
759
Pengyu Lv4938a562023-01-16 11:28:49 +0800760void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
761 int level, const char *file, int line,
762 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800763{
764 size_t i;
765
766 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800767 "print ticket_flags (0x%02x)", flags);
768
769 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800770
771 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800772 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800773 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
774 ticket_flag_name_table[i]);
775 }
776 }
777}
778#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
779
Jerry Yud25cab02022-10-31 12:48:30 +0800780#endif /* MBEDTLS_DEBUG_C */
781
Gilles Peskine449bd832023-01-11 14:50:10 +0100782void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
783 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800784{
785 ((void) ciphersuite_info);
786
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100787#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100788 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800789 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800791#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100792#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800794 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800796#endif
797 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800799 return;
800 }
801}
802
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100803int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100804 unsigned hs_type,
805 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100806{
807 unsigned char hs_hdr[4];
808
809 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
811 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
812 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
813 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100814
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100815 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100816}
817
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100818int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100819 unsigned hs_type,
820 unsigned char const *msg,
821 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100822{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100823 int ret;
824 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100825 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100826 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100827 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100828 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100829}
830
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100831int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800832{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100833#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100834 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100835 psa_status_t status;
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100836#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800837 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100838#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100839#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100840 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
841 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200842 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100843 }
844 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
845 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200846 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100847 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800848#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100849#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100850 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
851 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200852 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100853 }
854 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
855 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200856 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100857 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800858#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100859 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800860}
861
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100862static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100863 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800864{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100865#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100866 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100867 psa_status_t status;
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100868#else /* SHA-256 or SHA-384 */
869 ((void) ssl);
870 (void) buf;
871 (void) len;
872#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100873#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100874 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
875 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200876 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100877 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800878#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100879#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100880 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
881 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200882 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100883 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800884#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100885 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800886}
887
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100888#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100889static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100890 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800891{
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200892 return mbedtls_md_error_from_psa(psa_hash_update(
893 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800894}
895#endif
896
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100897#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100898static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100899 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800900{
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200901 return mbedtls_md_error_from_psa(psa_hash_update(
902 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800903}
904#endif
905
Gilles Peskine449bd832023-01-11 14:50:10 +0100906static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200907{
Gilles Peskine449bd832023-01-11 14:50:10 +0100908 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200909
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100910#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500911 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500912#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100913#if defined(PSA_WANT_ALG_SHA_384)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500914 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500915#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200916
917 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100918
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200919#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200920 handshake->psa_pake_ctx = psa_pake_operation_init();
921 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200922#if defined(MBEDTLS_SSL_CLI_C)
923 handshake->ecjpake_cache = NULL;
924 handshake->ecjpake_cache_len = 0;
925#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200926#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200927
Gilles Peskineeccd8882020-03-10 12:19:08 +0100928#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100929 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200930#endif
931
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200932#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
933 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
934#endif
Hanno Becker75173122019-02-06 16:18:31 +0000935
936#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
937 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100938 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +0000939#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200940}
941
Gilles Peskine449bd832023-01-11 14:50:10 +0100942void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200943{
Gilles Peskine449bd832023-01-11 14:50:10 +0100944 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +0200945
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100946 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
947 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100948
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000949#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100950 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
951 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100952#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200953}
954
Gilles Peskine449bd832023-01-11 14:50:10 +0100955void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200956{
Gilles Peskine449bd832023-01-11 14:50:10 +0100957 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200958}
959
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200960MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100961static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +0000962{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100963 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
964
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200965 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +0800966#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +0100967 if (ssl->transform_negotiate) {
968 mbedtls_ssl_transform_free(ssl->transform_negotiate);
969 }
Jerry Yu2e199812022-12-01 18:57:19 +0800970#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100971 if (ssl->session_negotiate) {
972 mbedtls_ssl_session_free(ssl->session_negotiate);
973 }
974 if (ssl->handshake) {
975 mbedtls_ssl_handshake_free(ssl);
976 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200977
Jerry Yu2e199812022-12-01 18:57:19 +0800978#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200979 /*
980 * Either the pointers are now NULL or cleared properly and can be freed.
981 * Now allocate missing structures.
982 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 if (ssl->transform_negotiate == NULL) {
984 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200985 }
Jerry Yu2e199812022-12-01 18:57:19 +0800986#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000987
Gilles Peskine449bd832023-01-11 14:50:10 +0100988 if (ssl->session_negotiate == NULL) {
989 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200990 }
Paul Bakker48916f92012-09-16 19:57:18 +0000991
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 if (ssl->handshake == NULL) {
993 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200994 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500995#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
996 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400997
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
999 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001000#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001001
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001002 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001003 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001004#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001005 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001006#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 ssl->session_negotiate == NULL) {
1008 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001009
Gilles Peskine449bd832023-01-11 14:50:10 +01001010 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001011 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001012
1013#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001014 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001015 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001016#endif
1017
Gilles Peskine449bd832023-01-11 14:50:10 +01001018 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001019 ssl->session_negotiate = NULL;
1020
Gilles Peskine449bd832023-01-11 14:50:10 +01001021 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001022 }
1023
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001024#if defined(MBEDTLS_SSL_EARLY_DATA)
1025#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001026 ssl->early_data_state = MBEDTLS_SSL_EARLY_DATA_STATE_IDLE;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001027#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001028#if defined(MBEDTLS_SSL_SRV_C)
1029 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1030#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001031 ssl->total_early_data_size = 0;
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001032#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001033
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001034 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001035 mbedtls_ssl_session_init(ssl->session_negotiate);
1036 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001037
Jerry Yu2e199812022-12-01 18:57:19 +08001038#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001039 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001040#endif
1041
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001042 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001043 ret = mbedtls_ssl_reset_checksum(ssl);
1044 if (ret != 0) {
1045 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1046 return ret;
1047 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001048
Jerry Yud0766ec2022-09-22 10:46:57 +08001049#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1050 defined(MBEDTLS_SSL_SRV_C) && \
1051 defined(MBEDTLS_SSL_SESSION_TICKETS)
1052 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001053 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001054#endif
1055
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001056#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001057 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001058 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001059
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001061 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001062 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001063 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001065
Gilles Peskine449bd832023-01-11 14:50:10 +01001066 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001067 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001068#endif
1069
Ronald Crone68ab4f2022-10-05 12:46:29 +02001070#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001071#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001072#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001073 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1074 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1076 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001077 const int *md;
1078 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001079 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001080 uint16_t *p;
1081
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001082 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1083 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1084 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1087 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001088 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001089 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001090#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001092#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001093
Jerry Yub476a442022-01-21 18:14:45 +08001094#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001096#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1098 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1099 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001100 }
1101
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1103 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1104 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001105
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1107 sizeof(uint16_t));
1108 if (ssl->handshake->sig_algs == NULL) {
1109 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1110 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001111
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 p = (uint16_t *) ssl->handshake->sig_algs;
1113 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1114 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1115 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001116 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001118#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001120 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001121#endif
1122#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001124 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001125#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001126 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001127 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001128 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001130#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001131 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001132 ssl->handshake->sig_algs_heap_allocated = 0;
1133 }
Jerry Yucc539102022-06-27 16:27:35 +08001134#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001135#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001137}
1138
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001139#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001140/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001141MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001142static int ssl_cookie_write_dummy(void *ctx,
1143 unsigned char **p, unsigned char *end,
1144 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001145{
1146 ((void) ctx);
1147 ((void) p);
1148 ((void) end);
1149 ((void) cli_id);
1150 ((void) cli_id_len);
1151
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001153}
1154
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001155MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001156static int ssl_cookie_check_dummy(void *ctx,
1157 const unsigned char *cookie, size_t cookie_len,
1158 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001159{
1160 ((void) ctx);
1161 ((void) cookie);
1162 ((void) cookie_len);
1163 ((void) cli_id);
1164 ((void) cli_id_len);
1165
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001167}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001168#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001169
Paul Bakker5121ce52009-01-03 21:22:43 +00001170/*
1171 * Initialize an SSL context
1172 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001173void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001174{
Gilles Peskine449bd832023-01-11 14:50:10 +01001175 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001176}
1177
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001178MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001179static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001180{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001181 const mbedtls_ssl_config *conf = ssl->conf;
1182
Ronald Cron6f135e12021-12-08 16:57:54 +01001183#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001184 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1185 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1186 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1187 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001188 }
1189
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1191 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001192 }
1193#endif
1194
1195#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001196 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1197 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1198 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001199 }
1200#endif
1201
Ronald Cron6f135e12021-12-08 16:57:54 +01001202#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001203 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1204 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1205 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1206 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001207 }
1208
Gilles Peskine449bd832023-01-11 14:50:10 +01001209 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1210 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001211 }
1212#endif
1213
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1215 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001216}
1217
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001218MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001219static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1220{
1221 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001222 ret = ssl_conf_version_check(ssl);
1223 if (ret != 0) {
1224 return ret;
1225 }
Jerry Yu60835a82021-08-04 10:13:52 +08001226
1227 /* Space for further checks */
1228
Gilles Peskine449bd832023-01-11 14:50:10 +01001229 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001230}
1231
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001232/*
1233 * Setup an SSL context
1234 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001235
Gilles Peskine449bd832023-01-11 14:50:10 +01001236int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1237 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001238{
Janos Follath865b3eb2019-12-16 11:46:15 +00001239 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001240 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1241 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001242
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001243 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001244
Gilles Peskine449bd832023-01-11 14:50:10 +01001245 if ((ret = ssl_conf_check(ssl)) != 0) {
1246 return ret;
1247 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001248 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001249
Paul Bakker62f2dee2012-09-28 07:31:51 +00001250 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001251 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001252 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001253
1254 /* Set to NULL in case of an error condition */
1255 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001256
Darryl Greenb33cc762019-11-28 14:29:44 +00001257#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1258 ssl->in_buf_len = in_buf_len;
1259#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1261 if (ssl->in_buf == NULL) {
1262 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001263 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001264 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001265 }
1266
Darryl Greenb33cc762019-11-28 14:29:44 +00001267#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1268 ssl->out_buf_len = out_buf_len;
1269#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001270 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1271 if (ssl->out_buf == NULL) {
1272 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001273 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001274 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001275 }
1276
Deomid rojer Ryabkov3dfe75e2025-01-26 10:43:42 +02001277 mbedtls_ssl_reset_in_pointers(ssl);
1278 mbedtls_ssl_reset_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001279
Johan Pascalb62bb512015-12-03 21:56:45 +01001280#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001281 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001282#endif
1283
Gilles Peskine449bd832023-01-11 14:50:10 +01001284 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001285 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001287
Gilles Peskine449bd832023-01-11 14:50:10 +01001288 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001289
1290error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001291 mbedtls_free(ssl->in_buf);
1292 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001293
1294 ssl->conf = NULL;
1295
Darryl Greenb33cc762019-11-28 14:29:44 +00001296#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1297 ssl->in_buf_len = 0;
1298 ssl->out_buf_len = 0;
1299#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001300 ssl->in_buf = NULL;
1301 ssl->out_buf = NULL;
1302
1303 ssl->in_hdr = NULL;
1304 ssl->in_ctr = NULL;
1305 ssl->in_len = NULL;
1306 ssl->in_iv = NULL;
1307 ssl->in_msg = NULL;
1308
1309 ssl->out_hdr = NULL;
1310 ssl->out_ctr = NULL;
1311 ssl->out_len = NULL;
1312 ssl->out_iv = NULL;
1313 ssl->out_msg = NULL;
1314
Gilles Peskine449bd832023-01-11 14:50:10 +01001315 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001316}
1317
1318/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001319 * Reset an initialized and used SSL context for re-use while retaining
1320 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001321 *
1322 * If partial is non-zero, keep data in the input buffer and client ID.
1323 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001324 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001325void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1326 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001327{
Darryl Greenb33cc762019-11-28 14:29:44 +00001328#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1329 size_t in_buf_len = ssl->in_buf_len;
1330 size_t out_buf_len = ssl->out_buf_len;
1331#else
1332 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1333 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1334#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001335
Hanno Beckerb0302c42021-08-03 09:39:42 +01001336#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1337 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001338#endif
1339
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001340 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001341 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001342
Deomid rojer Ryabkov3dfe75e2025-01-26 10:43:42 +02001343 mbedtls_ssl_reset_in_pointers(ssl);
1344 mbedtls_ssl_reset_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001345
1346 /* Reset incoming message parsing */
1347 ssl->in_offt = NULL;
1348 ssl->nb_zero = 0;
1349 ssl->in_msgtype = 0;
1350 ssl->in_msglen = 0;
1351 ssl->in_hslen = 0;
Deomid rojer Ryabkovdd14c0a2025-02-13 13:41:51 +03001352 ssl->in_hsfraglen = 0;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001353 ssl->keep_current_message = 0;
1354 ssl->transform_in = NULL;
1355
1356#if defined(MBEDTLS_SSL_PROTO_DTLS)
1357 ssl->next_record_offset = 0;
1358 ssl->in_epoch = 0;
1359#endif
1360
1361 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001362 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001363 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001365 }
1366
Ronald Cronad8c17b2022-06-10 17:18:09 +02001367 ssl->send_alert = 0;
1368
Hanno Beckerb0302c42021-08-03 09:39:42 +01001369 /* Reset outgoing message writing */
1370 ssl->out_msgtype = 0;
1371 ssl->out_msglen = 0;
1372 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001373 memset(ssl->out_buf, 0, out_buf_len);
1374 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001375 ssl->transform_out = NULL;
1376
1377#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001378 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001379#endif
1380
XiaokangQian2b01dc32022-01-21 02:53:13 +00001381#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001382 if (ssl->transform) {
1383 mbedtls_ssl_transform_free(ssl->transform);
1384 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001385 ssl->transform = NULL;
1386 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001387#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1388
XiaokangQian2b01dc32022-01-21 02:53:13 +00001389#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001390 mbedtls_ssl_transform_free(ssl->transform_application);
1391 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001392 ssl->transform_application = NULL;
1393
Gilles Peskine449bd832023-01-11 14:50:10 +01001394 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001395#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001396 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1397 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001398 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001399#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001400
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1402 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001403 ssl->handshake->transform_handshake = NULL;
1404 }
1405
XiaokangQian2b01dc32022-01-21 02:53:13 +00001406#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001407}
1408
Gilles Peskine449bd832023-01-11 14:50:10 +01001409int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001410{
1411 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1412
Gilles Peskinef670ba52025-03-07 15:09:32 +01001413 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_REQUEST);
Gilles Peskinefd89acc2025-02-24 18:45:49 +01001414 ssl->flags &= MBEDTLS_SSL_CONTEXT_FLAGS_KEEP_AT_SESSION;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001415 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001416
Gilles Peskine449bd832023-01-11 14:50:10 +01001417 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001418
1419 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001420#if defined(MBEDTLS_SSL_RENEGOTIATION)
1421 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001422 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001423
1424 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1426 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001427#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001428 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001429
Hanno Beckerb0302c42021-08-03 09:39:42 +01001430 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001431 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 if (ssl->session) {
1433 mbedtls_ssl_session_free(ssl->session);
1434 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001435 ssl->session = NULL;
1436 }
1437
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001438#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001439 ssl->alpn_chosen = NULL;
1440#endif
1441
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001442#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001443 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001444#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001446#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001447 if (free_cli_id) {
1448 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001449 ssl->cli_id = NULL;
1450 ssl->cli_id_len = 0;
1451 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001452#endif
1453
Gilles Peskine449bd832023-01-11 14:50:10 +01001454 if ((ret = ssl_handshake_init(ssl)) != 0) {
1455 return ret;
1456 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001457
Gilles Peskine449bd832023-01-11 14:50:10 +01001458 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001459}
1460
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001461/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001462 * Reset an initialized and used SSL context for re-use while retaining
1463 * all application-set variables, function pointers and data.
1464 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001465int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001466{
Gilles Peskine449bd832023-01-11 14:50:10 +01001467 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001468}
1469
1470/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001471 * SSL set accessors
1472 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001473void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001474{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001475 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001476}
1477
Gilles Peskine449bd832023-01-11 14:50:10 +01001478void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001479{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001480 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001481}
1482
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001483#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001484void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001485{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001486 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001487}
1488#endif
1489
Gilles Peskine449bd832023-01-11 14:50:10 +01001490void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001491{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001492 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001493}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001494
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001495#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001496
Gilles Peskine449bd832023-01-11 14:50:10 +01001497void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1498 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001499{
1500 ssl->disable_datagram_packing = !allow_packing;
1501}
1502
Gilles Peskine449bd832023-01-11 14:50:10 +01001503void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1504 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001505{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001506 conf->hs_timeout_min = min;
1507 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001508}
1509#endif
1510
Gilles Peskine449bd832023-01-11 14:50:10 +01001511void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001512{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001513 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001514}
1515
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001516#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001517void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1518 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1519 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001520{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001521 conf->f_vrfy = f_vrfy;
1522 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001523}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001524#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001525
Gilles Peskine449bd832023-01-11 14:50:10 +01001526void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1527 void (*f_dbg)(void *, int, const char *, int, const char *),
1528 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001529{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001530 conf->f_dbg = f_dbg;
1531 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001532}
1533
Gilles Peskine449bd832023-01-11 14:50:10 +01001534void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1535 void *p_bio,
1536 mbedtls_ssl_send_t *f_send,
1537 mbedtls_ssl_recv_t *f_recv,
1538 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001539{
1540 ssl->p_bio = p_bio;
1541 ssl->f_send = f_send;
1542 ssl->f_recv = f_recv;
1543 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001544}
1545
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001546#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001547void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001548{
1549 ssl->mtu = mtu;
1550}
1551#endif
1552
Gilles Peskine449bd832023-01-11 14:50:10 +01001553void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001554{
1555 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001556}
1557
Gilles Peskine449bd832023-01-11 14:50:10 +01001558void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1559 void *p_timer,
1560 mbedtls_ssl_set_timer_t *f_set_timer,
1561 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001562{
1563 ssl->p_timer = p_timer;
1564 ssl->f_set_timer = f_set_timer;
1565 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001566
1567 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001568 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001569}
1570
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001571#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001572void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1573 void *p_cache,
1574 mbedtls_ssl_cache_get_t *f_get_cache,
1575 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001576{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001577 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001578 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001579 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001580}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001581#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001582
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001583#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001584int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001585{
Janos Follath865b3eb2019-12-16 11:46:15 +00001586 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001587
Gilles Peskine449bd832023-01-11 14:50:10 +01001588 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001589 session == NULL ||
1590 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001591 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1592 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001593 }
1594
Gilles Peskine449bd832023-01-11 14:50:10 +01001595 if (ssl->handshake->resume == 1) {
1596 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1597 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001598
Jerry Yu21092062022-10-10 21:21:31 +08001599#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001600 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron233fcaa2024-04-04 14:05:21 +02001601#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001602 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001603 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001604
Gilles Peskine449bd832023-01-11 14:50:10 +01001605 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001606 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001607 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1608 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1609 session->ciphersuite));
1610 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001611 }
Ronald Cron233fcaa2024-04-04 14:05:21 +02001612#else
1613 /*
1614 * If session tickets are not enabled, it is not possible to resume a
1615 * TLS 1.3 session, thus do not make any change to the SSL context in
1616 * the first place.
1617 */
1618 return 0;
1619#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001620 }
Jerry Yu21092062022-10-10 21:21:31 +08001621#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001622
Gilles Peskine449bd832023-01-11 14:50:10 +01001623 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1624 session)) != 0) {
1625 return ret;
1626 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001627
Paul Bakker0a597072012-09-25 21:55:46 +00001628 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001629
Gilles Peskine449bd832023-01-11 14:50:10 +01001630 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001631}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001632#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001633
Gilles Peskine449bd832023-01-11 14:50:10 +01001634void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1635 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001636{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001637 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001638}
1639
Ronald Cron6f135e12021-12-08 16:57:54 +01001640#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001641void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1642 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001643{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001644 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001645}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001646
1647#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001648void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1649 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001650{
1651 conf->early_data_enabled = early_data_enabled;
1652}
Jerry Yucc4e0072022-11-22 17:22:22 +08001653
1654#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001655void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001656 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001657{
Jerry Yu39da9852022-12-06 16:58:36 +08001658 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001659}
1660#endif /* MBEDTLS_SSL_SRV_C */
1661
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001662#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001663#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001664
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001665#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001666void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1667 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001668{
1669 conf->cert_profile = profile;
1670}
1671
Gilles Peskine449bd832023-01-11 14:50:10 +01001672static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001673{
1674 mbedtls_ssl_key_cert *cur = key_cert, *next;
1675
Gilles Peskine449bd832023-01-11 14:50:10 +01001676 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001677 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001678 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001679 cur = next;
1680 }
1681}
1682
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001683/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001684MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001685static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1686 mbedtls_x509_crt *cert,
1687 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001688{
niisato8ee24222018-06-25 19:05:48 +09001689 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001690
Gilles Peskine449bd832023-01-11 14:50:10 +01001691 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001692 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001693 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001694 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001695 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001696 }
1697
Gilles Peskine449bd832023-01-11 14:50:10 +01001698 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1699 if (new_cert == NULL) {
1700 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1701 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001702
niisato8ee24222018-06-25 19:05:48 +09001703 new_cert->cert = cert;
1704 new_cert->key = key;
1705 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001706
Glenn Strauss36872db2022-01-22 05:06:31 -05001707 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001708 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001709 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001710 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001711 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001713 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001714 }
niisato8ee24222018-06-25 19:05:48 +09001715 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001716 }
1717
Gilles Peskine449bd832023-01-11 14:50:10 +01001718 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001719}
1720
Gilles Peskine449bd832023-01-11 14:50:10 +01001721int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001722 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001723 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001724{
Gilles Peskine449bd832023-01-11 14:50:10 +01001725 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001726}
1727
Gilles Peskine449bd832023-01-11 14:50:10 +01001728void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001729 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001731{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001732 conf->ca_chain = ca_chain;
1733 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001734
1735#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1736 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1737 * cannot be used together. */
1738 conf->f_ca_cb = NULL;
1739 conf->p_ca_cb = NULL;
1740#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001741}
Hanno Becker5adaad92019-03-27 16:54:37 +00001742
1743#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001744void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1745 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1746 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001747{
1748 conf->f_ca_cb = f_ca_cb;
1749 conf->p_ca_cb = p_ca_cb;
1750
1751 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1752 * cannot be used together. */
1753 conf->ca_chain = NULL;
1754 conf->ca_crl = NULL;
1755}
1756#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001757#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001758
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001759#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001760const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1761 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001762{
1763 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001765}
1766
Gilles Peskine449bd832023-01-11 14:50:10 +01001767int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1768 mbedtls_x509_crt *own_cert,
1769 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001770{
Gilles Peskine449bd832023-01-11 14:50:10 +01001771 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1772 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001773}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001774
Gilles Peskine449bd832023-01-11 14:50:10 +01001775void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1776 mbedtls_x509_crt *ca_chain,
1777 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001778{
1779 ssl->handshake->sni_ca_chain = ca_chain;
1780 ssl->handshake->sni_ca_crl = ca_crl;
1781}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001782
Glenn Strauss999ef702022-03-11 01:37:23 -05001783#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001784void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1785 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001786{
1787 ssl->handshake->dn_hints = crt;
1788}
1789#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1790
Gilles Peskine449bd832023-01-11 14:50:10 +01001791void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1792 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001793{
1794 ssl->handshake->sni_authmode = authmode;
1795}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001796#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1797
Hanno Becker8927c832019-04-03 12:52:50 +01001798#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001799void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1800 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1801 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001802{
1803 ssl->f_vrfy = f_vrfy;
1804 ssl->p_vrfy = p_vrfy;
1805}
1806#endif
1807
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001808#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001809
Przemek Stekielfde11282023-03-13 16:06:09 +01001810static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1811static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1812
Valerio Setti016f6822022-12-09 14:17:50 +01001813static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001814 mbedtls_ssl_context *ssl,
1815 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001816{
1817 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001818 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001819 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001820 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001821 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001822 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001823 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1824 psa_pake_cs_set_primitive(&cipher_suite,
1825 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1826 PSA_ECC_FAMILY_SECP_R1,
1827 256));
1828 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001829
Anton Matkin72d60302025-03-19 14:56:57 +01001830 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, pwd, &cipher_suite);
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001832 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001833 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001834
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001836 user = jpake_server_id;
1837 user_len = sizeof(jpake_server_id);
1838 peer = jpake_client_id;
1839 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001840 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001841 user = jpake_client_id;
1842 user_len = sizeof(jpake_client_id);
1843 peer = jpake_server_id;
1844 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001846
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001847 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1848 if (status != PSA_SUCCESS) {
1849 return status;
1850 }
1851
1852 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001854 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 }
Valerio Setti016f6822022-12-09 14:17:50 +01001856
Valerio Setti016f6822022-12-09 14:17:50 +01001857 ssl->handshake->psa_pake_ctx_is_ok = 1;
1858
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001860}
1861
Gilles Peskine449bd832023-01-11 14:50:10 +01001862int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1863 const unsigned char *pw,
1864 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001865{
1866 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1867 psa_status_t status;
1868
Gilles Peskine449bd832023-01-11 14:50:10 +01001869 if (ssl->handshake == NULL || ssl->conf == NULL) {
1870 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001871 }
1872
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 /* Empty password is not valid */
1874 if ((pw == NULL) || (pw_len == 0)) {
1875 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1876 }
1877
1878 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
1879 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
1880 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
1881
1882 status = psa_import_key(&attributes, pw, pw_len,
1883 &ssl->handshake->psa_pake_password);
1884 if (status != PSA_SUCCESS) {
1885 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1886 }
1887
1888 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
1889 ssl->handshake->psa_pake_password);
1890 if (status != PSA_SUCCESS) {
1891 psa_destroy_key(ssl->handshake->psa_pake_password);
1892 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1893 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1894 }
1895
1896 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001897}
Valerio Settia9a97dc2022-11-28 18:26:16 +01001898
Gilles Peskine449bd832023-01-11 14:50:10 +01001899int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
1900 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01001901{
Valerio Settia9a97dc2022-11-28 18:26:16 +01001902 psa_status_t status;
1903
Gilles Peskine449bd832023-01-11 14:50:10 +01001904 if (ssl->handshake == NULL || ssl->conf == NULL) {
1905 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001906 }
1907
Gilles Peskine449bd832023-01-11 14:50:10 +01001908 if (mbedtls_svc_key_id_is_null(pwd)) {
1909 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1910 }
1911
1912 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
1913 if (status != PSA_SUCCESS) {
1914 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1915 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1916 }
1917
1918 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001919}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001920#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001921
Ronald Cron73fe8df2022-10-05 14:31:43 +02001922#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001923int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001924{
Gilles Peskine449bd832023-01-11 14:50:10 +01001925 if (conf->psk_identity == NULL ||
1926 conf->psk_identity_len == 0) {
1927 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02001928 }
1929
Gilles Peskine449bd832023-01-11 14:50:10 +01001930 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
1931 return 1;
1932 }
Ronald Crond29e13e2022-10-19 10:33:48 +02001933
Gilles Peskine449bd832023-01-11 14:50:10 +01001934 if (conf->psk != NULL && conf->psk_len != 0) {
1935 return 1;
1936 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001937
Gilles Peskine449bd832023-01-11 14:50:10 +01001938 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001939}
1940
Gilles Peskine449bd832023-01-11 14:50:10 +01001941static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001942{
1943 /* Remove reference to existing PSK, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001944 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001945 /* The maintenance of the PSK key slot is the
1946 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001947 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001948 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01001950 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001951 conf->psk = NULL;
1952 conf->psk_len = 0;
1953 }
1954
1955 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001956 if (conf->psk_identity != NULL) {
1957 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001958 conf->psk_identity = NULL;
1959 conf->psk_identity_len = 0;
1960 }
1961}
1962
Hanno Becker7390c712018-11-15 13:33:04 +00001963/* This function assumes that PSK identity in the SSL config is unset.
1964 * It checks that the provided identity is well-formed and attempts
1965 * to make a copy of it in the SSL config.
1966 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001967MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001968static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
1969 unsigned char const *psk_identity,
1970 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001971{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001972 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01001973 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02001974 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001975 (psk_identity_len >> 16) != 0 ||
1976 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
1977 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001978 }
1979
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
1981 if (conf->psk_identity == NULL) {
1982 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1983 }
Paul Bakker6db455e2013-09-18 17:29:31 +02001984
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001985 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02001987
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02001989}
1990
Gilles Peskine449bd832023-01-11 14:50:10 +01001991int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
1992 const unsigned char *psk, size_t psk_len,
1993 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00001994{
Janos Follath865b3eb2019-12-16 11:46:15 +00001995 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001996
1997 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 if (mbedtls_ssl_conf_has_static_psk(conf)) {
1999 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2000 }
Hanno Becker7390c712018-11-15 13:33:04 +00002001
2002 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 if (psk == NULL) {
2004 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2005 }
2006 if (psk_len == 0) {
2007 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2008 }
2009 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2010 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2011 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002012
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2014 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2015 }
Hanno Becker7390c712018-11-15 13:33:04 +00002016 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002018
2019 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002020 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2021 if (ret != 0) {
2022 ssl_conf_remove_psk(conf);
2023 }
Hanno Becker7390c712018-11-15 13:33:04 +00002024
Gilles Peskine449bd832023-01-11 14:50:10 +01002025 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002026}
2027
Gilles Peskine449bd832023-01-11 14:50:10 +01002028static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002029{
Gilles Peskine449bd832023-01-11 14:50:10 +01002030 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002031 /* The maintenance of the external PSK key slot is the
2032 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002033 if (ssl->handshake->psk_opaque_is_internal) {
2034 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002035 ssl->handshake->psk_opaque_is_internal = 0;
2036 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002037 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002038 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002039}
2040
Gilles Peskine449bd832023-01-11 14:50:10 +01002041int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2042 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002043{
Neil Armstrong501c9322022-05-03 09:35:09 +02002044 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002045 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002046 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002047 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002048
Gilles Peskine449bd832023-01-11 14:50:10 +01002049 if (psk == NULL || ssl->handshake == NULL) {
2050 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2051 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002052
Gilles Peskine449bd832023-01-11 14:50:10 +01002053 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2054 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2055 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002056
Gilles Peskine449bd832023-01-11 14:50:10 +01002057 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002058
Jerry Yuccc68a42022-07-26 16:39:20 +08002059#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002060 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2061 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2062 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2063 } else {
2064 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2065 }
2066 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002067 }
2068#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002069
Jerry Yu568ec252022-07-22 21:27:34 +08002070#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002071 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2072 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2073 psa_set_key_usage_flags(&key_attributes,
2074 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002075 }
2076#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2077
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 psa_set_key_algorithm(&key_attributes, alg);
2079 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002080
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2082 if (status != PSA_SUCCESS) {
2083 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2084 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002085
2086 /* Allow calling psa_destroy_key() on psk remove */
2087 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002088 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002089}
2090
Gilles Peskine449bd832023-01-11 14:50:10 +01002091int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2092 mbedtls_svc_key_id_t psk,
2093 const unsigned char *psk_identity,
2094 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002095{
Janos Follath865b3eb2019-12-16 11:46:15 +00002096 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002097
2098 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2100 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2101 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002102
Hanno Becker7390c712018-11-15 13:33:04 +00002103 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 if (mbedtls_svc_key_id_is_null(psk)) {
2105 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2106 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002107 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002108
2109 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2111 psk_identity_len);
2112 if (ret != 0) {
2113 ssl_conf_remove_psk(conf);
2114 }
Hanno Becker7390c712018-11-15 13:33:04 +00002115
Gilles Peskine449bd832023-01-11 14:50:10 +01002116 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002117}
2118
Gilles Peskine449bd832023-01-11 14:50:10 +01002119int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2120 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002121{
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 if ((mbedtls_svc_key_id_is_null(psk)) ||
2123 (ssl->handshake == NULL)) {
2124 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2125 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002126
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002128 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002130}
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002131
Jerry Yu8897c072022-08-12 13:56:53 +08002132#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002133void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2134 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2135 size_t),
2136 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002137{
2138 conf->f_psk = f_psk;
2139 conf->p_psk = p_psk;
2140}
Jerry Yu8897c072022-08-12 13:56:53 +08002141#endif /* MBEDTLS_SSL_SRV_C */
2142
Ronald Cron73fe8df2022-10-05 14:31:43 +02002143#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002144
Gilles Peskine301711e2022-04-26 16:57:05 +02002145static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002146 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002147{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002148#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 if (alg == PSA_ALG_CBC_NO_PADDING) {
2150 return MBEDTLS_SSL_MODE_CBC;
2151 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002152#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 if (PSA_ALG_IS_AEAD(alg)) {
2154 return MBEDTLS_SSL_MODE_AEAD;
2155 }
2156 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002157}
2158
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002159
Gilles Peskinee108d982022-04-26 16:50:40 +02002160static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2161 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002163{
2164#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002165 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2166 base_mode == MBEDTLS_SSL_MODE_CBC) {
2167 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002168 }
2169#else
2170 (void) encrypt_then_mac;
2171#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002173}
2174
Neil Armstrongab555e02022-04-04 11:07:59 +02002175mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002177{
Gilles Peskinee108d982022-04-26 16:50:40 +02002178 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 transform->psa_alg
Gilles Peskinee108d982022-04-26 16:50:40 +02002180 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002181
Gilles Peskinee108d982022-04-26 16:50:40 +02002182 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002183#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002184 encrypt_then_mac = transform->encrypt_then_mac;
2185#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002186 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002187}
2188
Neil Armstrongab555e02022-04-04 11:07:59 +02002189mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002190#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002192#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002194{
Gilles Peskinee108d982022-04-26 16:50:40 +02002195 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2196
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002197 psa_status_t status;
2198 psa_algorithm_t alg;
2199 psa_key_type_t type;
2200 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002201 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2202 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 if (status == PSA_SUCCESS) {
2204 base_mode = mbedtls_ssl_get_base_mode(alg);
2205 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002206
Gilles Peskinee108d982022-04-26 16:50:40 +02002207#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2208 int encrypt_then_mac = 0;
2209#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002210 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002211}
2212
Jerry Yu251a12e2022-07-13 15:15:48 +08002213
Ronald Cron8b592d22024-11-12 18:08:25 +01002214const mbedtls_error_pair_t psa_to_ssl_errors[] =
2215{
2216 { PSA_SUCCESS, 0 },
2217 { PSA_ERROR_INSUFFICIENT_MEMORY, MBEDTLS_ERR_SSL_ALLOC_FAILED },
2218 { PSA_ERROR_NOT_SUPPORTED, MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE },
2219 { PSA_ERROR_INVALID_SIGNATURE, MBEDTLS_ERR_SSL_INVALID_MAC },
2220 { PSA_ERROR_INVALID_ARGUMENT, MBEDTLS_ERR_SSL_BAD_INPUT_DATA },
2221 { PSA_ERROR_BAD_STATE, MBEDTLS_ERR_SSL_INTERNAL_ERROR },
2222 { PSA_ERROR_BUFFER_TOO_SMALL, MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL }
2223};
2224
Gilles Peskine449bd832023-01-11 14:50:10 +01002225psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2226 size_t taglen,
2227 psa_algorithm_t *alg,
2228 psa_key_type_t *key_type,
2229 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002230{
Elena Uziunaitec2561722024-07-05 11:37:33 +01002231#if !defined(PSA_WANT_ALG_CCM)
Yanray Wang19e4dc82023-11-16 18:02:05 +08002232 (void) taglen;
2233#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 switch (mbedtls_cipher_type) {
Elena Uziunaite74342c72024-07-05 11:31:29 +01002235#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002236 case MBEDTLS_CIPHER_AES_128_CBC:
2237 *alg = PSA_ALG_CBC_NO_PADDING;
2238 *key_type = PSA_KEY_TYPE_AES;
2239 *key_size = 128;
2240 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002241#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002242#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002243 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002244 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002245 *key_type = PSA_KEY_TYPE_AES;
2246 *key_size = 128;
2247 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002248#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002249#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002250 case MBEDTLS_CIPHER_AES_128_GCM:
2251 *alg = PSA_ALG_GCM;
2252 *key_type = PSA_KEY_TYPE_AES;
2253 *key_size = 128;
2254 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002255#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002256#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002257 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002259 *key_type = PSA_KEY_TYPE_AES;
2260 *key_size = 192;
2261 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002262#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002263#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002264 case MBEDTLS_CIPHER_AES_192_GCM:
2265 *alg = PSA_ALG_GCM;
2266 *key_type = PSA_KEY_TYPE_AES;
2267 *key_size = 192;
2268 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002269#endif
Elena Uziunaite74342c72024-07-05 11:31:29 +01002270#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002271 case MBEDTLS_CIPHER_AES_256_CBC:
2272 *alg = PSA_ALG_CBC_NO_PADDING;
2273 *key_type = PSA_KEY_TYPE_AES;
2274 *key_size = 256;
2275 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002276#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002277#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002278 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002279 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002280 *key_type = PSA_KEY_TYPE_AES;
2281 *key_size = 256;
2282 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002283#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002284#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002285 case MBEDTLS_CIPHER_AES_256_GCM:
2286 *alg = PSA_ALG_GCM;
2287 *key_type = PSA_KEY_TYPE_AES;
2288 *key_size = 256;
2289 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002290#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002291#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002292 case MBEDTLS_CIPHER_ARIA_128_CBC:
2293 *alg = PSA_ALG_CBC_NO_PADDING;
2294 *key_type = PSA_KEY_TYPE_ARIA;
2295 *key_size = 128;
2296 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002297#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002298#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002299 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002301 *key_type = PSA_KEY_TYPE_ARIA;
2302 *key_size = 128;
2303 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002304#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002305#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002306 case MBEDTLS_CIPHER_ARIA_128_GCM:
2307 *alg = PSA_ALG_GCM;
2308 *key_type = PSA_KEY_TYPE_ARIA;
2309 *key_size = 128;
2310 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002311#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002312#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002313 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002315 *key_type = PSA_KEY_TYPE_ARIA;
2316 *key_size = 192;
2317 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002318#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002319#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002320 case MBEDTLS_CIPHER_ARIA_192_GCM:
2321 *alg = PSA_ALG_GCM;
2322 *key_type = PSA_KEY_TYPE_ARIA;
2323 *key_size = 192;
2324 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002325#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002326#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002327 case MBEDTLS_CIPHER_ARIA_256_CBC:
2328 *alg = PSA_ALG_CBC_NO_PADDING;
2329 *key_type = PSA_KEY_TYPE_ARIA;
2330 *key_size = 256;
2331 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002332#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002333#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002334 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002335 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002336 *key_type = PSA_KEY_TYPE_ARIA;
2337 *key_size = 256;
2338 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002339#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002340#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002341 case MBEDTLS_CIPHER_ARIA_256_GCM:
2342 *alg = PSA_ALG_GCM;
2343 *key_type = PSA_KEY_TYPE_ARIA;
2344 *key_size = 256;
2345 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002346#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002347#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002348 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2349 *alg = PSA_ALG_CBC_NO_PADDING;
2350 *key_type = PSA_KEY_TYPE_CAMELLIA;
2351 *key_size = 128;
2352 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002353#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002354#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002355 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002357 *key_type = PSA_KEY_TYPE_CAMELLIA;
2358 *key_size = 128;
2359 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002360#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002361#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002362 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2363 *alg = PSA_ALG_GCM;
2364 *key_type = PSA_KEY_TYPE_CAMELLIA;
2365 *key_size = 128;
2366 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002367#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002368#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002369 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002371 *key_type = PSA_KEY_TYPE_CAMELLIA;
2372 *key_size = 192;
2373 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002374#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002375#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002376 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2377 *alg = PSA_ALG_GCM;
2378 *key_type = PSA_KEY_TYPE_CAMELLIA;
2379 *key_size = 192;
2380 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002381#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002382#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002383 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2384 *alg = PSA_ALG_CBC_NO_PADDING;
2385 *key_type = PSA_KEY_TYPE_CAMELLIA;
2386 *key_size = 256;
2387 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002388#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002389#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002390 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002392 *key_type = PSA_KEY_TYPE_CAMELLIA;
2393 *key_size = 256;
2394 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002395#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002396#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002397 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2398 *alg = PSA_ALG_GCM;
2399 *key_type = PSA_KEY_TYPE_CAMELLIA;
2400 *key_size = 256;
2401 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002402#endif
Elena Uziunaite5c70c302024-07-05 11:44:44 +01002403#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002404 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2405 *alg = PSA_ALG_CHACHA20_POLY1305;
2406 *key_type = PSA_KEY_TYPE_CHACHA20;
2407 *key_size = 256;
2408 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002409#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002410 case MBEDTLS_CIPHER_NULL:
2411 *alg = MBEDTLS_SSL_NULL_CIPHER;
2412 *key_type = 0;
2413 *key_size = 0;
2414 break;
2415 default:
2416 return PSA_ERROR_NOT_SUPPORTED;
2417 }
2418
2419 return PSA_SUCCESS;
2420}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002421
Ronald Crone68ab4f2022-10-05 12:46:29 +02002422#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002423#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002424/*
2425 * Set allowed/preferred hashes for handshake signatures
2426 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002427void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2428 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002429{
2430 conf->sig_hashes = hashes;
2431}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002432#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002433
Jerry Yuf017ee42022-01-12 15:49:48 +08002434/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002435void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2436 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002437{
Jerry Yuf017ee42022-01-12 15:49:48 +08002438#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2439 conf->sig_hashes = NULL;
2440#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2441 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002442}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002443#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002444
Brett Warrene0edc842021-08-17 09:53:13 +01002445/*
2446 * Set the allowed groups
2447 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002448void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2449 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002450{
Brett Warrene0edc842021-08-17 09:53:13 +01002451 conf->group_list = group_list;
2452}
2453
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002454#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine4ac40082025-02-20 18:13:58 +01002455
2456#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2457/** Whether mbedtls_ssl_set_hostname() has been called.
2458 *
2459 * \param[in] ssl SSL context
2460 *
2461 * \return \c 1 if mbedtls_ssl_set_hostname() has been called on \p ssl
2462 * (including `mbedtls_ssl_set_hostname(ssl, NULL)`),
2463 * otherwise \c 0.
2464 */
2465static int mbedtls_ssl_has_set_hostname_been_called(
2466 const mbedtls_ssl_context *ssl)
2467{
Gilles Peskine434016e2025-02-20 18:49:59 +01002468 return (ssl->flags & MBEDTLS_SSL_CONTEXT_FLAG_HOSTNAME_SET) != 0;
Gilles Peskine4ac40082025-02-20 18:13:58 +01002469}
2470#endif
2471
2472static void mbedtls_ssl_free_hostname(mbedtls_ssl_context *ssl)
2473{
2474 if (ssl->hostname != NULL) {
2475 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
2476 }
2477 ssl->hostname = NULL;
2478}
2479
Gilles Peskine449bd832023-01-11 14:50:10 +01002480int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002481{
Hanno Becker947194e2017-04-07 13:25:49 +01002482 /* Initialize to suppress unnecessary compiler warning */
2483 size_t hostname_len = 0;
2484
2485 /* Check if new hostname is valid before
2486 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002487 if (hostname != NULL) {
2488 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002489
Gilles Peskine449bd832023-01-11 14:50:10 +01002490 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2491 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2492 }
Hanno Becker947194e2017-04-07 13:25:49 +01002493 }
2494
2495 /* Now it's clear that we will overwrite the old hostname,
2496 * so we can free it safely */
Gilles Peskine4ac40082025-02-20 18:13:58 +01002497 mbedtls_ssl_free_hostname(ssl);
Hanno Becker947194e2017-04-07 13:25:49 +01002498
2499 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002500
Gilles Peskine449bd832023-01-11 14:50:10 +01002501 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002502 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002503 } else {
2504 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2505 if (ssl->hostname == NULL) {
2506 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2507 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002508
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002510
Hanno Becker947194e2017-04-07 13:25:49 +01002511 ssl->hostname[hostname_len] = '\0';
2512 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002513
Gilles Peskine434016e2025-02-20 18:49:59 +01002514 ssl->flags |= MBEDTLS_SSL_CONTEXT_FLAG_HOSTNAME_SET;
2515
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002517}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002518#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002519
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002520#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002521void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2522 int (*f_sni)(void *, mbedtls_ssl_context *,
2523 const unsigned char *, size_t),
2524 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002525{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002526 conf->f_sni = f_sni;
2527 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002528}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002529#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002530
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002531#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskinec4949d12025-05-27 19:45:29 +02002532int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf,
2533 const char *const *protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002534{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002535 size_t cur_len, tot_len;
Gilles Peskinec4949d12025-05-27 19:45:29 +02002536 const char *const *p;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002537
2538 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002539 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2540 * MUST NOT be truncated."
2541 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002542 */
2543 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002544 for (p = protos; *p != NULL; p++) {
2545 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002546 tot_len += cur_len;
2547
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 if ((cur_len == 0) ||
2549 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2550 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2551 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2552 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002553 }
2554
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002555 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002556
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002558}
2559
Gilles Peskine449bd832023-01-11 14:50:10 +01002560const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002561{
Gilles Peskine449bd832023-01-11 14:50:10 +01002562 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002563}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002564#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002565
Johan Pascalb62bb512015-12-03 21:56:45 +01002566#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002567void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2568 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002569{
2570 conf->dtls_srtp_mki_support = support_mki_value;
2571}
2572
Gilles Peskine449bd832023-01-11 14:50:10 +01002573int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2574 unsigned char *mki_value,
2575 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002576{
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2578 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002579 }
Ron Eldor591f1622018-01-22 12:30:04 +02002580
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2582 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002583 }
Ron Eldor591f1622018-01-22 12:30:04 +02002584
Gilles Peskine449bd832023-01-11 14:50:10 +01002585 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002586 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002588}
2589
Gilles Peskine449bd832023-01-11 14:50:10 +01002590int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2591 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002592{
Johan Pascal253d0262020-09-22 13:04:45 +02002593 const mbedtls_ssl_srtp_profile *p;
2594 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002595
Johan Pascal253d0262020-09-22 13:04:45 +02002596 /* check the profiles list: all entry must be valid,
2597 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002598 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2599 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2600 p++) {
2601 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002602 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002603 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002604 /* unsupported value, stop parsing and set the size to an error value */
2605 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002606 }
2607 }
2608
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2610 conf->dtls_srtp_profile_list = NULL;
2611 conf->dtls_srtp_profile_list_len = 0;
2612 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002613 }
2614
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002615 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002616 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002617
Gilles Peskine449bd832023-01-11 14:50:10 +01002618 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002619}
2620
Gilles Peskine449bd832023-01-11 14:50:10 +01002621void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2622 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002623{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002624 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2625 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002626 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002627 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002628 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002629 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2631 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002632 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002633}
Johan Pascalb62bb512015-12-03 21:56:45 +01002634#endif /* MBEDTLS_SSL_DTLS_SRTP */
2635
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302636#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002637void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002638{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002639 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002640}
2641
Gilles Peskine449bd832023-01-11 14:50:10 +01002642void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002643{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002644 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002645}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302646#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002647
Janos Follath088ce432017-04-10 12:42:31 +01002648#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002649void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2650 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002651{
2652 conf->cert_req_ca_list = cert_req_ca_list;
2653}
2654#endif
2655
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002656#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002657void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002658{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002659 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002660}
2661#endif
2662
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002663#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002664void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002665{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002666 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002667}
2668#endif
2669
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002670#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002671int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002672{
Gilles Peskine449bd832023-01-11 14:50:10 +01002673 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2674 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2675 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002676 }
2677
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002678 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002679
Gilles Peskine449bd832023-01-11 14:50:10 +01002680 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002681}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002682#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002683
Gilles Peskine449bd832023-01-11 14:50:10 +01002684void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002685{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002686 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002687}
2688
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002689#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002690void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002691{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002692 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002693}
2694
Gilles Peskine449bd832023-01-11 14:50:10 +01002695void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002696{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002697 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002698}
2699
Gilles Peskine449bd832023-01-11 14:50:10 +01002700void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2701 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002702{
Gilles Peskine449bd832023-01-11 14:50:10 +01002703 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002704}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002705#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002706
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002707#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002708#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002709void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002710{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002711 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002712}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002713#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002714
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002715#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002716
Jerry Yud0766ec2022-09-22 10:46:57 +08002717#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002718void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2719 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002720{
Jerry Yud0766ec2022-09-22 10:46:57 +08002721 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002722}
2723#endif
2724
Gilles Peskine449bd832023-01-11 14:50:10 +01002725void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2726 mbedtls_ssl_ticket_write_t *f_ticket_write,
2727 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2728 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02002729{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002730 conf->f_ticket_write = f_ticket_write;
2731 conf->f_ticket_parse = f_ticket_parse;
2732 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002733}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002734#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002735#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002736
Gilles Peskine449bd832023-01-11 14:50:10 +01002737void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
2738 mbedtls_ssl_export_keys_t *f_export_keys,
2739 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002740{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002741 ssl->f_export_keys = f_export_keys;
2742 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002743}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002744
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002745#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002746void mbedtls_ssl_conf_async_private_cb(
2747 mbedtls_ssl_config *conf,
2748 mbedtls_ssl_async_sign_t *f_async_sign,
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002749 mbedtls_ssl_async_resume_t *f_async_resume,
2750 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01002751 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002752{
2753 conf->f_async_sign_start = f_async_sign;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002754 conf->f_async_resume = f_async_resume;
2755 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002756 conf->p_async_config_data = async_config_data;
2757}
2758
Gilles Peskine449bd832023-01-11 14:50:10 +01002759void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02002760{
Gilles Peskine449bd832023-01-11 14:50:10 +01002761 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02002762}
2763
Gilles Peskine449bd832023-01-11 14:50:10 +01002764void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002765{
Gilles Peskine449bd832023-01-11 14:50:10 +01002766 if (ssl->handshake == NULL) {
2767 return NULL;
2768 } else {
2769 return ssl->handshake->user_async_ctx;
2770 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002771}
2772
Gilles Peskine449bd832023-01-11 14:50:10 +01002773void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2774 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002775{
Gilles Peskine449bd832023-01-11 14:50:10 +01002776 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002777 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01002778 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002779}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002780#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002781
Paul Bakker5121ce52009-01-03 21:22:43 +00002782/*
2783 * SSL get accessors
2784 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002785uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002786{
Gilles Peskine449bd832023-01-11 14:50:10 +01002787 if (ssl->session != NULL) {
2788 return ssl->session->verify_result;
2789 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002790
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 if (ssl->session_negotiate != NULL) {
2792 return ssl->session_negotiate->verify_result;
2793 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002794
Gilles Peskine449bd832023-01-11 14:50:10 +01002795 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00002796}
2797
Gilles Peskine449bd832023-01-11 14:50:10 +01002798int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05002799{
Gilles Peskine449bd832023-01-11 14:50:10 +01002800 if (ssl == NULL || ssl->session == NULL) {
2801 return 0;
2802 }
Glenn Strauss8f526902022-01-13 00:04:49 -05002803
Gilles Peskine449bd832023-01-11 14:50:10 +01002804 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05002805}
2806
Gilles Peskine449bd832023-01-11 14:50:10 +01002807const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00002808{
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 if (ssl == NULL || ssl->session == NULL) {
2810 return NULL;
2811 }
Paul Bakker926c8e42013-03-06 10:23:34 +01002812
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00002814}
2815
Gilles Peskine449bd832023-01-11 14:50:10 +01002816const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00002817{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002818#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002819 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2820 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002821 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002822 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002823 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002825 }
2826 }
2827#endif
2828
Gilles Peskine449bd832023-01-11 14:50:10 +01002829 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002830 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002831 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04002832 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01002833 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002834 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002835 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002836 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002837}
2838
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002839#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2840
2841size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
2842{
2843 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2844 size_t record_size_limit = max_len;
2845
2846 if (ssl->session != NULL &&
2847 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2848 ssl->session->record_size_limit < max_len) {
2849 record_size_limit = ssl->session->record_size_limit;
2850 }
2851
2852 // TODO: this is currently untested
2853 /* During a handshake, use the value being negotiated */
2854 if (ssl->session_negotiate != NULL &&
2855 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2856 ssl->session_negotiate->record_size_limit < max_len) {
2857 record_size_limit = ssl->session_negotiate->record_size_limit;
2858 }
2859
2860 return record_size_limit;
2861}
2862#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2863
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002864#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002865size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002866{
David Horstmann95d516f2021-05-04 18:36:56 +01002867 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002868 size_t read_mfl;
2869
Jerry Yuddda0502022-12-01 19:43:12 +08002870#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002871 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2873 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
2874 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002875 }
Jerry Yuddda0502022-12-01 19:43:12 +08002876#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002877
2878 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 if (ssl->session_out != NULL) {
2880 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
2881 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002882 max_len = read_mfl;
2883 }
2884 }
2885
Jerry Yuddda0502022-12-01 19:43:12 +08002886 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 if (ssl->session_negotiate != NULL) {
2888 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
2889 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002890 max_len = read_mfl;
2891 }
2892 }
2893
Gilles Peskine449bd832023-01-11 14:50:10 +01002894 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002895}
2896
Gilles Peskine449bd832023-01-11 14:50:10 +01002897size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002898{
2899 size_t max_len;
2900
2901 /*
2902 * Assume mfl_code is correct since it was checked when set
2903 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002905
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002906 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002907 if (ssl->session_out != NULL &&
2908 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
2909 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002910 }
2911
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002912 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002913 if (ssl->session_negotiate != NULL &&
2914 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
2915 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002916 }
2917
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002919}
2920#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2921
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002922#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002923size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002924{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002925 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002926 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2927 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2928 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
2929 return 0;
2930 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002931
Gilles Peskine449bd832023-01-11 14:50:10 +01002932 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
2933 return ssl->mtu;
2934 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002935
Gilles Peskine449bd832023-01-11 14:50:10 +01002936 if (ssl->mtu == 0) {
2937 return ssl->handshake->mtu;
2938 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002939
Gilles Peskine449bd832023-01-11 14:50:10 +01002940 return ssl->mtu < ssl->handshake->mtu ?
2941 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002942}
2943#endif /* MBEDTLS_SSL_PROTO_DTLS */
2944
Gilles Peskine449bd832023-01-11 14:50:10 +01002945int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002946{
2947 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2948
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002949#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002950 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002951 !defined(MBEDTLS_SSL_PROTO_DTLS)
2952 (void) ssl;
2953#endif
2954
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002955#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002956 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002957
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002959 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01002960 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002961#endif
2962
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002963#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2964 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
2965
2966 if (max_len > record_size_limit) {
2967 max_len = record_size_limit;
2968 }
2969#endif
2970
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002971 if (ssl->transform_out != NULL &&
2972 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00002973 /*
2974 * In TLS 1.3 case, when records are protected, `max_len` as computed
2975 * above is the maximum length of the TLSInnerPlaintext structure that
2976 * along the plaintext payload contains the inner content type (one byte)
2977 * and some zero padding. Given the algorithm used for padding
2978 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
2979 * the plaintext payload. Round down to a multiple of
2980 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
2981 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002982 */
2983 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
2984 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
2985 }
2986
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002987#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
2989 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
2990 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002991 const size_t overhead = (size_t) ret;
2992
Gilles Peskine449bd832023-01-11 14:50:10 +01002993 if (ret < 0) {
2994 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002995 }
2996
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 if (mtu <= overhead) {
2998 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
2999 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3000 }
3001
3002 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003003 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003004 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003005 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003006#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003007
Hanno Becker0defedb2018-08-10 12:35:02 +01003008#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003009 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3010 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003011 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003012#endif
3013
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003015}
3016
Gilles Peskine449bd832023-01-11 14:50:10 +01003017int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003018{
3019 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3020
3021#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3022 (void) ssl;
3023#endif
3024
3025#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003026 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003027
Gilles Peskine449bd832023-01-11 14:50:10 +01003028 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003029 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003031#endif
3032
Gilles Peskine449bd832023-01-11 14:50:10 +01003033 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003034}
3035
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003036#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003037const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003038{
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 if (ssl == NULL || ssl->session == NULL) {
3040 return NULL;
3041 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003042
Hanno Beckere6824572019-02-07 13:18:46 +00003043#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003044 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003045#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003047#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003048}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003049#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003050
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003051#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003052int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3053 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003054{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003055 int ret;
3056
Gilles Peskine449bd832023-01-11 14:50:10 +01003057 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003058 dst == NULL ||
3059 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003060 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3061 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003062 }
3063
Hanno Beckere810bbc2021-05-14 16:01:05 +01003064 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3065 * idempotent: Each session can only be exported once.
3066 *
3067 * (This is in preparation for TLS 1.3 support where we will
3068 * need the ability to export multiple sessions (aka tickets),
3069 * which will be achieved by calling mbedtls_ssl_get_session()
3070 * multiple times until it fails.)
3071 *
3072 * Check whether we have already exported the current session,
3073 * and fail if so.
3074 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003075 if (ssl->session->exported == 1) {
3076 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3077 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003078
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3080 if (ret != 0) {
3081 return ret;
3082 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003083
3084 /* Remember that we've exported the session. */
3085 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003086 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003087}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003088#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003089
David Horstmanncb01b362024-02-29 17:31:46 +00003090#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3091
3092/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003093 *
David Horstmanncb01b362024-02-29 17:31:46 +00003094 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003095 */
3096static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3097 unsigned char *buf,
3098 size_t buf_len)
3099{
3100 unsigned char *p = buf;
3101 size_t used = 0;
3102
3103#if defined(MBEDTLS_HAVE_TIME)
3104 uint64_t start;
3105#endif
3106#if defined(MBEDTLS_X509_CRT_PARSE_C)
3107#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3108 size_t cert_len;
3109#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3110#endif /* MBEDTLS_X509_CRT_PARSE_C */
3111
3112 /*
3113 * Time
3114 */
3115#if defined(MBEDTLS_HAVE_TIME)
3116 used += 8;
3117
3118 if (used <= buf_len) {
3119 start = (uint64_t) session->start;
3120
3121 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3122 p += 8;
3123 }
3124#endif /* MBEDTLS_HAVE_TIME */
3125
3126 /*
3127 * Basic mandatory fields
3128 */
3129 used += 1 /* id_len */
3130 + sizeof(session->id)
3131 + sizeof(session->master)
3132 + 4; /* verify_result */
3133
3134 if (used <= buf_len) {
3135 *p++ = MBEDTLS_BYTE_0(session->id_len);
3136 memcpy(p, session->id, 32);
3137 p += 32;
3138
3139 memcpy(p, session->master, 48);
3140 p += 48;
3141
3142 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3143 p += 4;
3144 }
3145
3146 /*
3147 * Peer's end-entity certificate
3148 */
3149#if defined(MBEDTLS_X509_CRT_PARSE_C)
3150#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3151 if (session->peer_cert == NULL) {
3152 cert_len = 0;
3153 } else {
3154 cert_len = session->peer_cert->raw.len;
3155 }
3156
3157 used += 3 + cert_len;
3158
3159 if (used <= buf_len) {
3160 *p++ = MBEDTLS_BYTE_2(cert_len);
3161 *p++ = MBEDTLS_BYTE_1(cert_len);
3162 *p++ = MBEDTLS_BYTE_0(cert_len);
3163
3164 if (session->peer_cert != NULL) {
3165 memcpy(p, session->peer_cert->raw.p, cert_len);
3166 p += cert_len;
3167 }
3168 }
3169#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3170 if (session->peer_cert_digest != NULL) {
3171 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3172 if (used <= buf_len) {
3173 *p++ = (unsigned char) session->peer_cert_digest_type;
3174 *p++ = (unsigned char) session->peer_cert_digest_len;
3175 memcpy(p, session->peer_cert_digest,
3176 session->peer_cert_digest_len);
3177 p += session->peer_cert_digest_len;
3178 }
3179 } else {
3180 used += 2;
3181 if (used <= buf_len) {
3182 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3183 *p++ = 0;
3184 }
3185 }
3186#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3187#endif /* MBEDTLS_X509_CRT_PARSE_C */
3188
3189 /*
3190 * Session ticket if any, plus associated data
3191 */
3192#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3193#if defined(MBEDTLS_SSL_CLI_C)
3194 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3195 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3196
3197 if (used <= buf_len) {
3198 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3199 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3200 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3201
3202 if (session->ticket != NULL) {
3203 memcpy(p, session->ticket, session->ticket_len);
3204 p += session->ticket_len;
3205 }
3206
3207 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3208 p += 4;
3209 }
3210 }
3211#endif /* MBEDTLS_SSL_CLI_C */
3212#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3213 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3214 used += 8;
3215
3216 if (used <= buf_len) {
3217 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3218 p += 8;
3219 }
3220 }
3221#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3222#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3223
3224 /*
3225 * Misc extension-related info
3226 */
3227#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3228 used += 1;
3229
3230 if (used <= buf_len) {
3231 *p++ = session->mfl_code;
3232 }
3233#endif
3234
3235#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3236 used += 1;
3237
3238 if (used <= buf_len) {
3239 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3240 }
3241#endif
3242
3243 return used;
3244}
3245
3246MBEDTLS_CHECK_RETURN_CRITICAL
3247static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3248 const unsigned char *buf,
3249 size_t len)
3250{
3251#if defined(MBEDTLS_HAVE_TIME)
3252 uint64_t start;
3253#endif
3254#if defined(MBEDTLS_X509_CRT_PARSE_C)
3255#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3256 size_t cert_len;
3257#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3258#endif /* MBEDTLS_X509_CRT_PARSE_C */
3259
3260 const unsigned char *p = buf;
3261 const unsigned char * const end = buf + len;
3262
3263 /*
3264 * Time
3265 */
3266#if defined(MBEDTLS_HAVE_TIME)
3267 if (8 > (size_t) (end - p)) {
3268 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3269 }
3270
3271 start = MBEDTLS_GET_UINT64_BE(p, 0);
3272 p += 8;
3273
3274 session->start = (time_t) start;
3275#endif /* MBEDTLS_HAVE_TIME */
3276
3277 /*
3278 * Basic mandatory fields
3279 */
3280 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3281 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3282 }
3283
3284 session->id_len = *p++;
3285 memcpy(session->id, p, 32);
3286 p += 32;
3287
3288 memcpy(session->master, p, 48);
3289 p += 48;
3290
3291 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3292 p += 4;
3293
3294 /* Immediately clear invalid pointer values that have been read, in case
3295 * we exit early before we replaced them with valid ones. */
3296#if defined(MBEDTLS_X509_CRT_PARSE_C)
3297#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3298 session->peer_cert = NULL;
3299#else
3300 session->peer_cert_digest = NULL;
3301#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3302#endif /* MBEDTLS_X509_CRT_PARSE_C */
3303#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3304 session->ticket = NULL;
3305#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3306
3307 /*
3308 * Peer certificate
3309 */
3310#if defined(MBEDTLS_X509_CRT_PARSE_C)
3311#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3312 /* Deserialize CRT from the end of the ticket. */
3313 if (3 > (size_t) (end - p)) {
3314 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3315 }
3316
3317 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3318 p += 3;
3319
3320 if (cert_len != 0) {
3321 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3322
3323 if (cert_len > (size_t) (end - p)) {
3324 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3325 }
3326
3327 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3328
3329 if (session->peer_cert == NULL) {
3330 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3331 }
3332
3333 mbedtls_x509_crt_init(session->peer_cert);
3334
3335 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3336 p, cert_len)) != 0) {
3337 mbedtls_x509_crt_free(session->peer_cert);
3338 mbedtls_free(session->peer_cert);
3339 session->peer_cert = NULL;
3340 return ret;
3341 }
3342
3343 p += cert_len;
3344 }
3345#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3346 /* Deserialize CRT digest from the end of the ticket. */
3347 if (2 > (size_t) (end - p)) {
3348 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3349 }
3350
3351 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3352 session->peer_cert_digest_len = (size_t) *p++;
3353
3354 if (session->peer_cert_digest_len != 0) {
3355 const mbedtls_md_info_t *md_info =
3356 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3357 if (md_info == NULL) {
3358 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3359 }
3360 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3361 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3362 }
3363
3364 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3365 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3366 }
3367
3368 session->peer_cert_digest =
3369 mbedtls_calloc(1, session->peer_cert_digest_len);
3370 if (session->peer_cert_digest == NULL) {
3371 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3372 }
3373
3374 memcpy(session->peer_cert_digest, p,
3375 session->peer_cert_digest_len);
3376 p += session->peer_cert_digest_len;
3377 }
3378#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3379#endif /* MBEDTLS_X509_CRT_PARSE_C */
3380
3381 /*
3382 * Session ticket and associated data
3383 */
3384#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3385#if defined(MBEDTLS_SSL_CLI_C)
3386 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3387 if (3 > (size_t) (end - p)) {
3388 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3389 }
3390
3391 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3392 p += 3;
3393
3394 if (session->ticket_len != 0) {
3395 if (session->ticket_len > (size_t) (end - p)) {
3396 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3397 }
3398
3399 session->ticket = mbedtls_calloc(1, session->ticket_len);
3400 if (session->ticket == NULL) {
3401 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3402 }
3403
3404 memcpy(session->ticket, p, session->ticket_len);
3405 p += session->ticket_len;
3406 }
3407
3408 if (4 > (size_t) (end - p)) {
3409 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3410 }
3411
3412 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3413 p += 4;
3414 }
3415#endif /* MBEDTLS_SSL_CLI_C */
3416#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3417 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3418 if (8 > (size_t) (end - p)) {
3419 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3420 }
3421 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3422 p += 8;
3423 }
3424#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3425#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3426
3427 /*
3428 * Misc extension-related info
3429 */
3430#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3431 if (1 > (size_t) (end - p)) {
3432 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3433 }
3434
3435 session->mfl_code = *p++;
3436#endif
3437
3438#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3439 if (1 > (size_t) (end - p)) {
3440 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3441 }
3442
3443 session->encrypt_then_mac = *p++;
3444#endif
3445
3446 /* Done, should have consumed entire buffer */
3447 if (p != end) {
3448 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3449 }
3450
3451 return 0;
3452}
3453
3454#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3455
3456#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3457/* Serialization of TLS 1.3 sessions:
3458 *
David Horstmanncb01b362024-02-29 17:31:46 +00003459 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003460 */
3461#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3462MBEDTLS_CHECK_RETURN_CRITICAL
3463static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3464 unsigned char *buf,
3465 size_t buf_len,
3466 size_t *olen)
3467{
3468 unsigned char *p = buf;
3469#if defined(MBEDTLS_SSL_CLI_C) && \
3470 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3471 size_t hostname_len = (session->hostname == NULL) ?
3472 0 : strlen(session->hostname) + 1;
3473#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003474
3475#if defined(MBEDTLS_SSL_SRV_C) && \
3476 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003477 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003478 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003479#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003480 size_t needed = 4 /* ticket_age_add */
3481 + 1 /* ticket_flags */
3482 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003483
David Horstmanne59f9702024-02-29 16:08:57 +00003484 *olen = 0;
3485
3486 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3487 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3488 }
3489 needed += session->resumption_key_len; /* resumption_key */
3490
3491#if defined(MBEDTLS_SSL_EARLY_DATA)
3492 needed += 4; /* max_early_data_size */
3493#endif
3494#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3495 needed += 2; /* record_size_limit */
3496#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3497
3498#if defined(MBEDTLS_HAVE_TIME)
3499 needed += 8; /* ticket_creation_time or ticket_reception_time */
3500#endif
3501
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003502#if defined(MBEDTLS_SSL_SRV_C)
3503 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3504#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003505 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003506 + alpn_len; /* alpn */
3507#endif
3508 }
3509#endif /* MBEDTLS_SSL_SRV_C */
3510
David Horstmanne59f9702024-02-29 16:08:57 +00003511#if defined(MBEDTLS_SSL_CLI_C)
3512 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3513#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3514 needed += 2 /* hostname_len */
3515 + hostname_len; /* hostname */
3516#endif
3517
3518 needed += 4 /* ticket_lifetime */
3519 + 2; /* ticket_len */
3520
3521 /* Check size_t overflow */
3522 if (session->ticket_len > SIZE_MAX - needed) {
3523 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3524 }
3525
3526 needed += session->ticket_len; /* ticket */
3527 }
3528#endif /* MBEDTLS_SSL_CLI_C */
3529
3530 *olen = needed;
3531 if (needed > buf_len) {
3532 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3533 }
3534
3535 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3536 p[4] = session->ticket_flags;
3537
3538 /* save resumption_key */
3539 p[5] = session->resumption_key_len;
3540 p += 6;
3541 memcpy(p, session->resumption_key, session->resumption_key_len);
3542 p += session->resumption_key_len;
3543
3544#if defined(MBEDTLS_SSL_EARLY_DATA)
3545 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3546 p += 4;
3547#endif
3548#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3549 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3550 p += 2;
3551#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3552
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003553#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003554 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003555#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003556 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3557 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003558#endif /* MBEDTLS_HAVE_TIME */
3559
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003560#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003561 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3562 p += 2;
3563
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003564 if (alpn_len > 0) {
3565 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003566 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003567 p += alpn_len;
3568 }
3569#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3570 }
3571#endif /* MBEDTLS_SSL_SRV_C */
3572
David Horstmanne59f9702024-02-29 16:08:57 +00003573#if defined(MBEDTLS_SSL_CLI_C)
3574 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3575#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3576 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3577 p += 2;
3578 if (hostname_len > 0) {
3579 /* save host name */
3580 memcpy(p, session->hostname, hostname_len);
3581 p += hostname_len;
3582 }
3583#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3584
3585#if defined(MBEDTLS_HAVE_TIME)
3586 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3587 p += 8;
3588#endif
3589 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3590 p += 4;
3591
3592 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3593 p += 2;
3594
3595 if (session->ticket != NULL && session->ticket_len > 0) {
3596 memcpy(p, session->ticket, session->ticket_len);
3597 p += session->ticket_len;
3598 }
3599 }
3600#endif /* MBEDTLS_SSL_CLI_C */
3601 return 0;
3602}
3603
3604MBEDTLS_CHECK_RETURN_CRITICAL
3605static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3606 const unsigned char *buf,
3607 size_t len)
3608{
3609 const unsigned char *p = buf;
3610 const unsigned char *end = buf + len;
3611
3612 if (end - p < 6) {
3613 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3614 }
3615 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3616 session->ticket_flags = p[4];
3617
3618 /* load resumption_key */
3619 session->resumption_key_len = p[5];
3620 p += 6;
3621
3622 if (end - p < session->resumption_key_len) {
3623 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3624 }
3625
3626 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3627 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3628 }
3629 memcpy(session->resumption_key, p, session->resumption_key_len);
3630 p += session->resumption_key_len;
3631
3632#if defined(MBEDTLS_SSL_EARLY_DATA)
3633 if (end - p < 4) {
3634 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3635 }
3636 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3637 p += 4;
3638#endif
3639#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3640 if (end - p < 2) {
3641 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3642 }
3643 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3644 p += 2;
3645#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3646
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003647#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003648 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003649#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003650 if (end - p < 8) {
3651 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3652 }
3653 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3654 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003655#endif /* MBEDTLS_HAVE_TIME */
3656
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003657#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003658 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003659
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003660 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003661 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3662 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003663
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003664 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3665 p += 2;
3666
3667 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003668 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3669 }
3670
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003671 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003672 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3673 if (ret != 0) {
3674 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003675 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003676 p += alpn_len;
3677 }
3678#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3679 }
3680#endif /* MBEDTLS_SSL_SRV_C */
3681
David Horstmanne59f9702024-02-29 16:08:57 +00003682#if defined(MBEDTLS_SSL_CLI_C)
3683 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3684#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3685 size_t hostname_len;
3686 /* load host name */
3687 if (end - p < 2) {
3688 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3689 }
3690 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3691 p += 2;
3692
3693 if (end - p < (long int) hostname_len) {
3694 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3695 }
3696 if (hostname_len > 0) {
3697 session->hostname = mbedtls_calloc(1, hostname_len);
3698 if (session->hostname == NULL) {
3699 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3700 }
3701 memcpy(session->hostname, p, hostname_len);
3702 p += hostname_len;
3703 }
3704#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3705
3706#if defined(MBEDTLS_HAVE_TIME)
3707 if (end - p < 8) {
3708 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3709 }
3710 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3711 p += 8;
3712#endif
3713 if (end - p < 4) {
3714 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3715 }
3716 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3717 p += 4;
3718
3719 if (end - p < 2) {
3720 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3721 }
3722 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
3723 p += 2;
3724
3725 if (end - p < (long int) session->ticket_len) {
3726 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3727 }
3728 if (session->ticket_len > 0) {
3729 session->ticket = mbedtls_calloc(1, session->ticket_len);
3730 if (session->ticket == NULL) {
3731 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3732 }
3733 memcpy(session->ticket, p, session->ticket_len);
3734 p += session->ticket_len;
3735 }
3736 }
3737#endif /* MBEDTLS_SSL_CLI_C */
3738
3739 return 0;
3740
3741}
3742#else /* MBEDTLS_SSL_SESSION_TICKETS */
3743MBEDTLS_CHECK_RETURN_CRITICAL
3744static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3745 unsigned char *buf,
3746 size_t buf_len,
3747 size_t *olen)
3748{
3749 ((void) session);
3750 ((void) buf);
3751 ((void) buf_len);
3752 *olen = 0;
3753 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3754}
3755
3756static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01003757 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00003758 size_t buf_len)
3759{
3760 ((void) session);
3761 ((void) buf);
3762 ((void) buf_len);
3763 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3764}
3765#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
3766#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3767
Paul Bakker5121ce52009-01-03 21:22:43 +00003768/*
Hanno Beckera835da52019-05-16 12:39:07 +01003769 * Define ticket header determining Mbed TLS version
3770 * and structure of the ticket.
3771 */
3772
Hanno Becker94ef3b32019-05-16 12:50:45 +01003773/*
Hanno Becker50b59662019-05-28 14:30:45 +01003774 * Define bitflag determining compile-time settings influencing
3775 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003776 */
3777
Hanno Becker50b59662019-05-28 14:30:45 +01003778#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003779#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003780#else
Hanno Becker3e088662019-05-29 11:10:18 +01003781#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003782#endif /* MBEDTLS_HAVE_TIME */
3783
3784#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003785#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003786#else
Hanno Becker3e088662019-05-29 11:10:18 +01003787#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003788#endif /* MBEDTLS_X509_CRT_PARSE_C */
3789
David Horstmann5c5a32f2024-02-13 17:53:35 +00003790#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00003791#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00003792#else
David Horstmannf686f1d2024-03-01 11:20:32 +00003793#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00003794#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3795
Hanno Becker94ef3b32019-05-16 12:50:45 +01003796#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003797#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003798#else
Hanno Becker3e088662019-05-29 11:10:18 +01003799#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003800#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3801
3802#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003803#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003804#else
Hanno Becker3e088662019-05-29 11:10:18 +01003805#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003806#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3807
Hanno Becker94ef3b32019-05-16 12:50:45 +01003808#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003809#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003810#else
Hanno Becker3e088662019-05-29 11:10:18 +01003811#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003812#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3813
Hanno Becker94ef3b32019-05-16 12:50:45 +01003814#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3815#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3816#else
3817#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3818#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3819
David Horstmann92b258b2024-02-13 17:23:34 +00003820#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3821#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
3822#else
3823#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
3824#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3825
3826#if defined(MBEDTLS_SSL_EARLY_DATA)
3827#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
3828#else
3829#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
3830#endif /* MBEDTLS_SSL_EARLY_DATA */
3831
3832#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3833#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
3834#else
3835#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
3836#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3837
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003838#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
3839 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00003840#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
3841#else
3842#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
3843#endif /* MBEDTLS_SSL_ALPN */
3844
Hanno Becker3e088662019-05-29 11:10:18 +01003845#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3846#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3847#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3848#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003849#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3850#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00003851#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00003852#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
3853#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
3854#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00003855#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01003856
Hanno Becker50b59662019-05-28 14:30:45 +01003857#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003858 ((uint16_t) ( \
3859 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3860 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3861 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3862 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3863 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3864 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00003865 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00003866 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
3867 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00003868 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
3869 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
3870 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
3871 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003872 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00003873 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003874 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003875
Chien Wong4e9683e2023-12-28 17:07:43 +08003876static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003877 MBEDTLS_VERSION_MAJOR,
3878 MBEDTLS_VERSION_MINOR,
3879 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003880 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3881 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003882};
Hanno Beckera835da52019-05-16 12:39:07 +01003883
3884/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003885 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003886 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003887 *
David Horstmanncb01b362024-02-29 17:31:46 +00003888 * TLS 1.2 session:
3889 *
3890 * struct {
3891 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
3892 * opaque ticket<0..2^24-1>; // length 0 means no ticket
3893 * uint32 ticket_lifetime;
3894 * #endif
3895 * } ClientOnlyData;
3896 *
3897 * struct {
3898 * #if defined(MBEDTLS_HAVE_TIME)
3899 * uint64 start_time;
3900 * #endif
3901 * uint8 session_id_len; // at most 32
3902 * opaque session_id[32];
3903 * opaque master[48]; // fixed length in the standard
3904 * uint32 verify_result;
3905 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
3906 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
3907 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00003908 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00003909 * opaque peer_cert_digest<0..2^8-1>
3910 * #endif
3911 * select (endpoint) {
3912 * case client: ClientOnlyData;
3913 * case server: uint64 ticket_creation_time;
3914 * };
3915 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3916 * uint8 mfl_code; // up to 255 according to standard
3917 * #endif
3918 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3919 * uint8 encrypt_then_mac; // 0 or 1
3920 * #endif
3921 * } serialized_session_tls12;
3922 *
3923 *
3924 * TLS 1.3 Session:
3925 *
3926 * struct {
3927 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3928 * opaque hostname<0..2^16-1>;
3929 * #endif
3930 * #if defined(MBEDTLS_HAVE_TIME)
3931 * uint64 ticket_reception_time;
3932 * #endif
3933 * uint32 ticket_lifetime;
3934 * opaque ticket<1..2^16-1>;
3935 * } ClientOnlyData;
3936 *
3937 * struct {
3938 * uint32 ticket_age_add;
3939 * uint8 ticket_flags;
3940 * opaque resumption_key<0..255>;
3941 * #if defined(MBEDTLS_SSL_EARLY_DATA)
3942 * uint32 max_early_data_size;
3943 * #endif
3944 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3945 * uint16 record_size_limit;
3946 * #endif
3947 * select ( endpoint ) {
3948 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003949 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00003950 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003951 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00003952 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00003953 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003954 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00003955 * #endif
3956 * };
3957 * } serialized_session_tls13;
3958 *
3959 *
3960 * SSL session:
3961 *
3962 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003963 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003964 * opaque mbedtls_version[3]; // library version: major, minor, patch
3965 * opaque session_format[2]; // library-version specific 16-bit field
3966 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003967 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003968 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003969 * Note: When updating the format, remember to keep
3970 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003971 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003972 * // In this version, `session_format` determines
3973 * // the setting of those compile-time
3974 * // configuration options which influence
3975 * // the structure of mbedtls_ssl_session.
3976 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003977 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003978 * // - TLS 1.2 (0x0303)
3979 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00003980 * uint8_t endpoint;
3981 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003982 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003983 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003984 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003985 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003986 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003987 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003988 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003989 *
3990 * };
3991 *
3992 * } serialized_session;
3993 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003994 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003995
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003996MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01003997static int ssl_session_save(const mbedtls_ssl_session *session,
3998 unsigned char omit_header,
3999 unsigned char *buf,
4000 size_t buf_len,
4001 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004002{
4003 unsigned char *p = buf;
4004 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004005 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004006#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4007 size_t out_len;
4008 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4009#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004010 if (session == NULL) {
4011 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4012 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004013
Gilles Peskine449bd832023-01-11 14:50:10 +01004014 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004015 /*
4016 * Add Mbed TLS version identifier
4017 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004018 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004019
Gilles Peskine449bd832023-01-11 14:50:10 +01004020 if (used <= buf_len) {
4021 memcpy(p, ssl_serialized_session_header,
4022 sizeof(ssl_serialized_session_header));
4023 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004024 }
4025 }
4026
4027 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004028 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004029 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004030 used += 1 /* TLS version */
4031 + 1 /* endpoint */
4032 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004033 if (used <= buf_len) {
4034 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004035 *p++ = session->endpoint;
4036 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4037 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004038 }
4039
4040 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004041 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004042 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004043#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004044 case MBEDTLS_SSL_VERSION_TLS1_2:
4045 used += ssl_tls12_session_save(session, p, remaining_len);
4046 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004047#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4048
Jerry Yu251a12e2022-07-13 15:15:48 +08004049#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004050 case MBEDTLS_SSL_VERSION_TLS1_3:
4051 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4052 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4053 return ret;
4054 }
4055 used += out_len;
4056 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004057#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4058
Gilles Peskine449bd832023-01-11 14:50:10 +01004059 default:
4060 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004061 }
4062
4063 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004064 if (used > buf_len) {
4065 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4066 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004067
Gilles Peskine449bd832023-01-11 14:50:10 +01004068 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004069}
4070
4071/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004072 * Public wrapper for ssl_session_save()
4073 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004074int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4075 unsigned char *buf,
4076 size_t buf_len,
4077 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004078{
Gilles Peskine449bd832023-01-11 14:50:10 +01004079 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004080}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004081
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004082/*
4083 * Deserialize session, see mbedtls_ssl_session_save() for format.
4084 *
4085 * This internal version is wrapped by a public function that cleans up in
4086 * case of error, and has an extra option omit_header.
4087 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004088MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004089static int ssl_session_load(mbedtls_ssl_session *session,
4090 unsigned char omit_header,
4091 const unsigned char *buf,
4092 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004093{
4094 const unsigned char *p = buf;
4095 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004096 size_t remaining_len;
4097
4098
Gilles Peskine449bd832023-01-11 14:50:10 +01004099 if (session == NULL) {
4100 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4101 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004102
Gilles Peskine449bd832023-01-11 14:50:10 +01004103 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004104 /*
4105 * Check Mbed TLS version identifier
4106 */
4107
Gilles Peskine449bd832023-01-11 14:50:10 +01004108 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4109 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004110 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004111
4112 if (memcmp(p, ssl_serialized_session_header,
4113 sizeof(ssl_serialized_session_header)) != 0) {
4114 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4115 }
4116 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004117 }
4118
4119 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004120 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004121 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004122 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004123 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4124 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004125 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004126 session->endpoint = *p++;
4127 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4128 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004129
4130 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004131 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004132 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004133#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004134 case MBEDTLS_SSL_VERSION_TLS1_2:
4135 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004136#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4137
Jerry Yu438ddd82022-07-07 06:55:50 +00004138#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 case MBEDTLS_SSL_VERSION_TLS1_3:
4140 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004141#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4142
Gilles Peskine449bd832023-01-11 14:50:10 +01004143 default:
4144 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004145 }
4146}
4147
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004148/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004149 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004150 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004151int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4152 const unsigned char *buf,
4153 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004154{
Gilles Peskine449bd832023-01-11 14:50:10 +01004155 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004156
Gilles Peskine449bd832023-01-11 14:50:10 +01004157 if (ret != 0) {
4158 mbedtls_ssl_session_free(session);
4159 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004160
Gilles Peskine449bd832023-01-11 14:50:10 +01004161 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004162}
4163
4164/*
Paul Bakker1961b702013-01-25 14:49:24 +01004165 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004166 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004167MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004168static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004169{
4170 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4171
Ronald Cron66dbf912022-02-02 15:33:46 +01004172 /*
4173 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004174 * that were written into the output buffer by the previous handshake step,
4175 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004176 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4177 * We proceed to the next handshake step only when all data from the
4178 * previous one have been sent to the peer, thus we make sure that this is
4179 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4180 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4181 * we have to wait before to go ahead.
4182 * In the case of TLS 1.3, handshake step handlers do not send data to the
4183 * peer. Data are only sent here and through
4184 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004185 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004186 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004187 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4188 return ret;
4189 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004190
4191#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004192 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4193 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4194 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4195 return ret;
4196 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004197 }
4198#endif /* MBEDTLS_SSL_PROTO_DTLS */
4199
Gilles Peskine449bd832023-01-11 14:50:10 +01004200 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004201}
4202
Gilles Peskine449bd832023-01-11 14:50:10 +01004203int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004204{
Hanno Becker41934dd2021-08-07 19:13:43 +01004205 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004206
Gilles Peskine449bd832023-01-11 14:50:10 +01004207 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004208 ssl->conf == NULL ||
4209 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004210 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4211 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004212 }
4213
Gilles Peskine449bd832023-01-11 14:50:10 +01004214 ret = ssl_prepare_handshake_step(ssl);
4215 if (ret != 0) {
4216 return ret;
4217 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004218
Gilles Peskine449bd832023-01-11 14:50:10 +01004219 ret = mbedtls_ssl_handle_pending_alert(ssl);
4220 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004221 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004222 }
Jerry Yue7047812021-09-13 19:26:39 +08004223
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004224 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4225 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4226 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4227
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004228#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004229 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4230 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004231 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004232
Gilles Peskine449bd832023-01-11 14:50:10 +01004233 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004234 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskinef670ba52025-03-07 15:09:32 +01004235 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004236 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004237 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004238
Ronald Cron9f0fba32022-02-10 16:45:15 +01004239 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004240 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004241 break;
4242
4243 default:
4244#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004245 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4246 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4247 } else {
4248 ret = mbedtls_ssl_handshake_client_step(ssl);
4249 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004250#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004251 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004252#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004253 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004254#endif
4255 }
Jerry Yub9930e72021-08-06 17:11:51 +08004256 }
Ronald Cron6291b232023-03-08 15:51:25 +01004257#endif /* MBEDTLS_SSL_CLI_C */
4258
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004259#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004260 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004261#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4262 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004263 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004264 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004265 ret = mbedtls_ssl_handshake_server_step(ssl);
4266 }
Ronald Cron6291b232023-03-08 15:51:25 +01004267#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4268 ret = mbedtls_ssl_handshake_server_step(ssl);
4269#else
4270 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004271#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004272 }
4273#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004274
Gilles Peskine449bd832023-01-11 14:50:10 +01004275 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004276 /* handshake_step return error. And it is same
4277 * with alert_reason.
4278 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004279 if (ssl->send_alert) {
4280 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004281 goto cleanup;
4282 }
4283 }
4284
4285cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004286 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004287}
4288
4289/*
4290 * Perform the SSL handshake
4291 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004292int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004293{
4294 int ret = 0;
4295
Hanno Beckera817ea42020-10-20 15:20:23 +01004296 /* Sanity checks */
4297
Gilles Peskine449bd832023-01-11 14:50:10 +01004298 if (ssl == NULL || ssl->conf == NULL) {
4299 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4300 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004301
Hanno Beckera817ea42020-10-20 15:20:23 +01004302#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004303 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4304 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4305 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4306 "mbedtls_ssl_set_timer_cb() for DTLS"));
4307 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004308 }
4309#endif /* MBEDTLS_SSL_PROTO_DTLS */
4310
Gilles Peskine449bd832023-01-11 14:50:10 +01004311 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004312
Hanno Beckera817ea42020-10-20 15:20:23 +01004313 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004314 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4315 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004316
Gilles Peskine449bd832023-01-11 14:50:10 +01004317 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004318 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004319 }
Paul Bakker1961b702013-01-25 14:49:24 +01004320 }
4321
Gilles Peskine449bd832023-01-11 14:50:10 +01004322 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004323
Gilles Peskine449bd832023-01-11 14:50:10 +01004324 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004325}
4326
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004327#if defined(MBEDTLS_SSL_RENEGOTIATION)
4328#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004329/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004330 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004331 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004332MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004333static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004334{
Janos Follath865b3eb2019-12-16 11:46:15 +00004335 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004336
Gilles Peskine449bd832023-01-11 14:50:10 +01004337 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004338
4339 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004340 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4341 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004342
Gilles Peskine449bd832023-01-11 14:50:10 +01004343 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4344 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4345 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004346 }
4347
Gilles Peskine449bd832023-01-11 14:50:10 +01004348 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004349
Gilles Peskine449bd832023-01-11 14:50:10 +01004350 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004351}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004352#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004353
4354/*
4355 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004356 * - any side: calling mbedtls_ssl_renegotiate(),
4357 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4358 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004359 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004360 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004361 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004362 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004363int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004364{
Janos Follath865b3eb2019-12-16 11:46:15 +00004365 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004366
Gilles Peskine449bd832023-01-11 14:50:10 +01004367 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004368
Gilles Peskine449bd832023-01-11 14:50:10 +01004369 if ((ret = ssl_handshake_init(ssl)) != 0) {
4370 return ret;
4371 }
Paul Bakker48916f92012-09-16 19:57:18 +00004372
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004373 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4374 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004375#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004376 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4377 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4378 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004379 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004380 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004381 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004383 }
4384#endif
4385
Gilles Peskinef670ba52025-03-07 15:09:32 +01004386 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_REQUEST);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004387 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004388
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4390 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4391 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004392 }
4393
Gilles Peskine449bd832023-01-11 14:50:10 +01004394 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004395
Gilles Peskine449bd832023-01-11 14:50:10 +01004396 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004397}
4398
4399/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004400 * Renegotiate current connection on client,
4401 * or request renegotiation on server
4402 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004403int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004404{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004405 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004406
Gilles Peskine449bd832023-01-11 14:50:10 +01004407 if (ssl == NULL || ssl->conf == NULL) {
4408 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4409 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004410
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004411#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004412 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4414 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4415 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4416 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004417
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004418 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004419
4420 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004421 if (ssl->out_left != 0) {
4422 return mbedtls_ssl_flush_output(ssl);
4423 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004424
Gilles Peskine449bd832023-01-11 14:50:10 +01004425 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004426 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004427#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004428
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004429#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004430 /*
4431 * On client, either start the renegotiation process or,
4432 * if already in progress, continue the handshake
4433 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004434 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4435 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4436 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004437 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004438
4439 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4440 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4441 return ret;
4442 }
4443 } else {
4444 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4445 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4446 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004447 }
4448 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004449#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004450
Gilles Peskine449bd832023-01-11 14:50:10 +01004451 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004452}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004453#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004454
Gilles Peskine449bd832023-01-11 14:50:10 +01004455void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004456{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004457 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4458
Gilles Peskine449bd832023-01-11 14:50:10 +01004459 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004460 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004462
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004463#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Brett Warrene0edc842021-08-17 09:53:13 +01004464#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004465 if (ssl->handshake->group_list_heap_allocated) {
4466 mbedtls_free((void *) handshake->group_list);
4467 }
Brett Warrene0edc842021-08-17 09:53:13 +01004468 handshake->group_list = NULL;
4469#endif /* MBEDTLS_DEPRECATED_REMOVED */
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004470#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Brett Warrene0edc842021-08-17 09:53:13 +01004471
Ronald Crone68ab4f2022-10-05 12:46:29 +02004472#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004473#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004474 if (ssl->handshake->sig_algs_heap_allocated) {
4475 mbedtls_free((void *) handshake->sig_algs);
4476 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004477 handshake->sig_algs = NULL;
4478#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004479#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004480 if (ssl->handshake->certificate_request_context) {
4481 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004482 }
4483#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004484#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004485
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004486#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Ben Taylorcd2660f2025-03-21 13:13:29 +00004487 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
Ben Taylorc12152e2025-03-21 11:03:04 +00004488 ssl->conf->f_async_cancel(ssl);
4489 handshake->async_in_progress = 0;
Ben Taylor1cd1e012025-03-18 11:50:39 +00004490 }
Ben Taylor6ff2da12025-03-17 09:26:20 +00004491
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004492#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4493
Elena Uziunaite0916cd72024-05-23 17:01:07 +01004494#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01004495 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004496#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01004497#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004499#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004500
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004501#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004503 /*
4504 * Opaque keys are not stored in the handshake's data and it's the user
4505 * responsibility to destroy them. Clear ones, instead, are created by
4506 * the TLS library and should be destroyed at the same level
4507 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4509 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004510 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004511 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004512#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004513 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004514 handshake->ecjpake_cache = NULL;
4515 handshake->ecjpake_cache_len = 0;
4516#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004517#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004518
Valerio Setti7aeec542023-07-05 18:57:21 +02004519#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004520 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004521 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004522 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004523 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004524#endif
4525
Ronald Cron73fe8df2022-10-05 14:31:43 +02004526#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004528 /* The maintenance of the external PSK key slot is the
4529 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004530 if (ssl->handshake->psk_opaque_is_internal) {
4531 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004532 ssl->handshake->psk_opaque_is_internal = 0;
4533 }
4534 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4535 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02004536#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004537
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004538#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4539 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004540 /*
4541 * Free only the linked list wrapper, not the keys themselves
4542 * since the belong to the SNI callback
4543 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004545#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004546
Gilles Peskineeccd8882020-03-10 12:19:08 +01004547#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004548 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4549 if (handshake->ecrs_peer_cert != NULL) {
4550 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4551 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004552 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004553#endif
4554
Hanno Becker75173122019-02-06 16:18:31 +00004555#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4556 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004558#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4559
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004560#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004561 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4562 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004563#endif /* MBEDTLS_SSL_CLI_C &&
4564 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004565
4566#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 mbedtls_ssl_flight_free(handshake->flight);
4568 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004569#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004570
Valerio Settiea59c432023-07-25 11:14:03 +02004571#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004572 if (handshake->xxdh_psa_privkey_is_external == 0) {
4573 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 }
Valerio Settiea59c432023-07-25 11:14:03 +02004575#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004576
Ronald Cron6f135e12021-12-08 16:57:54 +01004577#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004578 mbedtls_ssl_transform_free(handshake->transform_handshake);
4579 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004580#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4582 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004583#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004584#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004585
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004586
4587#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4588 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4589 * processes datagrams and the fact that a datagram is allowed to have
4590 * several records in it, it is possible that the I/O buffers are not
4591 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004592 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4593 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004594#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004595
Jerry Yuba9c7272021-10-30 11:54:10 +08004596 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004597 mbedtls_platform_zeroize(handshake,
4598 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004599}
4600
Gilles Peskine449bd832023-01-11 14:50:10 +01004601void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004602{
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004604 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004606
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004607#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004608 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004609#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004610
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004611#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004612#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4613 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004614 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004615#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004616 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004617#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004618
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004619#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4620 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004621 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004622#endif
4623
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004625}
4626
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004627#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004628
4629#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4630#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4631#else
4632#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4633#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4634
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004635#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004636
4637#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4638#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4639#else
4640#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4641#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4642
4643#if defined(MBEDTLS_SSL_ALPN)
4644#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4645#else
4646#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4647#endif /* MBEDTLS_SSL_ALPN */
4648
4649#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4650#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4651#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4652#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4653
4654#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 ((uint32_t) ( \
4656 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4657 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4658 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4659 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4660 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4661 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4662 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4663 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004664
Chien Wong4e9683e2023-12-28 17:07:43 +08004665static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004666 MBEDTLS_VERSION_MAJOR,
4667 MBEDTLS_VERSION_MINOR,
4668 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004669 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4670 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4671 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4672 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4673 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004674};
4675
Paul Bakker5121ce52009-01-03 21:22:43 +00004676/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004677 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004678 *
4679 * The format of the serialized data is:
4680 * (in the presentation language of TLS, RFC 8446 section 3)
4681 *
4682 * // header
4683 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004684 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004685 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004686 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004687 * Note: When updating the format, remember to keep these
4688 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004689 *
4690 * // session sub-structure
4691 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4692 * // transform sub-structure
4693 * uint8 random[64]; // ServerHello.random+ClientHello.random
4694 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4695 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4696 * // fields from ssl_context
4697 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4698 * uint64 in_window_top; // DTLS: last validated record seq_num
4699 * uint64 in_window; // DTLS: bitmask for replay protection
4700 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4701 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4702 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4703 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4704 *
4705 * Note that many fields of the ssl_context or sub-structures are not
4706 * serialized, as they fall in one of the following categories:
4707 *
4708 * 1. forced value (eg in_left must be 0)
4709 * 2. pointer to dynamically-allocated memory (eg session, transform)
4710 * 3. value can be re-derived from other data (eg session keys from MS)
4711 * 4. value was temporary (eg content of input buffer)
4712 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004713 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004714int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4715 unsigned char *buf,
4716 size_t buf_len,
4717 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004718{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004719 unsigned char *p = buf;
4720 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004721 size_t session_len;
4722 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004723
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004724 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004725 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4726 * this function's documentation.
4727 *
4728 * These are due to assumptions/limitations in the implementation. Some of
4729 * them are likely to stay (no handshake in progress) some might go away
4730 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004731 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004732 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004733 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4734 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4735 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004736 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 if (ssl->handshake != NULL) {
4738 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4739 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004740 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004741 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004742 if (ssl->transform == NULL || ssl->session == NULL) {
4743 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4744 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004745 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004746 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 if (mbedtls_ssl_check_pending(ssl) != 0) {
4748 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4749 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004750 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004751 if (ssl->out_left != 0) {
4752 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4753 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004754 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004755 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4757 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4758 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004759 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004760 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004761 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4762 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4763 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004764 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004765 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004766 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4767 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4768 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004769 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004770 /* Renegotiation must not be enabled */
4771#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004772 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4773 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4774 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004775 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004776#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004777
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004778 /*
4779 * Version and format identifier
4780 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004781 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004782
Gilles Peskine449bd832023-01-11 14:50:10 +01004783 if (used <= buf_len) {
4784 memcpy(p, ssl_serialized_context_header,
4785 sizeof(ssl_serialized_context_header));
4786 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004787 }
4788
4789 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004790 * Session (length + data)
4791 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004792 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4793 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4794 return ret;
4795 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004796
4797 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004798 if (used <= buf_len) {
4799 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004800 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004801
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 ret = ssl_session_save(ssl->session, 1,
4803 p, session_len, &session_len);
4804 if (ret != 0) {
4805 return ret;
4806 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004807
4808 p += session_len;
4809 }
4810
4811 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004812 * Transform
4813 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 used += sizeof(ssl->transform->randbytes);
4815 if (used <= buf_len) {
4816 memcpy(p, ssl->transform->randbytes,
4817 sizeof(ssl->transform->randbytes));
4818 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004819 }
4820
4821#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004822 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004824 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004825 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004826 p += ssl->transform->in_cid_len;
4827
4828 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004830 p += ssl->transform->out_cid_len;
4831 }
4832#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4833
4834 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004835 * Saved fields from top-level ssl_context structure
4836 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004837 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004838 if (used <= buf_len) {
4839 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004840 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004841 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004842
4843#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4844 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 if (used <= buf_len) {
4846 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004847 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004848
Gilles Peskine449bd832023-01-11 14:50:10 +01004849 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004850 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004851 }
4852#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4853
4854#if defined(MBEDTLS_SSL_PROTO_DTLS)
4855 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004857 *p++ = ssl->disable_datagram_packing;
4858 }
4859#endif /* MBEDTLS_SSL_PROTO_DTLS */
4860
Jerry Yuae0b2e22021-10-08 15:21:19 +08004861 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004862 if (used <= buf_len) {
4863 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004864 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004865 }
4866
4867#if defined(MBEDTLS_SSL_PROTO_DTLS)
4868 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004869 if (used <= buf_len) {
4870 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004871 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004872 }
4873#endif /* MBEDTLS_SSL_PROTO_DTLS */
4874
4875#if defined(MBEDTLS_SSL_ALPN)
4876 {
4877 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004878 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004879 : 0;
4880
4881 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004883 *p++ = alpn_len;
4884
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 if (ssl->alpn_chosen != NULL) {
4886 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004887 p += alpn_len;
4888 }
4889 }
4890 }
4891#endif /* MBEDTLS_SSL_ALPN */
4892
4893 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004894 * Done
4895 */
4896 *olen = used;
4897
Gilles Peskine449bd832023-01-11 14:50:10 +01004898 if (used > buf_len) {
4899 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4900 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004901
Gilles Peskine449bd832023-01-11 14:50:10 +01004902 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004903
Gilles Peskine449bd832023-01-11 14:50:10 +01004904 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004905}
4906
4907/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004908 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004909 *
4910 * This internal version is wrapped by a public function that cleans up in
4911 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004912 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004913MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004914static int ssl_context_load(mbedtls_ssl_context *ssl,
4915 const unsigned char *buf,
4916 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004917{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004918 const unsigned char *p = buf;
4919 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004920 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004921 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004922#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004923 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004924#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004925
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004926 /*
4927 * The context should have been freshly setup or reset.
4928 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004929 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004930 * renegotiating, or if the user mistakenly loaded a session first.)
4931 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4933 ssl->session != NULL) {
4934 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004935 }
4936
4937 /*
4938 * We can't check that the config matches the initial one, but we can at
4939 * least check it matches the requirements for serializing.
4940 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004941 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004942#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004943 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004944#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004945 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4946 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4947 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4948 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004949 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004950 }
4951
Gilles Peskine449bd832023-01-11 14:50:10 +01004952 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004953
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004954 /*
4955 * Check version identifier
4956 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004957 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4958 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004959 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004960
4961 if (memcmp(p, ssl_serialized_context_header,
4962 sizeof(ssl_serialized_context_header)) != 0) {
4963 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4964 }
4965 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004966
4967 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004968 * Session
4969 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004970 if ((size_t) (end - p) < 4) {
4971 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4972 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004973
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004974 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004975 p += 4;
4976
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004977 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004978 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004979 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004980 ssl->session_in = ssl->session;
4981 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004982 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004983
Gilles Peskine449bd832023-01-11 14:50:10 +01004984 if ((size_t) (end - p) < session_len) {
4985 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4986 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004987
Gilles Peskine449bd832023-01-11 14:50:10 +01004988 ret = ssl_session_load(ssl->session, 1, p, session_len);
4989 if (ret != 0) {
4990 mbedtls_ssl_session_free(ssl->session);
4991 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004992 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004993
4994 p += session_len;
4995
4996 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004997 * Transform
4998 */
4999
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005000 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005001 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005002#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005003 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005004 ssl->transform_in = ssl->transform;
5005 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005006 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005007#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005008
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005009#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005010 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5011 if (prf_func == NULL) {
5012 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5013 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005014
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005015 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005016 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5017 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5018 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005019
Gilles Peskine449bd832023-01-11 14:50:10 +01005020 ret = ssl_tls12_populate_transform(ssl->transform,
5021 ssl->session->ciphersuite,
5022 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005023#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005024 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005025#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005026 prf_func,
5027 p, /* currently pointing to randbytes */
5028 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5029 ssl->conf->endpoint,
5030 ssl);
5031 if (ret != 0) {
5032 return ret;
5033 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005034#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005035 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005036
5037#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5038 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005039 if ((size_t) (end - p) < 1) {
5040 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5041 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005042
5043 ssl->transform->in_cid_len = *p++;
5044
Gilles Peskine449bd832023-01-11 14:50:10 +01005045 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5046 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5047 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005048
Gilles Peskine449bd832023-01-11 14:50:10 +01005049 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005050 p += ssl->transform->in_cid_len;
5051
5052 ssl->transform->out_cid_len = *p++;
5053
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5055 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5056 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005057
Gilles Peskine449bd832023-01-11 14:50:10 +01005058 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005059 p += ssl->transform->out_cid_len;
5060#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5061
5062 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005063 * Saved fields from top-level ssl_context structure
5064 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 if ((size_t) (end - p) < 4) {
5066 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5067 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005068
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005069 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005070 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005071
5072#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 if ((size_t) (end - p) < 16) {
5074 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5075 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005076
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005077 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005078 p += 8;
5079
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005080 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005081 p += 8;
5082#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5083
5084#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005085 if ((size_t) (end - p) < 1) {
5086 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5087 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005088
5089 ssl->disable_datagram_packing = *p++;
5090#endif /* MBEDTLS_SSL_PROTO_DTLS */
5091
Gilles Peskine449bd832023-01-11 14:50:10 +01005092 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5093 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5094 }
5095 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5096 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005097
5098#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005099 if ((size_t) (end - p) < 2) {
5100 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5101 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005102
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005103 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005104 p += 2;
5105#endif /* MBEDTLS_SSL_PROTO_DTLS */
5106
5107#if defined(MBEDTLS_SSL_ALPN)
5108 {
5109 uint8_t alpn_len;
Gilles Peskinec4949d12025-05-27 19:45:29 +02005110 const char *const *cur;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005111
Gilles Peskine449bd832023-01-11 14:50:10 +01005112 if ((size_t) (end - p) < 1) {
5113 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5114 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005115
5116 alpn_len = *p++;
5117
Gilles Peskine449bd832023-01-11 14:50:10 +01005118 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005119 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005120 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5121 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005122 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005123 ssl->alpn_chosen = *cur;
5124 break;
5125 }
5126 }
5127 }
5128
5129 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005130 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5131 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5132 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005133
5134 p += alpn_len;
5135 }
5136#endif /* MBEDTLS_SSL_ALPN */
5137
5138 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005139 * Forced fields from top-level ssl_context structure
5140 *
5141 * Most of them already set to the correct value by mbedtls_ssl_init() and
5142 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5143 */
Gilles Peskinef670ba52025-03-07 15:09:32 +01005144 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Glenn Strauss60bfe602022-03-14 19:04:24 -04005145 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005146
Hanno Becker361b10d2019-08-30 10:42:49 +01005147 /* Adjust pointers for header fields of outgoing records to
5148 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005149 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005150
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005151#if defined(MBEDTLS_SSL_PROTO_DTLS)
5152 ssl->in_epoch = 1;
5153#endif
5154
5155 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5156 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005157 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5158 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005159 if (ssl->handshake != NULL) {
5160 mbedtls_ssl_handshake_free(ssl);
5161 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005162 ssl->handshake = NULL;
5163 }
5164
5165 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005166 * Done - should have consumed entire buffer
5167 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 if (p != end) {
5169 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5170 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005171
Gilles Peskine449bd832023-01-11 14:50:10 +01005172 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005173}
5174
5175/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005176 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005177 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005178int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5179 const unsigned char *buf,
5180 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005181{
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005183
Gilles Peskine449bd832023-01-11 14:50:10 +01005184 if (ret != 0) {
5185 mbedtls_ssl_free(context);
5186 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005187
Gilles Peskine449bd832023-01-11 14:50:10 +01005188 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005189}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005190#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005191
5192/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005193 * Free an SSL context
5194 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005195void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005196{
Gilles Peskine449bd832023-01-11 14:50:10 +01005197 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005198 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005199 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005200
Gilles Peskine449bd832023-01-11 14:50:10 +01005201 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005202
Gilles Peskine449bd832023-01-11 14:50:10 +01005203 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005204#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5205 size_t out_buf_len = ssl->out_buf_len;
5206#else
5207 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5208#endif
5209
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005210 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005211 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005212 }
5213
Gilles Peskine449bd832023-01-11 14:50:10 +01005214 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005215#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5216 size_t in_buf_len = ssl->in_buf_len;
5217#else
5218 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5219#endif
5220
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005221 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005222 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005223 }
5224
Gilles Peskine449bd832023-01-11 14:50:10 +01005225 if (ssl->transform) {
5226 mbedtls_ssl_transform_free(ssl->transform);
5227 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005228 }
5229
Gilles Peskine449bd832023-01-11 14:50:10 +01005230 if (ssl->handshake) {
5231 mbedtls_ssl_handshake_free(ssl);
5232 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005233
5234#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005235 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5236 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005237#endif
5238
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 mbedtls_ssl_session_free(ssl->session_negotiate);
5240 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005241 }
5242
Ronald Cron6f135e12021-12-08 16:57:54 +01005243#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005244 mbedtls_ssl_transform_free(ssl->transform_application);
5245 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005246#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005247
Gilles Peskine449bd832023-01-11 14:50:10 +01005248 if (ssl->session) {
5249 mbedtls_ssl_session_free(ssl->session);
5250 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005251 }
5252
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005253#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine4ac40082025-02-20 18:13:58 +01005254 mbedtls_ssl_free_hostname(ssl);
Paul Bakker0be444a2013-08-27 21:55:01 +02005255#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005256
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005257#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005258 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005259#endif
5260
Gilles Peskine449bd832023-01-11 14:50:10 +01005261 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005262
Paul Bakker86f04f42013-02-14 11:20:09 +01005263 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005264 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005265}
5266
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005267/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005268 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005269 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005270void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005271{
Gilles Peskine449bd832023-01-11 14:50:10 +01005272 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005273}
5274
Gilles Peskineae270bf2021-06-02 00:05:29 +02005275/* The selection should be the same as mbedtls_x509_crt_profile_default in
5276 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005277 * curves with a lower resource usage come first.
Manuel Pégourié-Gonnard93d45912025-01-14 11:45:44 +01005278 * See the documentation of mbedtls_ssl_conf_groups() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005279 * about this list.
5280 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005281static const uint16_t ssl_preset_default_groups[] = {
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005282#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Brett Warrene0edc842021-08-17 09:53:13 +01005283 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005284#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005285#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005286 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005287#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005288#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005289 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005290#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005291#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Brett Warrene0edc842021-08-17 09:53:13 +01005292 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005293#endif
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005294#if defined(PSA_WANT_ECC_SECP_R1_521)
Brett Warrene0edc842021-08-17 09:53:13 +01005295 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005296#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005297#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005298 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005299#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005300#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005301 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005302#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005303#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Brett Warrene0edc842021-08-17 09:53:13 +01005304 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005305#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005306#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005307 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5308 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5309 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5310 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5311 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5312#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005313 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005314};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005315
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005316static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005317 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5318 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5319 0
5320};
5321
Ronald Crone68ab4f2022-10-05 12:46:29 +02005322#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005323
Jerry Yu909df7b2022-01-22 11:56:27 +08005324/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005325 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005326 * rules SHOULD be upheld.
5327 * - No duplicate entries.
5328 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005329 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005330 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005331 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005332static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005333
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005334#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005335 defined(PSA_WANT_ALG_SHA_256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005336 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005337 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005338 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5339#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005340
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005341#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005342 defined(PSA_WANT_ALG_SHA_384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005343 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005344 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005345 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5346#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005347
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005348#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Gabor Mezeic15ef932024-06-13 12:53:54 +02005349 defined(PSA_WANT_ALG_SHA_512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005350 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005351 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005352 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5353#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005354
Gabor Mezeic15ef932024-06-13 12:53:54 +02005355#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005356 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005357#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005358
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005359#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005360 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005361#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005362
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005363#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005364 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005365#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005366
Gabor Mezeic15ef932024-06-13 12:53:54 +02005367#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005368 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Gabor Mezeic15ef932024-06-13 12:53:54 +02005369#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005370
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005371#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005372 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005373#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005374
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005375#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005376 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005377#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005378
Gabor Mezei15b95a62022-05-09 16:37:58 +02005379 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005380};
5381
5382/* NOTICE: see above */
5383#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Deomid rojer Ryabkove2d71cc2024-03-18 12:32:30 +00005384static const uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005385
Gabor Mezeic15ef932024-06-13 12:53:54 +02005386#if defined(PSA_WANT_ALG_SHA_512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005387#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005389#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005390#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5391 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005392#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005393#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005394 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005395#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005396#endif /* PSA_WANT_ALG_SHA_512 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005397
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005398#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005399#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005400 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005401#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005402#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5403 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005404#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005405#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005406 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005407#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005408#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005409
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005410#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005411#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005412 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005413#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005414#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5415 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005416#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005417#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005418 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005419#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005420#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005421
Gabor Mezei15b95a62022-05-09 16:37:58 +02005422 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005423};
5424#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005425
Jerry Yu909df7b2022-01-22 11:56:27 +08005426/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005427static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005428
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005429#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005430 defined(PSA_WANT_ALG_SHA_256) && \
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005431 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005432 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005433 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5434#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005435
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005436#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005437 defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005438 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu53037892022-01-25 11:02:06 +08005439 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005440 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5441#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005442
Gabor Mezei15b95a62022-05-09 16:37:58 +02005443 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005444};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005445
Jerry Yu909df7b2022-01-22 11:56:27 +08005446/* NOTICE: see above */
5447#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Deomid rojer Ryabkov7dddc172024-03-20 00:43:34 +00005448static const uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005449
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005450#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005451#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005452 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005453#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005454#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005455
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005456#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005457#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005458 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005459#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005460#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005461
Gabor Mezei15b95a62022-05-09 16:37:58 +02005462 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005463};
Jerry Yu909df7b2022-01-22 11:56:27 +08005464#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5465
Ronald Crone68ab4f2022-10-05 12:46:29 +02005466#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005467
Chien Wong4e9683e2023-12-28 17:07:43 +08005468static const uint16_t ssl_preset_suiteb_groups[] = {
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005469#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005470 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005471#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005472#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005473 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005474#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005475 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005476};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005477
Ronald Crone68ab4f2022-10-05 12:46:29 +02005478#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005479/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005480 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005481MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005482static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005483{
5484 size_t i, j;
5485 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005486
Gilles Peskine449bd832023-01-11 14:50:10 +01005487 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5488 for (j = 0; j < i; j++) {
5489 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005490 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005491 }
5492 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5493 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5494 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005495 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005496 }
5497 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005499}
5500
Ronald Crone68ab4f2022-10-05 12:46:29 +02005501#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005502
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005503/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005504 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005505 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005506int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5507 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005508{
Ronald Crone68ab4f2022-10-05 12:46:29 +02005509#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005510 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5511 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5512 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005513 }
5514
Gilles Peskine449bd832023-01-11 14:50:10 +01005515 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5516 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5517 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005518 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005519
5520#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005521 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5522 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5523 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005524 }
5525
Gilles Peskine449bd832023-01-11 14:50:10 +01005526 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5527 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5528 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005529 }
5530#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005531#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005532
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005533 /* Use the functions here so that they are covered in tests,
5534 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005535 mbedtls_ssl_conf_endpoint(conf, endpoint);
5536 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005537
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005538 /*
5539 * Things that are common to all presets
5540 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005541#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005542 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005543 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5544#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5545 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5546#endif
5547 }
5548#endif
5549
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005550#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5551 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5552#endif
5553
5554#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5555 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5556#endif
5557
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005558#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005559 conf->f_cookie_write = ssl_cookie_write_dummy;
5560 conf->f_cookie_check = ssl_cookie_check_dummy;
5561#endif
5562
5563#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5564 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5565#endif
5566
Janos Follath088ce432017-04-10 12:42:31 +01005567#if defined(MBEDTLS_SSL_SRV_C)
5568 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005569 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005570#endif
5571
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005572#if defined(MBEDTLS_SSL_PROTO_DTLS)
5573 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5574 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5575#endif
5576
5577#if defined(MBEDTLS_SSL_RENEGOTIATION)
5578 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005579 memset(conf->renego_period, 0x00, 2);
5580 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005581#endif
5582
Ronald Cron6f135e12021-12-08 16:57:54 +01005583#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005584
5585#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005586 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005587#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005588 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005589#endif
5590#endif /* MBEDTLS_SSL_EARLY_DATA */
5591
Jerry Yud0766ec2022-09-22 10:46:57 +08005592#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005593 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005594 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005595#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005596 /*
5597 * Allow all TLS 1.3 key exchange modes by default.
5598 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005599 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005600#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005601
Gilles Peskine449bd832023-01-11 14:50:10 +01005602 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005603#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005604 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005605 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005606#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005607 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005608#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005609 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005610#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005611 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5612 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005613#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5614 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5615 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5616#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5617 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5618 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5619#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005620 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005621#endif
5622 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005623
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005624 /*
5625 * Preset-specific defaults
5626 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005627 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005628 /*
5629 * NSA Suite B
5630 */
5631 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005632
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005633 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005634
5635#if defined(MBEDTLS_X509_CRT_PARSE_C)
5636 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005637#endif
5638
Ronald Crone68ab4f2022-10-05 12:46:29 +02005639#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005640#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005641 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005642 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005643 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005644#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005645 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005646#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005647
Brett Warrene0edc842021-08-17 09:53:13 +01005648 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005649 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005650
5651 /*
5652 * Default
5653 */
5654 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005655
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005656 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005657
5658#if defined(MBEDTLS_X509_CRT_PARSE_C)
5659 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5660#endif
5661
Ronald Crone68ab4f2022-10-05 12:46:29 +02005662#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005663#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005664 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005665 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005666 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005667#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005668 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005669#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005670
Brett Warrene0edc842021-08-17 09:53:13 +01005671 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005672 }
5673
Gilles Peskine449bd832023-01-11 14:50:10 +01005674 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005675}
5676
5677/*
5678 * Free mbedtls_ssl_config
5679 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005680void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005681{
Troy-Butlerda73abc2024-04-02 13:37:31 -04005682 if (conf == NULL) {
5683 return;
5684 }
5685
Ronald Cron73fe8df2022-10-05 14:31:43 +02005686#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005687 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005688 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5689 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005690 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005691 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005692 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005693 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005694 }
5695
Gilles Peskine449bd832023-01-11 14:50:10 +01005696 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005697 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005698 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005699 conf->psk_identity_len = 0;
5700 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005701#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005702
5703#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005704 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005705#endif
5706
Gilles Peskine449bd832023-01-11 14:50:10 +01005707 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005708}
5709
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005710#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005711 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005712/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005713 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005714 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005715unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005716{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005717#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005718 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5719 return MBEDTLS_SSL_SIG_RSA;
5720 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005721#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005722#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005723 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5724 return MBEDTLS_SSL_SIG_ECDSA;
5725 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005726#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005728}
5729
Gilles Peskine449bd832023-01-11 14:50:10 +01005730unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005731{
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005733 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005734 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005735 case MBEDTLS_PK_ECDSA:
5736 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005738 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005739 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005740 }
5741}
5742
Gilles Peskine449bd832023-01-11 14:50:10 +01005743mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005744{
Gilles Peskine449bd832023-01-11 14:50:10 +01005745 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005746#if defined(MBEDTLS_RSA_C)
5747 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005748 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005749#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005750#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005751 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005752 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005753#endif
5754 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005755 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005756 }
5757}
Valerio Settie9646ec2023-08-02 20:02:28 +02005758#endif /* MBEDTLS_PK_C &&
5759 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005760
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005761/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005762 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005763 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005764mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005765{
Gilles Peskine449bd832023-01-11 14:50:10 +01005766 switch (hash) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005767#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005768 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005770#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005771#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005772 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005773 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005774#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005775#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005776 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005777 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005778#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005779#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005780 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005781 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005782#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005783#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005784 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005785 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005786#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005787#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005788 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005789 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005790#endif
5791 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005792 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005793 }
5794}
5795
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005796/*
5797 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5798 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005799unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005800{
Gilles Peskine449bd832023-01-11 14:50:10 +01005801 switch (md) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005802#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005803 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005804 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005805#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005806#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005807 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005808 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005809#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005810#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005811 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005812 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005813#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005814#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005815 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005816 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005817#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005818#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005819 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005820 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005821#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005822#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005823 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005824 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005825#endif
5826 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005827 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005828 }
5829}
5830
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005831/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005832 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005833 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005834 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005835int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005836{
Manuel Pégourié-Gonnard6402c352025-01-14 12:23:56 +01005837 const uint16_t *group_list = ssl->conf->group_list;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005838
Gilles Peskine449bd832023-01-11 14:50:10 +01005839 if (group_list == NULL) {
5840 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005841 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005842
Gilles Peskine449bd832023-01-11 14:50:10 +01005843 for (; *group_list != 0; group_list++) {
5844 if (*group_list == tls_id) {
5845 return 0;
5846 }
5847 }
5848
5849 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005850}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005851
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005852#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005853/*
5854 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5855 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005856int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005857{
Gilles Peskine449bd832023-01-11 14:50:10 +01005858 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005859
Gilles Peskine449bd832023-01-11 14:50:10 +01005860 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005861 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005862 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005863
Gilles Peskine449bd832023-01-11 14:50:10 +01005864 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005865}
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005866#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Valerio Setti67419f02023-01-04 16:12:42 +01005867
Valerio Setti18c9fed2022-12-30 17:44:24 +01005868static const struct {
5869 uint16_t tls_id;
5870 mbedtls_ecp_group_id ecp_group_id;
5871 psa_ecc_family_t psa_family;
5872 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005873} tls_id_match_table[] =
5874{
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005875#if defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02005876 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005877#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005878#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02005879 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005880#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005881#if defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005882 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005883#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005884#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005885 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005886#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005887#if defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005888 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005889#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005890#if defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005891 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005892#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005893#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005894 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005895#endif
Elena Uziunaiteeaa0cf02024-07-04 17:41:25 +01005896#if defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02005897 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005898#endif
Elena Uziunaitea3632862024-07-04 13:52:43 +01005899#if defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005900 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005901#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005902#if defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005903 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005904#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005905#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02005906 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005907#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005908#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005909 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005910#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005911 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005912};
5913
Gilles Peskine449bd832023-01-11 14:50:10 +01005914int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005915 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005916 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005917{
Gilles Peskine449bd832023-01-11 14:50:10 +01005918 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5919 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005920 if (type != NULL) {
5921 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005922 }
5923 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005924 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005925 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005926 return PSA_SUCCESS;
5927 }
5928 }
5929
5930 return PSA_ERROR_NOT_SUPPORTED;
5931}
5932
Gilles Peskine449bd832023-01-11 14:50:10 +01005933mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005934{
Gilles Peskine449bd832023-01-11 14:50:10 +01005935 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5936 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005937 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005939 }
5940
5941 return MBEDTLS_ECP_DP_NONE;
5942}
5943
Gilles Peskine449bd832023-01-11 14:50:10 +01005944uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005945{
Gilles Peskine449bd832023-01-11 14:50:10 +01005946 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5947 i++) {
5948 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005949 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005950 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005951 }
5952
5953 return 0;
5954}
5955
Valerio Setti67419f02023-01-04 16:12:42 +01005956#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005957static const struct {
5958 uint16_t tls_id;
5959 const char *name;
5960} tls_id_curve_name_table[] =
5961{
Valerio Setti54e23792023-07-07 10:49:27 +02005962 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5963 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5964 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5965 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5966 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5967 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5968 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5969 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5970 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5971 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5972 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5973 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5974 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005975 { 0, NULL },
5976};
5977
Gilles Peskine449bd832023-01-11 14:50:10 +01005978const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005979{
Valerio Settiacd32c02023-06-29 18:06:29 +02005980 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5981 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5982 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005983 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005984 }
5985
5986 return NULL;
5987}
Valerio Setti67419f02023-01-04 16:12:42 +01005988#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005989
Gilles Peskine449bd832023-01-11 14:50:10 +01005990int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5991 const mbedtls_md_type_t md,
5992 unsigned char *dst,
5993 size_t dst_len,
5994 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005995{
Ronald Cronf6893e12022-01-07 22:09:01 +01005996 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5997 psa_hash_operation_t *hash_operation_to_clone;
5998 psa_hash_operation_t hash_operation = psa_hash_operation_init();
5999
Jerry Yu148165c2021-09-24 23:20:59 +08006000 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006001
Gilles Peskine449bd832023-01-11 14:50:10 +01006002 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006003#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006004 case MBEDTLS_MD_SHA384:
6005 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6006 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006007#endif
6008
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006009#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006010 case MBEDTLS_MD_SHA256:
6011 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6012 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006013#endif
6014
Gilles Peskine449bd832023-01-11 14:50:10 +01006015 default:
6016 goto exit;
6017 }
6018
6019 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6020 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006021 goto exit;
6022 }
6023
Gilles Peskine449bd832023-01-11 14:50:10 +01006024 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6025 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006026 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006027 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006028
6029exit:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006030#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006031 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006032 (void) ssl;
6033#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006034 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006035}
Jerry Yu24c0ec32021-09-09 14:21:07 +08006036
Ronald Crone68ab4f2022-10-05 12:46:29 +02006037#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006038/* mbedtls_ssl_parse_sig_alg_ext()
6039 *
6040 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6041 * value (TLS 1.3 RFC8446):
6042 * enum {
6043 * ....
6044 * ecdsa_secp256r1_sha256( 0x0403 ),
6045 * ecdsa_secp384r1_sha384( 0x0503 ),
6046 * ecdsa_secp521r1_sha512( 0x0603 ),
6047 * ....
6048 * } SignatureScheme;
6049 *
6050 * struct {
6051 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6052 * } SignatureSchemeList;
6053 *
6054 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6055 * value (TLS 1.2 RFC5246):
6056 * enum {
6057 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6058 * sha512(6), (255)
6059 * } HashAlgorithm;
6060 *
6061 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6062 * SignatureAlgorithm;
6063 *
6064 * struct {
6065 * HashAlgorithm hash;
6066 * SignatureAlgorithm signature;
6067 * } SignatureAndHashAlgorithm;
6068 *
6069 * SignatureAndHashAlgorithm
6070 * supported_signature_algorithms<2..2^16-2>;
6071 *
6072 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6073 * generalization of the TLS 1.2 signature algorithm extension.
6074 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6075 * `SignatureScheme` field of TLS 1.3
6076 *
6077 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006078int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6079 const unsigned char *buf,
6080 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006081{
6082 const unsigned char *p = buf;
6083 size_t supported_sig_algs_len = 0;
6084 const unsigned char *supported_sig_algs_end;
6085 uint16_t sig_alg;
6086 uint32_t common_idx = 0;
6087
Gilles Peskine449bd832023-01-11 14:50:10 +01006088 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6089 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006090 p += 2;
6091
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 memset(ssl->handshake->received_sig_algs, 0,
6093 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006094
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006096 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 while (p < supported_sig_algs_end) {
6098 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6099 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006100 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6102 sig_alg,
6103 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006104#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6106 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6107 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006108 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006109 }
6110#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006111
Gilles Peskine449bd832023-01-11 14:50:10 +01006112 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6113 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006114
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006116 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6117 common_idx += 1;
6118 }
6119 }
6120 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006121 if (p != end) {
6122 MBEDTLS_SSL_DEBUG_MSG(1,
6123 ("Signature algorithms extension length misaligned"));
6124 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6125 MBEDTLS_ERR_SSL_DECODE_ERROR);
6126 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006127 }
6128
Gilles Peskine449bd832023-01-11 14:50:10 +01006129 if (common_idx == 0) {
6130 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6131 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6132 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6133 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006134 }
6135
Gabor Mezei15b95a62022-05-09 16:37:58 +02006136 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006137 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006138}
6139
Ronald Crone68ab4f2022-10-05 12:46:29 +02006140#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006141
Jerry Yudc7bd172022-02-17 13:44:15 +08006142#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6143
Jerry Yudc7bd172022-02-17 13:44:15 +08006144
Gilles Peskine449bd832023-01-11 14:50:10 +01006145static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6146 mbedtls_svc_key_id_t key,
6147 psa_algorithm_t alg,
6148 const unsigned char *raw_psk, size_t raw_psk_length,
6149 const unsigned char *seed, size_t seed_length,
6150 const unsigned char *label, size_t label_length,
6151 const unsigned char *other_secret,
6152 size_t other_secret_length,
6153 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006154{
6155 psa_status_t status;
6156
Gilles Peskine449bd832023-01-11 14:50:10 +01006157 status = psa_key_derivation_setup(derivation, alg);
6158 if (status != PSA_SUCCESS) {
6159 return status;
6160 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006161
Gilles Peskine449bd832023-01-11 14:50:10 +01006162 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6163 status = psa_key_derivation_input_bytes(derivation,
6164 PSA_KEY_DERIVATION_INPUT_SEED,
6165 seed, seed_length);
6166 if (status != PSA_SUCCESS) {
6167 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006168 }
6169
Gilles Peskine449bd832023-01-11 14:50:10 +01006170 if (other_secret != NULL) {
6171 status = psa_key_derivation_input_bytes(derivation,
6172 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6173 other_secret, other_secret_length);
6174 if (status != PSA_SUCCESS) {
6175 return status;
6176 }
6177 }
6178
6179 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006180 status = psa_key_derivation_input_bytes(
6181 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006182 raw_psk, raw_psk_length);
6183 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006184 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006185 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006186 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006187 if (status != PSA_SUCCESS) {
6188 return status;
6189 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006190
Gilles Peskine449bd832023-01-11 14:50:10 +01006191 status = psa_key_derivation_input_bytes(derivation,
6192 PSA_KEY_DERIVATION_INPUT_LABEL,
6193 label, label_length);
6194 if (status != PSA_SUCCESS) {
6195 return status;
6196 }
6197 } else {
6198 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006199 }
6200
Gilles Peskine449bd832023-01-11 14:50:10 +01006201 status = psa_key_derivation_set_capacity(derivation, capacity);
6202 if (status != PSA_SUCCESS) {
6203 return status;
6204 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006205
Gilles Peskine449bd832023-01-11 14:50:10 +01006206 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006207}
6208
Andrzej Kurek57d10632022-10-24 10:32:01 -04006209#if defined(PSA_WANT_ALG_SHA_384) || \
6210 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006211MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006212static int tls_prf_generic(mbedtls_md_type_t md_type,
6213 const unsigned char *secret, size_t slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006214 const char *label, size_t label_len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006215 const unsigned char *random, size_t rlen,
6216 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006217{
6218 psa_status_t status;
6219 psa_algorithm_t alg;
6220 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6221 psa_key_derivation_operation_t derivation =
6222 PSA_KEY_DERIVATION_OPERATION_INIT;
6223
Gilles Peskine449bd832023-01-11 14:50:10 +01006224 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006225 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006227 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006228 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006229
6230 /* Normally a "secret" should be long enough to be impossible to
6231 * find by brute force, and in particular should not be empty. But
6232 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6233 * and for this use case it makes sense to have a 0-length "secret".
6234 * Since the key API doesn't allow importing a key of length 0,
6235 * keep master_key=0, which setup_psa_key_derivation() understands
6236 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006237 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006238 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006239 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6240 psa_set_key_algorithm(&key_attributes, alg);
6241 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006242
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6244 if (status != PSA_SUCCESS) {
6245 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6246 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006247 }
6248
Gilles Peskine449bd832023-01-11 14:50:10 +01006249 status = setup_psa_key_derivation(&derivation,
6250 master_key, alg,
6251 NULL, 0,
6252 random, rlen,
6253 (unsigned char const *) label,
Max Fillingerf2dda152024-10-23 15:47:23 +02006254 label_len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006255 NULL, 0,
6256 dlen);
6257 if (status != PSA_SUCCESS) {
6258 psa_key_derivation_abort(&derivation);
6259 psa_destroy_key(master_key);
6260 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006261 }
6262
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6264 if (status != PSA_SUCCESS) {
6265 psa_key_derivation_abort(&derivation);
6266 psa_destroy_key(master_key);
6267 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006268 }
6269
Gilles Peskine449bd832023-01-11 14:50:10 +01006270 status = psa_key_derivation_abort(&derivation);
6271 if (status != PSA_SUCCESS) {
6272 psa_destroy_key(master_key);
6273 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006274 }
6275
Gilles Peskine449bd832023-01-11 14:50:10 +01006276 if (!mbedtls_svc_key_id_is_null(master_key)) {
6277 status = psa_destroy_key(master_key);
6278 }
6279 if (status != PSA_SUCCESS) {
6280 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6281 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006282
Gilles Peskine449bd832023-01-11 14:50:10 +01006283 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006284}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006285#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006286
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006287#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006288MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006289static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6290 const char *label,
6291 const unsigned char *random, size_t rlen,
6292 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006293{
Gilles Peskine449bd832023-01-11 14:50:10 +01006294 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006295 label, strlen(label), random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006296}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006297#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006298
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006299#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006300MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006301static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6302 const char *label,
6303 const unsigned char *random, size_t rlen,
6304 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006305{
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006307 label, strlen(label), random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006308}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006309#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006310
Jerry Yuf009d862022-02-17 14:01:37 +08006311/*
6312 * Set appropriate PRF function and other SSL / TLS1.2 functions
6313 *
6314 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006315 * - hash associated with the ciphersuite (only used by TLS 1.2)
6316 *
6317 * Outputs:
6318 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6319 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006320MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006321static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6322 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006323{
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006324#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006325 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006326 handshake->tls_prf = tls_prf_sha384;
6327 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6328 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006329 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006330#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006331#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuf009d862022-02-17 14:01:37 +08006332 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006333 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006334 handshake->tls_prf = tls_prf_sha256;
6335 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6336 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6337 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006338#else
Jerry Yuf009d862022-02-17 14:01:37 +08006339 {
Jerry Yuf009d862022-02-17 14:01:37 +08006340 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006341 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006342 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006343 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006344#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006345
Gilles Peskine449bd832023-01-11 14:50:10 +01006346 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006347}
Jerry Yud6ab2352022-02-17 14:03:43 +08006348
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006349/*
6350 * Compute master secret if needed
6351 *
6352 * Parameters:
6353 * [in/out] handshake
6354 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6355 * (PSA-PSK) ciphersuite_info, psk_opaque
6356 * [out] premaster (cleared)
6357 * [out] master
6358 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6359 * debug: conf->f_dbg, conf->p_dbg
6360 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006361 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006362 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006363MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006364static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6365 unsigned char *master,
6366 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006367{
6368 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6369
6370 /* cf. RFC 5246, Section 8.1:
6371 * "The master secret is always exactly 48 bytes in length." */
6372 size_t const master_secret_len = 48;
6373
6374#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6375 unsigned char session_hash[48];
6376#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6377
6378 /* The label for the KDF used for key expansion.
6379 * This is either "master secret" or "extended master secret"
6380 * depending on whether the Extended Master Secret extension
6381 * is used. */
6382 char const *lbl = "master secret";
6383
Przemek Stekielae4ed302022-04-05 17:15:55 +02006384 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006385 * - If the Extended Master Secret extension is not used,
6386 * this is ClientHello.Random + ServerHello.Random
6387 * (see Sect. 8.1 in RFC 5246).
6388 * - If the Extended Master Secret extension is used,
6389 * this is the transcript of the handshake so far.
6390 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006391 unsigned char const *seed = handshake->randbytes;
6392 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006393
6394#if !defined(MBEDTLS_DEBUG_C) && \
6395 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006396 !defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006397 ssl = NULL; /* make sure we don't use it except for those cases */
6398 (void) ssl;
6399#endif
6400
Gilles Peskine449bd832023-01-11 14:50:10 +01006401 if (handshake->resume != 0) {
6402 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6403 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006404 }
6405
6406#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006407 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006408 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006409 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006410 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6411 if (ret != 0) {
6412 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6413 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006414
Gilles Peskine449bd832023-01-11 14:50:10 +01006415 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6416 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006417 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006418#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006419
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006420#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006421 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006422 /* Perform PSK-to-MS expansion in a single step. */
6423 psa_status_t status;
6424 psa_algorithm_t alg;
6425 mbedtls_svc_key_id_t psk;
6426 psa_key_derivation_operation_t derivation =
6427 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006428 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006429
Gilles Peskine449bd832023-01-11 14:50:10 +01006430 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006431
Gilles Peskine449bd832023-01-11 14:50:10 +01006432 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006433
Gilles Peskine449bd832023-01-11 14:50:10 +01006434 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006435 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006437 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006439
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006440 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006441 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006442
Gilles Peskine449bd832023-01-11 14:50:10 +01006443 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006444 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006445 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006446 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006447 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006448 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
6449 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6450 other_secret = handshake->premaster + 2;
6451 break;
6452 default:
6453 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006454 }
6455
Gilles Peskine449bd832023-01-11 14:50:10 +01006456 status = setup_psa_key_derivation(&derivation, psk, alg,
6457 ssl->conf->psk, ssl->conf->psk_len,
6458 seed, seed_len,
6459 (unsigned char const *) lbl,
6460 (size_t) strlen(lbl),
6461 other_secret, other_secret_len,
6462 master_secret_len);
6463 if (status != PSA_SUCCESS) {
6464 psa_key_derivation_abort(&derivation);
6465 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006466 }
6467
Gilles Peskine449bd832023-01-11 14:50:10 +01006468 status = psa_key_derivation_output_bytes(&derivation,
6469 master,
6470 master_secret_len);
6471 if (status != PSA_SUCCESS) {
6472 psa_key_derivation_abort(&derivation);
6473 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006474 }
6475
Gilles Peskine449bd832023-01-11 14:50:10 +01006476 status = psa_key_derivation_abort(&derivation);
6477 if (status != PSA_SUCCESS) {
6478 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6479 }
6480 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006481#endif
6482 {
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006483#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006485 psa_status_t status;
6486 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6487 psa_key_derivation_operation_t derivation =
6488 PSA_KEY_DERIVATION_OPERATION_INIT;
6489
Gilles Peskine449bd832023-01-11 14:50:10 +01006490 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006491
6492 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6493
Gilles Peskine449bd832023-01-11 14:50:10 +01006494 status = psa_key_derivation_setup(&derivation, alg);
6495 if (status != PSA_SUCCESS) {
6496 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006497 }
6498
Gilles Peskine449bd832023-01-11 14:50:10 +01006499 status = psa_key_derivation_set_capacity(&derivation,
6500 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6501 if (status != PSA_SUCCESS) {
6502 psa_key_derivation_abort(&derivation);
6503 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006504 }
6505
Gilles Peskine449bd832023-01-11 14:50:10 +01006506 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6507 &derivation);
6508 if (status != PSA_SUCCESS) {
6509 psa_key_derivation_abort(&derivation);
6510 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006511 }
6512
Gilles Peskine449bd832023-01-11 14:50:10 +01006513 status = psa_key_derivation_output_bytes(&derivation,
6514 handshake->premaster,
6515 handshake->pmslen);
6516 if (status != PSA_SUCCESS) {
6517 psa_key_derivation_abort(&derivation);
6518 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6519 }
6520
6521 status = psa_key_derivation_abort(&derivation);
6522 if (status != PSA_SUCCESS) {
6523 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006524 }
6525 }
6526#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006527 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6528 lbl, seed, seed_len,
6529 master,
6530 master_secret_len);
6531 if (ret != 0) {
6532 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6533 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006534 }
6535
Gilles Peskine449bd832023-01-11 14:50:10 +01006536 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6537 handshake->premaster,
6538 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006539
Gilles Peskine449bd832023-01-11 14:50:10 +01006540 mbedtls_platform_zeroize(handshake->premaster,
6541 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006542 }
6543
Gilles Peskine449bd832023-01-11 14:50:10 +01006544 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006545}
6546
Gilles Peskine449bd832023-01-11 14:50:10 +01006547int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006548{
6549 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6550 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6551 ssl->handshake->ciphersuite_info;
6552
Gilles Peskine449bd832023-01-11 14:50:10 +01006553 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006554
6555 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006556 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006557 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006558 if (ret != 0) {
6559 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6560 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006561 }
6562
6563 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006564 ret = ssl_compute_master(ssl->handshake,
6565 ssl->session_negotiate->master,
6566 ssl);
6567 if (ret != 0) {
6568 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6569 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006570 }
6571
6572 /* Swap the client and server random values:
6573 * - MS derivation wanted client+server (RFC 5246 8.1)
6574 * - key derivation wants server+client (RFC 5246 6.3) */
6575 {
6576 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006577 memcpy(tmp, ssl->handshake->randbytes, 64);
6578 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6579 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6580 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006581 }
6582
6583 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006584 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6585 ssl->session_negotiate->ciphersuite,
6586 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006587#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006588 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006589#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006590 ssl->handshake->tls_prf,
6591 ssl->handshake->randbytes,
6592 ssl->tls_version,
6593 ssl->conf->endpoint,
6594 ssl);
6595 if (ret != 0) {
6596 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6597 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006598 }
6599
6600 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006601 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6602 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006603
Gilles Peskine449bd832023-01-11 14:50:10 +01006604 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006605
Gilles Peskine449bd832023-01-11 14:50:10 +01006606 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006607}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006608
Gilles Peskine449bd832023-01-11 14:50:10 +01006609int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006610{
Gilles Peskine449bd832023-01-11 14:50:10 +01006611 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006612#if defined(PSA_WANT_ALG_SHA_384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006613 case MBEDTLS_SSL_HASH_SHA384:
6614 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6615 break;
6616#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006617#if defined(PSA_WANT_ALG_SHA_256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006618 case MBEDTLS_SSL_HASH_SHA256:
6619 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6620 break;
6621#endif
6622 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006623 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006624 }
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006625#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006626 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006627 (void) ssl;
6628#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006629 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006630}
6631
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006632static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6633 const psa_hash_operation_t *hs_op,
6634 size_t buffer_size,
6635 unsigned char *hash,
6636 size_t *hlen)
6637{
6638 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006639 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006640
6641#if !defined(MBEDTLS_DEBUG_C)
6642 (void) ssl;
6643#endif
6644 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006645 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006646 if (status != PSA_SUCCESS) {
6647 goto exit;
6648 }
6649
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006650 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006651 if (status != PSA_SUCCESS) {
6652 goto exit;
6653 }
6654
6655 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6656 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6657
6658exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006659 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006660 return mbedtls_md_error_from_psa(status);
6661}
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006662
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006663#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006664int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6665 unsigned char *hash,
6666 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006667{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006668 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6669 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006670}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006671#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006672
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006673#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006674int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6675 unsigned char *hash,
6676 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006677{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006678 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6679 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006680}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006681#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006682
Jerry Yuc2c673d2022-02-17 14:20:39 +08006683#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006684MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006685static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006686
6687#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006688int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006689{
6690 /* If renegotiation is not enforced, retransmit until we would reach max
6691 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006692 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006693 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6694 unsigned char doublings = 1;
6695
Gilles Peskine449bd832023-01-11 14:50:10 +01006696 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006697 ++doublings;
6698 ratio >>= 1;
6699 }
6700
Gilles Peskine449bd832023-01-11 14:50:10 +01006701 if (++ssl->renego_records_seen > doublings) {
6702 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6703 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006704 }
6705 }
6706
Gilles Peskine449bd832023-01-11 14:50:10 +01006707 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006708}
6709#endif
6710#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006711
Jerry Yud9526692022-02-17 14:23:47 +08006712/*
6713 * Handshake functions
6714 */
6715#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6716/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006717int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006718{
6719 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6720 ssl->handshake->ciphersuite_info;
6721
Gilles Peskine449bd832023-01-11 14:50:10 +01006722 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006723
Gilles Peskine449bd832023-01-11 14:50:10 +01006724 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6725 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006726 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006727 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006728 }
6729
Gilles Peskine449bd832023-01-11 14:50:10 +01006730 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6731 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006732}
6733
Gilles Peskine449bd832023-01-11 14:50:10 +01006734int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006735{
6736 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6737 ssl->handshake->ciphersuite_info;
6738
Gilles Peskine449bd832023-01-11 14:50:10 +01006739 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006740
Gilles Peskine449bd832023-01-11 14:50:10 +01006741 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6742 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006743 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006744 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006745 }
6746
Gilles Peskine449bd832023-01-11 14:50:10 +01006747 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6748 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006749}
6750
6751#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6752/* Some certificate support -> implement write and parse */
6753
Gilles Peskine449bd832023-01-11 14:50:10 +01006754int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006755{
6756 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6757 size_t i, n;
6758 const mbedtls_x509_crt *crt;
6759 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6760 ssl->handshake->ciphersuite_info;
6761
Gilles Peskine449bd832023-01-11 14:50:10 +01006762 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006763
Gilles Peskine449bd832023-01-11 14:50:10 +01006764 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6765 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006766 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006767 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006768 }
6769
6770#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006771 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6772 if (ssl->handshake->client_auth == 0) {
6773 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006774 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006775 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006776 }
6777 }
6778#endif /* MBEDTLS_SSL_CLI_C */
6779#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006780 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6781 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006782 /* Should never happen because we shouldn't have picked the
6783 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006784 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006785 }
6786 }
6787#endif
6788
Gilles Peskine449bd832023-01-11 14:50:10 +01006789 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006790
6791 /*
6792 * 0 . 0 handshake type
6793 * 1 . 3 handshake length
6794 * 4 . 6 length of all certs
6795 * 7 . 9 length of cert. 1
6796 * 10 . n-1 peer certificate
6797 * n . n+2 length of cert. 2
6798 * n+3 . ... upper level cert, etc.
6799 */
6800 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006801 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006802
Gilles Peskine449bd832023-01-11 14:50:10 +01006803 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006804 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006805 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6806 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6807 " > %" MBEDTLS_PRINTF_SIZET,
6808 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6809 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006810 }
6811
Gilles Peskine449bd832023-01-11 14:50:10 +01006812 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6813 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6814 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006815
Gilles Peskine449bd832023-01-11 14:50:10 +01006816 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006817 i += n; crt = crt->next;
6818 }
6819
Gilles Peskine449bd832023-01-11 14:50:10 +01006820 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6821 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6822 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006823
6824 ssl->out_msglen = i;
6825 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6826 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6827
Gilles Peskinef670ba52025-03-07 15:09:32 +01006828 mbedtls_ssl_handshake_increment_state(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006829
Gilles Peskine449bd832023-01-11 14:50:10 +01006830 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
6831 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
6832 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006833 }
6834
Gilles Peskine449bd832023-01-11 14:50:10 +01006835 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006836
Gilles Peskine449bd832023-01-11 14:50:10 +01006837 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006838}
6839
6840#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6841
6842#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006843MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006844static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6845 unsigned char *crt_buf,
6846 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006847{
6848 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6849
Gilles Peskine449bd832023-01-11 14:50:10 +01006850 if (peer_crt == NULL) {
6851 return -1;
6852 }
Jerry Yud9526692022-02-17 14:23:47 +08006853
Gilles Peskine449bd832023-01-11 14:50:10 +01006854 if (peer_crt->raw.len != crt_buf_len) {
6855 return -1;
6856 }
Jerry Yud9526692022-02-17 14:23:47 +08006857
Gilles Peskine449bd832023-01-11 14:50:10 +01006858 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08006859}
6860#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006861MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006862static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6863 unsigned char *crt_buf,
6864 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006865{
6866 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6867 unsigned char const * const peer_cert_digest =
6868 ssl->session->peer_cert_digest;
6869 mbedtls_md_type_t const peer_cert_digest_type =
6870 ssl->session->peer_cert_digest_type;
6871 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01006872 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08006873 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6874 size_t digest_len;
6875
Gilles Peskine449bd832023-01-11 14:50:10 +01006876 if (peer_cert_digest == NULL || digest_info == NULL) {
6877 return -1;
6878 }
Jerry Yud9526692022-02-17 14:23:47 +08006879
Gilles Peskine449bd832023-01-11 14:50:10 +01006880 digest_len = mbedtls_md_get_size(digest_info);
6881 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
6882 return -1;
6883 }
Jerry Yud9526692022-02-17 14:23:47 +08006884
Gilles Peskine449bd832023-01-11 14:50:10 +01006885 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
6886 if (ret != 0) {
6887 return -1;
6888 }
Jerry Yud9526692022-02-17 14:23:47 +08006889
Gilles Peskine449bd832023-01-11 14:50:10 +01006890 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08006891}
6892#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6893#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6894
6895/*
6896 * Once the certificate message is read, parse it into a cert chain and
6897 * perform basic checks, but leave actual verification to the caller
6898 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006899MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006900static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
6901 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08006902{
6903 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6904#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006905 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08006906#endif
6907 size_t i, n;
6908 uint8_t alert;
6909
Gilles Peskine449bd832023-01-11 14:50:10 +01006910 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
6911 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6912 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6913 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6914 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006915 }
6916
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
6918 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6919 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6920 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006921 }
6922
Gilles Peskine449bd832023-01-11 14:50:10 +01006923 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
6924 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6925 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6926 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6927 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006928 }
6929
Gilles Peskine449bd832023-01-11 14:50:10 +01006930 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006931
6932 /*
6933 * Same message structure as in mbedtls_ssl_write_certificate()
6934 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006935 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006936
Gilles Peskine449bd832023-01-11 14:50:10 +01006937 if (ssl->in_msg[i] != 0 ||
6938 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
6939 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6940 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6941 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6942 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006943 }
6944
6945 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6946 i += 3;
6947
6948 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006949 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08006950 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006951 if (i + 3 > ssl->in_hslen) {
6952 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6953 mbedtls_ssl_send_alert_message(ssl,
6954 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6955 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6956 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006957 }
6958 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6959 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006960 if (ssl->in_msg[i] != 0) {
6961 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6962 mbedtls_ssl_send_alert_message(ssl,
6963 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6964 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
6965 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08006966 }
6967
6968 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006969 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006970 i += 3;
6971
Gilles Peskine449bd832023-01-11 14:50:10 +01006972 if (n < 128 || i + n > ssl->in_hslen) {
6973 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6974 mbedtls_ssl_send_alert_message(ssl,
6975 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6976 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6977 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006978 }
6979
6980 /* Check if we're handling the first CRT in the chain. */
6981#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006982 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08006983 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01006984 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08006985 /* During client-side renegotiation, check that the server's
6986 * end-CRTs hasn't changed compared to the initial handshake,
6987 * mitigating the triple handshake attack. On success, reuse
6988 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006989 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
6990 if (ssl_check_peer_crt_unchanged(ssl,
6991 &ssl->in_msg[i],
6992 n) != 0) {
6993 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
6994 mbedtls_ssl_send_alert_message(ssl,
6995 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6996 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
6997 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08006998 }
6999
7000 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007002 }
7003#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7004
7005 /* Parse the next certificate in the chain. */
7006#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007007 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007008#else
7009 /* If we don't need to store the CRT chain permanently, parse
7010 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007011 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007012#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007013 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007014 case 0: /*ok*/
Gilles Peskine4c832212025-05-07 23:05:12 +02007015 case MBEDTLS_ERR_X509_UNKNOWN_OID:
Jerry Yud9526692022-02-17 14:23:47 +08007016 /* Ignore certificate with an unknown algorithm: maybe a
7017 prior certificate was already trusted. */
7018 break;
7019
7020 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7021 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7022 goto crt_parse_der_failed;
7023
7024 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7025 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7026 goto crt_parse_der_failed;
7027
7028 default:
7029 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007030crt_parse_der_failed:
7031 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7032 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7033 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007034 }
7035
7036 i += n;
7037 }
7038
Gilles Peskine449bd832023-01-11 14:50:10 +01007039 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7040 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007041}
7042
7043#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007044MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007045static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007046{
Gilles Peskine449bd832023-01-11 14:50:10 +01007047 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7048 return -1;
7049 }
Jerry Yud9526692022-02-17 14:23:47 +08007050
Gilles Peskine449bd832023-01-11 14:50:10 +01007051 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007052 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7053 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007054 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7055 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7056 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007057 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007058 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007059}
7060#endif /* MBEDTLS_SSL_SRV_C */
7061
7062/* Check if a certificate message is expected.
7063 * Return either
7064 * - SSL_CERTIFICATE_EXPECTED, or
7065 * - SSL_CERTIFICATE_SKIP
7066 * indicating whether a Certificate message is expected or not.
7067 */
7068#define SSL_CERTIFICATE_EXPECTED 0
7069#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007070MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007071static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7072 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007073{
7074 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7075 ssl->handshake->ciphersuite_info;
7076
Gilles Peskine449bd832023-01-11 14:50:10 +01007077 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7078 return SSL_CERTIFICATE_SKIP;
7079 }
Jerry Yud9526692022-02-17 14:23:47 +08007080
7081#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007082 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007083 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007084 ssl->session_negotiate->verify_result =
7085 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007086 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007087 }
7088 }
7089#else
7090 ((void) authmode);
7091#endif /* MBEDTLS_SSL_SRV_C */
7092
Gilles Peskine449bd832023-01-11 14:50:10 +01007093 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007094}
7095
Jerry Yud9526692022-02-17 14:23:47 +08007096#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007097MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007098static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7099 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007100{
7101 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7102 /* Remember digest of the peer's end-CRT. */
7103 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007104 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7105 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7106 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7107 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7108 mbedtls_ssl_send_alert_message(ssl,
7109 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7110 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007111
Gilles Peskine449bd832023-01-11 14:50:10 +01007112 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007113 }
7114
Gilles Peskine449bd832023-01-11 14:50:10 +01007115 ret = mbedtls_md(mbedtls_md_info_from_type(
7116 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7117 start, len,
7118 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007119
7120 ssl->session_negotiate->peer_cert_digest_type =
7121 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7122 ssl->session_negotiate->peer_cert_digest_len =
7123 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7124
Gilles Peskine449bd832023-01-11 14:50:10 +01007125 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007126}
7127
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007128MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007129static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7130 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007131{
7132 unsigned char *end = start + len;
7133 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7134
7135 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007136 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7137 ret = mbedtls_pk_parse_subpubkey(&start, end,
7138 &ssl->handshake->peer_pubkey);
7139 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007140 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007141 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007142 }
7143
Gilles Peskine449bd832023-01-11 14:50:10 +01007144 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007145}
7146#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7147
Gilles Peskine449bd832023-01-11 14:50:10 +01007148int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007149{
7150 int ret = 0;
7151 int crt_expected;
Manuel Pégourié-Gonnard58ab9ba2024-08-14 09:47:38 +02007152 /* Authmode: precedence order is SNI if used else configuration */
Jerry Yud9526692022-02-17 14:23:47 +08007153#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7154 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7155 ? ssl->handshake->sni_authmode
7156 : ssl->conf->authmode;
7157#else
7158 const int authmode = ssl->conf->authmode;
7159#endif
7160 void *rs_ctx = NULL;
7161 mbedtls_x509_crt *chain = NULL;
7162
Gilles Peskine449bd832023-01-11 14:50:10 +01007163 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007164
Gilles Peskine449bd832023-01-11 14:50:10 +01007165 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7166 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7167 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007168 goto exit;
7169 }
7170
7171#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007172 if (ssl->handshake->ecrs_enabled &&
7173 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007174 chain = ssl->handshake->ecrs_peer_cert;
7175 ssl->handshake->ecrs_peer_cert = NULL;
7176 goto crt_verify;
7177 }
7178#endif
7179
Gilles Peskine449bd832023-01-11 14:50:10 +01007180 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007181 /* mbedtls_ssl_read_record may have sent an alert already. We
7182 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007183 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007184 goto exit;
7185 }
7186
7187#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007188 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007189 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7190
Gilles Peskine449bd832023-01-11 14:50:10 +01007191 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007192 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007193 }
Jerry Yud9526692022-02-17 14:23:47 +08007194
7195 goto exit;
7196 }
7197#endif /* MBEDTLS_SSL_SRV_C */
7198
7199 /* Clear existing peer CRT structure in case we tried to
7200 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007201 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007202
Gilles Peskine449bd832023-01-11 14:50:10 +01007203 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7204 if (chain == NULL) {
7205 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7206 sizeof(mbedtls_x509_crt)));
7207 mbedtls_ssl_send_alert_message(ssl,
7208 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7209 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007210
7211 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7212 goto exit;
7213 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007214 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007215
Gilles Peskine449bd832023-01-11 14:50:10 +01007216 ret = ssl_parse_certificate_chain(ssl, chain);
7217 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007218 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007219 }
Jerry Yud9526692022-02-17 14:23:47 +08007220
7221#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007222 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007223 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007224 }
Jerry Yud9526692022-02-17 14:23:47 +08007225
7226crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007227 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007228 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007229 }
Jerry Yud9526692022-02-17 14:23:47 +08007230#endif
7231
Manuel Pégourié-Gonnard19dd9f52024-08-16 11:03:42 +02007232 ret = mbedtls_ssl_verify_certificate(ssl, authmode, chain,
7233 ssl->handshake->ciphersuite_info,
7234 rs_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +01007235 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007236 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007237 }
Jerry Yud9526692022-02-17 14:23:47 +08007238
7239#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7240 {
7241 unsigned char *crt_start, *pk_start;
7242 size_t crt_len, pk_len;
7243
7244 /* We parse the CRT chain without copying, so
7245 * these pointers point into the input buffer,
7246 * and are hence still valid after freeing the
7247 * CRT chain. */
7248
7249 crt_start = chain->raw.p;
7250 crt_len = chain->raw.len;
7251
7252 pk_start = chain->pk_raw.p;
7253 pk_len = chain->pk_raw.len;
7254
7255 /* Free the CRT structures before computing
7256 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007257 mbedtls_x509_crt_free(chain);
7258 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007259 chain = NULL;
7260
Gilles Peskine449bd832023-01-11 14:50:10 +01007261 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7262 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007263 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007264 }
Jerry Yud9526692022-02-17 14:23:47 +08007265
Gilles Peskine449bd832023-01-11 14:50:10 +01007266 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7267 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007268 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007269 }
Jerry Yud9526692022-02-17 14:23:47 +08007270 }
7271#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7272 /* Pass ownership to session structure. */
7273 ssl->session_negotiate->peer_cert = chain;
7274 chain = NULL;
7275#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7276
Gilles Peskine449bd832023-01-11 14:50:10 +01007277 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007278
7279exit:
7280
Gilles Peskine449bd832023-01-11 14:50:10 +01007281 if (ret == 0) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007282 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007283 }
Jerry Yud9526692022-02-17 14:23:47 +08007284
7285#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007286 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007287 ssl->handshake->ecrs_peer_cert = chain;
7288 chain = NULL;
7289 }
7290#endif
7291
Gilles Peskine449bd832023-01-11 14:50:10 +01007292 if (chain != NULL) {
7293 mbedtls_x509_crt_free(chain);
7294 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007295 }
7296
Gilles Peskine449bd832023-01-11 14:50:10 +01007297 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007298}
7299#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7300
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007301static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7302 unsigned char *padbuf, size_t hlen,
7303 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007304{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007305 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007306 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007307 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007308 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007309 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007310 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007311
7312 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007313 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007314 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007315 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007316
Gilles Peskine449bd832023-01-11 14:50:10 +01007317 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007318 ? "client finished"
7319 : "server finished";
7320
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007321 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007322
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007323 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007324 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007325 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007326 }
7327
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007328 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007329 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007330 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007331 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007332 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007333
7334 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7335
Jerry Yu615bd6f2022-02-17 14:25:15 +08007336 /*
7337 * TLSv1.2:
7338 * hash = PRF( master, finished_label,
7339 * Hash( handshake ) )[0.11]
7340 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007341 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007342 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007343
Gilles Peskine449bd832023-01-11 14:50:10 +01007344 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007345
Paul Elliottecb95be2023-08-11 16:41:04 +01007346 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007347
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007348 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007349
7350exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007351 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007352 return mbedtls_md_error_from_psa(status);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007353}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007354
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007355#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007356static int ssl_calc_finished_tls_sha256(
7357 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7358{
7359 unsigned char padbuf[32];
7360 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007361 &ssl->handshake->fin_sha256_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007362 padbuf, sizeof(padbuf),
7363 buf, from);
7364}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007365#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007366
Jerry Yub7ba49e2022-02-17 14:25:53 +08007367
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007368#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007369static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007370 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007371{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007372 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007373 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007374 &ssl->handshake->fin_sha384_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007375 padbuf, sizeof(padbuf),
7376 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007377}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007378#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007379
Gilles Peskine449bd832023-01-11 14:50:10 +01007380void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007381{
Gilles Peskine449bd832023-01-11 14:50:10 +01007382 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007383
7384 /*
7385 * Free our handshake params
7386 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007387 mbedtls_ssl_handshake_free(ssl);
7388 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007389 ssl->handshake = NULL;
7390
7391 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007392 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007393 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007394 if (ssl->transform) {
7395 mbedtls_ssl_transform_free(ssl->transform);
7396 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007397 }
7398 ssl->transform = ssl->transform_negotiate;
7399 ssl->transform_negotiate = NULL;
7400
Gilles Peskine449bd832023-01-11 14:50:10 +01007401 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007402}
7403
Gilles Peskine449bd832023-01-11 14:50:10 +01007404void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007405{
7406 int resume = ssl->handshake->resume;
7407
Gilles Peskine449bd832023-01-11 14:50:10 +01007408 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007409
7410#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007411 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007412 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7413 ssl->renego_records_seen = 0;
7414 }
7415#endif
7416
7417 /*
7418 * Free the previous session and switch in the current one
7419 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007420 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007421#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7422 /* RFC 7366 3.1: keep the EtM state */
7423 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007424 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007425#endif
7426
Gilles Peskine449bd832023-01-11 14:50:10 +01007427 mbedtls_ssl_session_free(ssl->session);
7428 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007429 }
7430 ssl->session = ssl->session_negotiate;
7431 ssl->session_negotiate = NULL;
7432
7433 /*
7434 * Add cache entry
7435 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007436 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007437 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007438 resume == 0) {
7439 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7440 ssl->session->id,
7441 ssl->session->id_len,
7442 ssl->session) != 0) {
7443 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7444 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007445 }
7446
7447#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007448 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7449 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007450 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007451 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007452
7453 /* Keep last flight around in case we need to resend it:
7454 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007455 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7456 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007457#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007459
Gilles Peskinef670ba52025-03-07 15:09:32 +01007460 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007461
Gilles Peskine449bd832023-01-11 14:50:10 +01007462 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007463}
7464
Gilles Peskine449bd832023-01-11 14:50:10 +01007465int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007466{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007467 int ret;
7468 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007469
Gilles Peskine449bd832023-01-11 14:50:10 +01007470 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007471
Gilles Peskine449bd832023-01-11 14:50:10 +01007472 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007473
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007474 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7475 if (ret != 0) {
7476 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
David Horstmann816b7122025-03-07 17:20:59 +00007477 return ret;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007478 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007479
7480 /*
7481 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7482 * may define some other value. Currently (early 2016), no defined
7483 * ciphersuite does this (and this is unlikely to change as activity has
7484 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7485 */
7486 hash_len = 12;
7487
7488#if defined(MBEDTLS_SSL_RENEGOTIATION)
7489 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007490 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007491#endif
7492
7493 ssl->out_msglen = 4 + hash_len;
7494 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7495 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7496
7497 /*
7498 * In case of session resuming, invert the client and server
7499 * ChangeCipherSpec messages order.
7500 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007501 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007502#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007503 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007504 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007506#endif
7507#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007509 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC);
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007511#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007512 } else {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007513 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007514 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007515
7516 /*
7517 * Switch to our negotiated transform and session parameters for outbound
7518 * data.
7519 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007520 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007521
7522#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007523 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007524 unsigned char i;
7525
7526 /* Remember current epoch settings for resending */
7527 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007528 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7529 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007530
7531 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007532 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007533
7534
7535 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007536 for (i = 2; i > 0; i--) {
7537 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007538 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007539 }
7540 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007541
7542 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 if (i == 0) {
7544 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7545 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007546 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007547 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007548#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007549 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007550
7551 ssl->transform_out = ssl->transform_negotiate;
7552 ssl->session_out = ssl->session_negotiate;
7553
7554#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007555 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7556 mbedtls_ssl_send_flight_completed(ssl);
7557 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007558#endif
7559
Gilles Peskine449bd832023-01-11 14:50:10 +01007560 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7561 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7562 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007563 }
7564
7565#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007566 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7567 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7568 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7569 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007570 }
7571#endif
7572
Gilles Peskine449bd832023-01-11 14:50:10 +01007573 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007574
Gilles Peskine449bd832023-01-11 14:50:10 +01007575 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007576}
7577
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007578#define SSL_MAX_HASH_LEN 12
7579
Gilles Peskine449bd832023-01-11 14:50:10 +01007580int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007581{
7582 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7583 unsigned int hash_len = 12;
7584 unsigned char buf[SSL_MAX_HASH_LEN];
7585
Gilles Peskine449bd832023-01-11 14:50:10 +01007586 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007587
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007588 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7589 if (ret != 0) {
7590 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
David Horstmann816b7122025-03-07 17:20:59 +00007591 return ret;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007592 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007593
Gilles Peskine449bd832023-01-11 14:50:10 +01007594 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7595 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007596 goto exit;
7597 }
7598
Gilles Peskine449bd832023-01-11 14:50:10 +01007599 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7600 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7601 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7602 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007603 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7604 goto exit;
7605 }
7606
Gilles Peskine449bd832023-01-11 14:50:10 +01007607 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
7608 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7609 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007610 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7611 goto exit;
7612 }
7613
Gilles Peskine449bd832023-01-11 14:50:10 +01007614 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
7615 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7616 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7617 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007618 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7619 goto exit;
7620 }
7621
Gilles Peskine449bd832023-01-11 14:50:10 +01007622 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
7623 buf, hash_len) != 0) {
7624 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7625 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7626 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007627 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7628 goto exit;
7629 }
7630
7631#if defined(MBEDTLS_SSL_RENEGOTIATION)
7632 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007633 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007634#endif
7635
Gilles Peskine449bd832023-01-11 14:50:10 +01007636 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007637#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007638 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007639 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC);
Gilles Peskine449bd832023-01-11 14:50:10 +01007640 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007641#endif
7642#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007643 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007644 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
Gilles Peskine449bd832023-01-11 14:50:10 +01007645 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007646#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007647 } else {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007648 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007649 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007650
7651#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007652 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7653 mbedtls_ssl_recv_flight_completed(ssl);
7654 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007655#endif
7656
Gilles Peskine449bd832023-01-11 14:50:10 +01007657 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007658
7659exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007660 mbedtls_platform_zeroize(buf, hash_len);
7661 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007662}
7663
Jerry Yu392112c2022-02-17 14:34:10 +08007664#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7665/*
7666 * Helper to get TLS 1.2 PRF from ciphersuite
7667 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7668 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007669static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08007670{
Jerry Yu392112c2022-02-17 14:34:10 +08007671 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007672 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007673#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007674 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
7675 return tls_prf_sha384;
7676 } else
Jerry Yu392112c2022-02-17 14:34:10 +08007677#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007678#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007679 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007680 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
7681 return tls_prf_sha256;
7682 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04007683 }
7684#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007685#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007686 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007687 (void) ciphersuite_info;
7688#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007689
Gilles Peskine449bd832023-01-11 14:50:10 +01007690 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08007691}
7692#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007693
Gilles Peskine449bd832023-01-11 14:50:10 +01007694static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007695{
7696 ((void) tls_prf);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007697#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007698 if (tls_prf == tls_prf_sha384) {
7699 return MBEDTLS_SSL_TLS_PRF_SHA384;
7700 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007701#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007702#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01007703 if (tls_prf == tls_prf_sha256) {
7704 return MBEDTLS_SSL_TLS_PRF_SHA256;
7705 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007706#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007707 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08007708}
7709
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007710/*
7711 * Populate a transform structure with session keys and all the other
7712 * necessary information.
7713 *
7714 * Parameters:
7715 * - [in/out]: transform: structure to populate
7716 * [in] must be just initialised with mbedtls_ssl_transform_init()
7717 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7718 * - [in] ciphersuite
7719 * - [in] master
7720 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007721 * - [in] tls_prf: pointer to PRF to use for key derivation
7722 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007723 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007724 * - [in] endpoint: client or server
7725 * - [in] ssl: used for:
7726 * - ssl->conf->{f,p}_export_keys
7727 * [in] optionally used for:
7728 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7729 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007730MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007731static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
7732 int ciphersuite,
7733 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007734#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007735 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007736#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007737 ssl_tls_prf_t tls_prf,
7738 const unsigned char randbytes[64],
7739 mbedtls_ssl_protocol_version tls_version,
7740 unsigned endpoint,
7741 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007742{
7743 int ret = 0;
7744 unsigned char keyblk[256];
7745 unsigned char *key1;
7746 unsigned char *key2;
7747 unsigned char *mac_enc;
7748 unsigned char *mac_dec;
7749 size_t mac_key_len = 0;
7750 size_t iv_copy_len;
7751 size_t keylen;
7752 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007753 mbedtls_ssl_mode_t ssl_mode;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007754
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007755 psa_key_type_t key_type;
7756 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7757 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007758 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007759 size_t key_bits;
7760 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007761
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007762 /*
7763 * Some data just needs copying into the structure
7764 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007765#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007766 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007767#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007768 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007769
Max Fillinger2fe35f62024-10-25 00:52:24 +02007770#if defined(MBEDTLS_SSL_KEEP_RANDBYTES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007771 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007772#endif
7773
7774#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01007775 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007776 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7777 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007778 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007779 }
7780#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7781
7782 /*
7783 * Get various info structures
7784 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007785 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
7786 if (ciphersuite_info == NULL) {
7787 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
7788 ciphersuite));
7789 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007790 }
7791
Neil Armstrongab555e02022-04-04 11:07:59 +02007792 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007793#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007794 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007795#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007796 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007797
Gilles Peskine449bd832023-01-11 14:50:10 +01007798 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007799 transform->taglen =
7800 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01007801 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007802
Dave Rodgman2eab4622023-10-05 13:30:37 +01007803 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01007804 transform->taglen,
7805 &alg,
7806 &key_type,
7807 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007808 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007809 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007810 goto end;
7811 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007812
Dave Rodgman2eab4622023-10-05 13:30:37 +01007813 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007814 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02007815 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01007816 (unsigned) ciphersuite_info->mac));
7817 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01007818 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007819
7820#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7821 /* Copy own and peer's CID if the use of the CID
7822 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007823 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
7824 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007825
7826 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007827 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
7828 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
7829 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007830
7831 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007832 memcpy(transform->out_cid, ssl->handshake->peer_cid,
7833 ssl->handshake->peer_cid_len);
7834 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
7835 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007836 }
7837#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7838
7839 /*
7840 * Compute key block using the PRF
7841 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007842 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
7843 if (ret != 0) {
7844 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7845 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007846 }
7847
Gilles Peskine449bd832023-01-11 14:50:10 +01007848 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
7849 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
7850 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
7851 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
7852 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007853
7854 /*
7855 * Determine the appropriate key, IV and MAC length.
7856 */
7857
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007858 keylen = PSA_BITS_TO_BYTES(key_bits);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007859
Valerio Settie5707042023-10-11 11:54:42 +02007860#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01007861 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007862 size_t explicit_ivlen;
7863
7864 transform->maclen = 0;
7865 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007866
7867 /* All modes haves 96-bit IVs, but the length of the static parts vary
7868 * with mode and version:
7869 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7870 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7871 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7872 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7873 * sequence number).
7874 */
7875 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01007876
7877 int is_chachapoly = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007878 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
David Horstmann3b2276a2022-10-06 14:49:08 +01007879
Gilles Peskine449bd832023-01-11 14:50:10 +01007880 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007881 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01007882 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007883 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01007884 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007885
7886 /* Minimum length of encrypted record */
7887 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7888 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007889 } else
Valerio Settie5707042023-10-11 11:54:42 +02007890#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007891#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007892 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007893 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01007894 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007895 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007896
Neil Armstronge4512952022-03-08 09:08:22 +01007897 /* Get MAC length */
7898 mac_key_len = PSA_HASH_LENGTH(mac_alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007899 transform->maclen = mac_key_len;
7900
7901 /* IV length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007902 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007903
7904 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007905 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007906 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007907 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007908 /*
7909 * GenericBlockCipher:
7910 * 1. if EtM is in use: one block plus MAC
7911 * otherwise: * first multiple of blocklen greater than maclen
7912 * 2. IV
7913 */
7914#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007915 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007916 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007917 + block_size;
7918 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007919#endif
7920 {
7921 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007922 + block_size
7923 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007924 }
7925
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007927 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007928 } else {
7929 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007930 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7931 goto end;
7932 }
7933 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007934 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007935#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7936 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007937 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7938 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007939 }
7940
Gilles Peskine449bd832023-01-11 14:50:10 +01007941 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7942 (unsigned) keylen,
7943 (unsigned) transform->minlen,
7944 (unsigned) transform->ivlen,
7945 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007946
7947 /*
7948 * Finally setup the cipher contexts, IVs and MAC secrets.
7949 */
7950#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007951 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007952 key1 = keyblk + mac_key_len * 2;
7953 key2 = keyblk + mac_key_len * 2 + keylen;
7954
7955 mac_enc = keyblk;
7956 mac_dec = keyblk + mac_key_len;
7957
Gilles Peskine449bd832023-01-11 14:50:10 +01007958 iv_copy_len = (transform->fixed_ivlen) ?
7959 transform->fixed_ivlen : transform->ivlen;
7960 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
7961 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
7962 iv_copy_len);
7963 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007964#endif /* MBEDTLS_SSL_CLI_C */
7965#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007966 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007967 key1 = keyblk + mac_key_len * 2 + keylen;
7968 key2 = keyblk + mac_key_len * 2;
7969
7970 mac_enc = keyblk + mac_key_len;
7971 mac_dec = keyblk;
7972
Gilles Peskine449bd832023-01-11 14:50:10 +01007973 iv_copy_len = (transform->fixed_ivlen) ?
7974 transform->fixed_ivlen : transform->ivlen;
7975 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
7976 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
7977 iv_copy_len);
7978 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007979#endif /* MBEDTLS_SSL_SRV_C */
7980 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007981 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007982 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7983 goto end;
7984 }
7985
Paul Elliott4fb19552023-10-18 12:15:30 +01007986 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007987 ssl->f_export_keys(ssl->p_export_keys,
7988 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7989 master, 48,
7990 randbytes + 32,
7991 randbytes,
7992 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007993 }
7994
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007995 transform->psa_alg = alg;
7996
Gilles Peskine449bd832023-01-11 14:50:10 +01007997 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
7998 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
7999 psa_set_key_algorithm(&attributes, alg);
8000 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008001
Gilles Peskine449bd832023-01-11 14:50:10 +01008002 if ((status = psa_import_key(&attributes,
8003 key1,
8004 PSA_BITS_TO_BYTES(key_bits),
8005 &transform->psa_key_enc)) != PSA_SUCCESS) {
8006 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008007 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008008 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008009 goto end;
8010 }
8011
Gilles Peskine449bd832023-01-11 14:50:10 +01008012 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008013
Gilles Peskine449bd832023-01-11 14:50:10 +01008014 if ((status = psa_import_key(&attributes,
8015 key2,
8016 PSA_BITS_TO_BYTES(key_bits),
8017 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008018 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008019 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008020 goto end;
8021 }
8022 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008023
Neil Armstrong29c0c042022-03-17 17:47:28 +01008024#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8025 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8026 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008027 if (mac_key_len != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008028 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008029
Gilles Peskine449bd832023-01-11 14:50:10 +01008030 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8031 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8032 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008033
Gilles Peskine449bd832023-01-11 14:50:10 +01008034 if ((status = psa_import_key(&attributes,
8035 mac_enc, mac_key_len,
8036 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008037 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008038 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008039 goto end;
8040 }
8041
Gilles Peskine449bd832023-01-11 14:50:10 +01008042 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8043 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008044#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008045 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008046#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008047 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008048 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008049 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8050 PSA_KEY_USAGE_VERIFY_HASH);
8051 } else {
8052 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8053 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008054
Gilles Peskine449bd832023-01-11 14:50:10 +01008055 if ((status = psa_import_key(&attributes,
8056 mac_dec, mac_key_len,
8057 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008058 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008059 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008060 goto end;
8061 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008062 }
8063#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8064
8065 ((void) mac_dec);
8066 ((void) mac_enc);
8067
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008068end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008069 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8070 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008071}
8072
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008073#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008074int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008075 psa_pake_operation_t *pake_ctx,
8076 const unsigned char *buf,
8077 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008078{
8079 psa_status_t status;
8080 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008081 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008082 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8083 * At round two perform a single cycle
8084 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008085 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008086
Gilles Peskine449bd832023-01-11 14:50:10 +01008087 for (; remaining_steps > 0; remaining_steps--) {
8088 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008089 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008090 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008091 /* Length is stored at the first byte */
8092 size_t length = buf[input_offset];
8093 input_offset += 1;
8094
Gilles Peskine449bd832023-01-11 14:50:10 +01008095 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008096 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8097 }
8098
Gilles Peskine449bd832023-01-11 14:50:10 +01008099 status = psa_pake_input(pake_ctx, step,
8100 buf + input_offset, length);
8101 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008102 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008103 }
8104
8105 input_offset += length;
8106 }
8107 }
8108
Gilles Peskine449bd832023-01-11 14:50:10 +01008109 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008110 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008111 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008112
Gilles Peskine449bd832023-01-11 14:50:10 +01008113 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008114}
8115
Valerio Setti6b3dab02022-11-17 17:14:54 +01008116int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008117 psa_pake_operation_t *pake_ctx,
8118 unsigned char *buf,
8119 size_t len, size_t *olen,
8120 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008121{
8122 psa_status_t status;
8123 size_t output_offset = 0;
8124 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008125 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008126 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8127 * At round two perform a single cycle
8128 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008129 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008130
Gilles Peskine449bd832023-01-11 14:50:10 +01008131 for (; remaining_steps > 0; remaining_steps--) {
8132 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8133 step <= PSA_PAKE_STEP_ZK_PROOF;
8134 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008135 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008136 * For each step, prepend 1 byte with the length of the data as
8137 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008138 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008139 status = psa_pake_output(pake_ctx, step,
8140 buf + output_offset + 1,
8141 len - output_offset - 1,
8142 &output_len);
8143 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008144 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008145 }
8146
Valerio Setti99d88c12022-11-22 16:03:43 +01008147 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008148
8149 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008150 }
8151 }
8152
8153 *olen = output_offset;
8154
Gilles Peskine449bd832023-01-11 14:50:10 +01008155 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008156}
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008157#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Valerio Settia08b1a42022-11-17 15:10:02 +01008158
Gilles Peskine449bd832023-01-11 14:50:10 +01008159int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8160 unsigned char *hash, size_t *hashlen,
8161 unsigned char *data, size_t data_len,
8162 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008163{
8164 psa_status_t status;
8165 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008166 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008167
Gilles Peskine449bd832023-01-11 14:50:10 +01008168 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008169
Gilles Peskine449bd832023-01-11 14:50:10 +01008170 if ((status = psa_hash_setup(&hash_operation,
8171 hash_alg)) != PSA_SUCCESS) {
8172 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008173 goto exit;
8174 }
8175
Gilles Peskine449bd832023-01-11 14:50:10 +01008176 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8177 64)) != PSA_SUCCESS) {
8178 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008179 goto exit;
8180 }
8181
Gilles Peskine449bd832023-01-11 14:50:10 +01008182 if ((status = psa_hash_update(&hash_operation,
8183 data, data_len)) != PSA_SUCCESS) {
8184 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008185 goto exit;
8186 }
8187
Gilles Peskine449bd832023-01-11 14:50:10 +01008188 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8189 hashlen)) != PSA_SUCCESS) {
8190 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8191 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008192 }
8193
8194exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008195 if (status != PSA_SUCCESS) {
8196 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8197 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8198 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008199 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008200 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008201 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8202 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008203 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008204 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008205 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008206 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008207 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008208 }
8209 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008210 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008211}
8212
Jerry Yuee40f9d2022-02-17 14:55:16 +08008213
Jerry Yud9d91da2022-02-17 14:57:06 +08008214#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8215
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008216/* Find the preferred hash for a given signature algorithm. */
8217unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008218 mbedtls_ssl_context *ssl,
8219 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008220{
Gabor Mezei078e8032022-04-27 21:17:56 +02008221 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008222 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008223
Gilles Peskine449bd832023-01-11 14:50:10 +01008224 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8225 return MBEDTLS_SSL_HASH_NONE;
8226 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008227
Gilles Peskine449bd832023-01-11 14:50:10 +01008228 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008229 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008230 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8231 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008232 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008233 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8234 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008235
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008236 mbedtls_md_type_t md_alg =
8237 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8238 if (md_alg == MBEDTLS_MD_NONE) {
8239 continue;
8240 }
8241
Gilles Peskine449bd832023-01-11 14:50:10 +01008242 if (sig_alg == sig_alg_received) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008243 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008244 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008245 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008246
Gilles Peskine449bd832023-01-11 14:50:10 +01008247 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8248 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8249 PSA_ALG_ECDSA(psa_hash_alg),
8250 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008251 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008252 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008253
Gilles Peskine449bd832023-01-11 14:50:10 +01008254 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8255 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8256 PSA_ALG_RSA_PKCS1V15_SIGN(
8257 psa_hash_alg),
8258 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008259 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008260 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008261 }
Neil Armstrong96eceb82022-06-30 18:05:05 +02008262
Gilles Peskine449bd832023-01-11 14:50:10 +01008263 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008264 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008265 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008266
Gilles Peskine449bd832023-01-11 14:50:10 +01008267 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008268}
8269
8270#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8271
Jerry Yudc7bd172022-02-17 13:44:15 +08008272#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8273
XiaokangQian75d40ef2022-04-20 11:05:24 +00008274int mbedtls_ssl_validate_ciphersuite(
8275 const mbedtls_ssl_context *ssl,
8276 const mbedtls_ssl_ciphersuite_t *suite_info,
8277 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01008278 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008279{
8280 (void) ssl;
8281
Gilles Peskine449bd832023-01-11 14:50:10 +01008282 if (suite_info == NULL) {
8283 return -1;
8284 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00008285
Gilles Peskine449bd832023-01-11 14:50:10 +01008286 if ((suite_info->min_tls_version > max_tls_version) ||
8287 (suite_info->max_tls_version < min_tls_version)) {
8288 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008289 }
8290
XiaokangQian060d8672022-04-21 09:24:56 +00008291#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008292#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008293 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
Manuel Pégourié-Gonnard88800dd2025-01-23 11:01:35 +01008294 ssl->handshake->psa_pake_ctx_is_ok != 1) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008295 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008296 }
8297#endif
8298
8299 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8300#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008301 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
8302 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
8303 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008304 }
8305#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8306#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8307
Gilles Peskine449bd832023-01-11 14:50:10 +01008308 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008309}
8310
Ronald Crone68ab4f2022-10-05 12:46:29 +02008311#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00008312/*
8313 * Function for writing a signature algorithm extension.
8314 *
8315 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8316 * value (TLS 1.3 RFC8446):
8317 * enum {
8318 * ....
8319 * ecdsa_secp256r1_sha256( 0x0403 ),
8320 * ecdsa_secp384r1_sha384( 0x0503 ),
8321 * ecdsa_secp521r1_sha512( 0x0603 ),
8322 * ....
8323 * } SignatureScheme;
8324 *
8325 * struct {
8326 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8327 * } SignatureSchemeList;
8328 *
8329 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8330 * value (TLS 1.2 RFC5246):
8331 * enum {
8332 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8333 * sha512(6), (255)
8334 * } HashAlgorithm;
8335 *
8336 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8337 * SignatureAlgorithm;
8338 *
8339 * struct {
8340 * HashAlgorithm hash;
8341 * SignatureAlgorithm signature;
8342 * } SignatureAndHashAlgorithm;
8343 *
8344 * SignatureAndHashAlgorithm
8345 * supported_signature_algorithms<2..2^16-2>;
8346 *
8347 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8348 * generalization of the TLS 1.2 signature algorithm extension.
8349 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8350 * `SignatureScheme` field of TLS 1.3
8351 *
8352 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008353int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
8354 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00008355{
8356 unsigned char *p = buf;
8357 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8358 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8359
8360 *out_len = 0;
8361
Gilles Peskine449bd832023-01-11 14:50:10 +01008362 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00008363
8364 /* Check if we have space for header and length field:
8365 * - extension_type (2 bytes)
8366 * - extension_data_length (2 bytes)
8367 * - supported_signature_algorithms_length (2 bytes)
8368 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008369 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00008370 p += 6;
8371
8372 /*
8373 * Write supported_signature_algorithms
8374 */
8375 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01008376 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
8377 if (sig_alg == NULL) {
8378 return MBEDTLS_ERR_SSL_BAD_CONFIG;
8379 }
XiaokangQianeaf36512022-04-24 09:07:44 +00008380
Gilles Peskine449bd832023-01-11 14:50:10 +01008381 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
8382 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
8383 *sig_alg,
8384 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
8385 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00008386 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008387 }
8388 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
8389 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00008390 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008391 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
8392 *sig_alg,
8393 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00008394 }
8395
8396 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008397 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01008398 if (supported_sig_alg_len == 0) {
8399 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
8400 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00008401 }
8402
Gilles Peskine449bd832023-01-11 14:50:10 +01008403 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
8404 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
8405 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00008406
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008407 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00008408
8409#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008410 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00008411#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08008412
Gilles Peskine449bd832023-01-11 14:50:10 +01008413 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00008414}
Ronald Crone68ab4f2022-10-05 12:46:29 +02008415#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00008416
XiaokangQian40a35232022-05-07 09:02:40 +00008417#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008418/*
8419 * mbedtls_ssl_parse_server_name_ext
8420 *
8421 * Structure of server_name extension:
8422 *
8423 * enum {
8424 * host_name(0), (255)
8425 * } NameType;
8426 * opaque HostName<1..2^16-1>;
8427 *
8428 * struct {
8429 * NameType name_type;
8430 * select (name_type) {
8431 * case host_name: HostName;
8432 * } name;
8433 * } ServerName;
8434 * struct {
8435 * ServerName server_name_list<1..2^16-1>
8436 * } ServerNameList;
8437 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008438MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008439int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
8440 const unsigned char *buf,
8441 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00008442{
8443 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8444 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008445 size_t server_name_list_len, hostname_len;
8446 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008447
Gilles Peskine449bd832023-01-11 14:50:10 +01008448 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00008449
Gilles Peskine449bd832023-01-11 14:50:10 +01008450 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
8451 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00008452 p += 2;
8453
Gilles Peskine449bd832023-01-11 14:50:10 +01008454 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00008455 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008456 while (p < server_name_list_end) {
8457 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
8458 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
8459 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
8460 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00008461
Gilles Peskine449bd832023-01-11 14:50:10 +01008462 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008463 /* sni_name is intended to be used only during the parsing of the
8464 * ClientHello message (it is reset to NULL before the end of
8465 * the message parsing). Thus it is ok to just point to the
8466 * reception buffer and not make a copy of it.
8467 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008468 ssl->handshake->sni_name = p + 3;
8469 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008470 if (ssl->conf->f_sni == NULL) {
8471 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008472 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008473 ret = ssl->conf->f_sni(ssl->conf->p_sni,
8474 ssl, p + 3, hostname_len);
8475 if (ret != 0) {
8476 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
8477 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8478 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
8479 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
8480 }
8481 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008482 }
8483
8484 p += hostname_len + 3;
8485 }
8486
Gilles Peskine449bd832023-01-11 14:50:10 +01008487 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008488}
8489#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8490
XiaokangQianacb39922022-06-17 10:18:48 +00008491#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008492MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008493int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
8494 const unsigned char *buf,
8495 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00008496{
8497 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008498 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008499 const unsigned char *protocol_name_list;
8500 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008501 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008502
8503 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01008504 if (ssl->conf->alpn_list == NULL) {
8505 return 0;
8506 }
XiaokangQianacb39922022-06-17 10:18:48 +00008507
8508 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008509 * RFC7301, section 3.1
8510 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008511 *
XiaokangQianc7403452022-06-23 03:24:12 +00008512 * struct {
8513 * ProtocolName protocol_name_list<2..2^16-1>
8514 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008515 */
8516
XiaokangQianc7403452022-06-23 03:24:12 +00008517 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008518 * protocol_name_list_len 2 bytes
8519 * protocol_name_len 1 bytes
8520 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008521 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008522 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00008523
Gilles Peskine449bd832023-01-11 14:50:10 +01008524 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008525 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008526 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00008527 protocol_name_list = p;
8528 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008529
8530 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01008531 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008532 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008533 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
8534 protocol_name_len);
8535 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008536 MBEDTLS_SSL_PEND_FATAL_ALERT(
8537 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01008538 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
8539 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00008540 }
8541
8542 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008543 }
8544
8545 /* Use our order of preference */
Gilles Peskinec4949d12025-05-27 19:45:29 +02008546 for (const char *const *alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008547 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00008548 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01008549 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008550 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008551 if (protocol_name_len == alpn_len &&
8552 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00008553 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01008554 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008555 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008556
8557 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008558 }
8559 }
8560
XiaokangQian95d5f542022-06-24 02:29:26 +00008561 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008562 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01008563 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8564 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
8565 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00008566}
8567
Gilles Peskine449bd832023-01-11 14:50:10 +01008568int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
8569 unsigned char *buf,
8570 unsigned char *end,
8571 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00008572{
8573 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008574 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008575 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008576
Gilles Peskine449bd832023-01-11 14:50:10 +01008577 if (ssl->alpn_chosen == NULL) {
8578 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008579 }
8580
Gilles Peskine449bd832023-01-11 14:50:10 +01008581 protocol_name_len = strlen(ssl->alpn_chosen);
8582 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008583
Gilles Peskine449bd832023-01-11 14:50:10 +01008584 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00008585 /*
8586 * 0 . 1 ext identifier
8587 * 2 . 3 ext length
8588 * 4 . 5 protocol list length
8589 * 6 . 6 protocol name length
8590 * 7 . 7+n protocol name
8591 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008592 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008593
XiaokangQian95d5f542022-06-24 02:29:26 +00008594 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008595
Gilles Peskine449bd832023-01-11 14:50:10 +01008596 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
8597 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00008598 /* Note: the length of the chosen protocol has been checked to be less
8599 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8600 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008601 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008602
Gilles Peskine449bd832023-01-11 14:50:10 +01008603 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08008604
8605#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008606 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08008607#endif
8608
Gilles Peskine449bd832023-01-11 14:50:10 +01008609 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008610}
8611#endif /* MBEDTLS_SSL_ALPN */
8612
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008613#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00008614 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008615 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008616 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008617int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
8618 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008619{
8620 /* Initialize to suppress unnecessary compiler warning */
8621 size_t hostname_len = 0;
8622
8623 /* Check if new hostname is valid before
8624 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008625 if (hostname != NULL) {
8626 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008627
Gilles Peskine449bd832023-01-11 14:50:10 +01008628 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
8629 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8630 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008631 }
8632
8633 /* Now it's clear that we will overwrite the old hostname,
8634 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01008635 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008636 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01008637 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008638 }
8639
8640 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008641 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008642 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01008643 } else {
8644 session->hostname = mbedtls_calloc(1, hostname_len + 1);
8645 if (session->hostname == NULL) {
8646 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8647 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008648
Gilles Peskine449bd832023-01-11 14:50:10 +01008649 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008650 }
8651
Gilles Peskine449bd832023-01-11 14:50:10 +01008652 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008653}
Xiaokang Qian03409292022-10-12 02:49:52 +00008654#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
8655 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008656 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008657 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008658
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008659#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
8660 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008661int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
8662 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008663{
8664 size_t alpn_len = 0;
8665
8666 if (alpn != NULL) {
8667 alpn_len = strlen(alpn);
8668
8669 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
8670 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8671 }
8672 }
8673
8674 if (session->ticket_alpn != NULL) {
8675 mbedtls_zeroize_and_free(session->ticket_alpn,
8676 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008677 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008678 }
8679
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008680 if (alpn != NULL) {
8681 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008682 if (session->ticket_alpn == NULL) {
8683 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8684 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008685 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008686 }
8687
8688 return 0;
8689}
8690#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008691
8692/*
8693 * The following functions are used by 1.2 and 1.3, client and server.
8694 */
8695#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
8696int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
8697 const mbedtls_ssl_ciphersuite_t *ciphersuite,
8698 int recv_endpoint,
8699 mbedtls_ssl_protocol_version tls_version,
8700 uint32_t *flags)
8701{
8702 int ret = 0;
8703 unsigned int usage = 0;
8704 const char *ext_oid;
8705 size_t ext_len;
8706
8707 /*
8708 * keyUsage
8709 */
8710
8711 /* Note: don't guard this with MBEDTLS_SSL_CLI_C because the server wants
8712 * to check what a compliant client will think while choosing which cert
8713 * to send to the client. */
8714#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
8715 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8716 recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8717 /* TLS 1.2 server part of the key exchange */
8718 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008719 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
8720 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
8721 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8722 break;
8723
8724 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
8725 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
8726 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
8727 break;
8728
8729 /* Don't use default: we want warnings when adding new values */
8730 case MBEDTLS_KEY_EXCHANGE_NONE:
8731 case MBEDTLS_KEY_EXCHANGE_PSK:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008732 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
8733 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
8734 usage = 0;
8735 }
8736 } else
8737#endif
8738 {
8739 /* This is either TLS 1.3 authentication, which always uses signatures,
8740 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
8741 * options we implement, both using signatures. */
8742 (void) tls_version;
8743 (void) ciphersuite;
8744 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8745 }
8746
8747 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
8748 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
8749 ret = -1;
8750 }
8751
8752 /*
8753 * extKeyUsage
8754 */
8755
8756 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8757 ext_oid = MBEDTLS_OID_SERVER_AUTH;
8758 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
8759 } else {
8760 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
8761 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
8762 }
8763
8764 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
8765 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
8766 ret = -1;
8767 }
8768
8769 return ret;
8770}
8771
Gilles Peskine4ac40082025-02-20 18:13:58 +01008772static int get_hostname_for_verification(mbedtls_ssl_context *ssl,
8773 const char **hostname)
8774{
8775 if (!mbedtls_ssl_has_set_hostname_been_called(ssl)) {
8776 MBEDTLS_SSL_DEBUG_MSG(1, ("Certificate verification without having set hostname"));
Gilles Peskine488b9192025-02-13 14:39:02 +01008777 if (mbedtls_ssl_conf_get_endpoint(ssl->conf) == MBEDTLS_SSL_IS_CLIENT &&
8778 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8779 return MBEDTLS_ERR_SSL_CERTIFICATE_VERIFICATION_WITHOUT_HOSTNAME;
8780 }
Gilles Peskine4ac40082025-02-20 18:13:58 +01008781 }
8782
8783 *hostname = ssl->hostname;
8784 if (*hostname == NULL) {
8785 MBEDTLS_SSL_DEBUG_MSG(2, ("Certificate verification without CN verification"));
8786 }
8787
8788 return 0;
8789}
8790
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008791int mbedtls_ssl_verify_certificate(mbedtls_ssl_context *ssl,
8792 int authmode,
8793 mbedtls_x509_crt *chain,
8794 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
8795 void *rs_ctx)
8796{
8797 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
8798 return 0;
8799 }
8800
8801 /*
8802 * Primary check: use the appropriate X.509 verification function
8803 */
8804 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
8805 void *p_vrfy;
8806 if (ssl->f_vrfy != NULL) {
8807 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
8808 f_vrfy = ssl->f_vrfy;
8809 p_vrfy = ssl->p_vrfy;
8810 } else {
8811 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
8812 f_vrfy = ssl->conf->f_vrfy;
8813 p_vrfy = ssl->conf->p_vrfy;
8814 }
8815
Gilles Peskine4ac40082025-02-20 18:13:58 +01008816 const char *hostname = "";
8817 int ret = get_hostname_for_verification(ssl, &hostname);
8818 if (ret != 0) {
8819 MBEDTLS_SSL_DEBUG_RET(1, "get_hostname_for_verification", ret);
8820 return ret;
8821 }
8822
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008823 int have_ca_chain_or_callback = 0;
8824#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
8825 if (ssl->conf->f_ca_cb != NULL) {
8826 ((void) rs_ctx);
8827 have_ca_chain_or_callback = 1;
8828
8829 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
8830 ret = mbedtls_x509_crt_verify_with_ca_cb(
8831 chain,
8832 ssl->conf->f_ca_cb,
8833 ssl->conf->p_ca_cb,
8834 ssl->conf->cert_profile,
Gilles Peskine4ac40082025-02-20 18:13:58 +01008835 hostname,
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008836 &ssl->session_negotiate->verify_result,
8837 f_vrfy, p_vrfy);
8838 } else
8839#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
8840 {
8841 mbedtls_x509_crt *ca_chain;
8842 mbedtls_x509_crl *ca_crl;
8843#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8844 if (ssl->handshake->sni_ca_chain != NULL) {
8845 ca_chain = ssl->handshake->sni_ca_chain;
8846 ca_crl = ssl->handshake->sni_ca_crl;
8847 } else
8848#endif
8849 {
8850 ca_chain = ssl->conf->ca_chain;
8851 ca_crl = ssl->conf->ca_crl;
8852 }
8853
8854 if (ca_chain != NULL) {
8855 have_ca_chain_or_callback = 1;
8856 }
8857
8858 ret = mbedtls_x509_crt_verify_restartable(
8859 chain,
8860 ca_chain, ca_crl,
8861 ssl->conf->cert_profile,
Gilles Peskine4ac40082025-02-20 18:13:58 +01008862 hostname,
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008863 &ssl->session_negotiate->verify_result,
8864 f_vrfy, p_vrfy, rs_ctx);
8865 }
8866
8867 if (ret != 0) {
8868 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
8869 }
8870
8871#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
8872 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8873 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8874 }
8875#endif
8876
8877 /*
8878 * Secondary checks: always done, but change 'ret' only if it was 0
8879 */
8880
8881 /* With TLS 1.2 and ECC certs, check that the curve used by the
8882 * certificate is on our list of acceptable curves.
8883 *
8884 * With TLS 1.3 this is not needed because the curve is part of the
8885 * signature algorithm (eg ecdsa_secp256r1_sha256) which is checked when
8886 * we validate the signature made with the key associated to this cert.
8887 */
8888#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
8889 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
8890 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8891 mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY)) {
8892 if (mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
8893 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8894 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
8895 if (ret == 0) {
8896 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8897 }
8898 }
8899 }
8900#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
8901
8902 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
8903 if (mbedtls_ssl_check_cert_usage(chain,
8904 ciphersuite_info,
8905 ssl->conf->endpoint,
8906 ssl->tls_version,
8907 &ssl->session_negotiate->verify_result) != 0) {
8908 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8909 if (ret == 0) {
8910 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8911 }
8912 }
8913
8914 /* With authmode optional, we want to keep going if the certificate was
8915 * unacceptable, but still fail on other errors (out of memory etc),
8916 * including fatal errors from the f_vrfy callback.
8917 *
8918 * The only acceptable errors are:
8919 * - MBEDTLS_ERR_X509_CERT_VERIFY_FAILED: cert rejected by primary check;
8920 * - MBEDTLS_ERR_SSL_BAD_CERTIFICATE: cert rejected by secondary checks.
8921 * Anything else is a fatal error. */
8922 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8923 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8924 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
8925 ret = 0;
8926 }
8927
8928 /* Return a specific error as this is a user error: inconsistent
8929 * configuration - can't verify without trust anchors. */
8930 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8931 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
8932 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8933 }
8934
8935 if (ret != 0) {
8936 uint8_t alert;
8937
8938 /* The certificate may have been rejected for several reasons.
8939 Pick one and send the corresponding alert. Which alert to send
8940 may be a subject of debate in some cases. */
8941 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
8942 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
8943 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
8944 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
8945 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
8946 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8947 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
8948 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8949 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
8950 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8951 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
8952 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8953 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
8954 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
8955 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
8956 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
8957 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
8958 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
8959 } else {
8960 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
8961 }
8962 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8963 alert);
8964 }
8965
8966#if defined(MBEDTLS_DEBUG_C)
8967 if (ssl->session_negotiate->verify_result != 0) {
8968 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8969 (unsigned int) ssl->session_negotiate->verify_result));
8970 } else {
8971 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
8972 }
8973#endif /* MBEDTLS_DEBUG_C */
8974
8975 return ret;
8976}
8977#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
8978
Max Fillinger2fe35f62024-10-25 00:52:24 +02008979#if defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT)
Max Fillinger281fb792024-10-23 18:35:09 +02008980
Max Fillinger29beade2024-09-21 11:06:28 +02008981#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008982static int mbedtls_ssl_tls12_export_keying_material(const mbedtls_ssl_context *ssl,
8983 const mbedtls_md_type_t hash_alg,
Max Fillinger7b722202024-09-21 10:48:57 +02008984 uint8_t *out,
8985 const size_t key_len,
8986 const char *label,
8987 const size_t label_len,
8988 const unsigned char *context,
8989 const size_t context_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008990 const int use_context)
8991{
8992 int ret = 0;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008993 unsigned char *prf_input = NULL;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008994
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008995 /* The input to the PRF is client_random, then server_random.
8996 * If a context is provided, this is then followed by the context length
8997 * as a 16-bit big-endian integer, and then the context itself. */
Max Fillinger155cea02024-10-23 16:32:54 +02008998 const size_t randbytes_len = MBEDTLS_CLIENT_HELLO_RANDOM_LEN + MBEDTLS_SERVER_HELLO_RANDOM_LEN;
8999 size_t prf_input_len = randbytes_len;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009000 if (use_context) {
Max Fillinger155cea02024-10-23 16:32:54 +02009001 if (context_len > UINT16_MAX) {
9002 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9003 }
9004
9005 /* This does not overflow a 32-bit size_t because the current value of
9006 * prf_input_len is 64 (length of client_random + server_random) and
9007 * context_len fits into two bytes (checked above). */
9008 prf_input_len += sizeof(uint16_t) + context_len;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009009 }
Max Fillinger155cea02024-10-23 16:32:54 +02009010
9011 prf_input = mbedtls_calloc(prf_input_len, sizeof(unsigned char));
9012 if (prf_input == NULL) {
9013 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9014 }
9015
9016 memcpy(prf_input,
9017 ssl->transform->randbytes + MBEDTLS_SERVER_HELLO_RANDOM_LEN,
9018 MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
9019 memcpy(prf_input + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
9020 ssl->transform->randbytes,
9021 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
9022 if (use_context) {
9023 MBEDTLS_PUT_UINT16_BE(context_len, prf_input, randbytes_len);
9024 memcpy(prf_input + randbytes_len + sizeof(uint16_t), context, context_len);
9025 }
9026 ret = tls_prf_generic(hash_alg, ssl->session->master, sizeof(ssl->session->master),
Max Fillingerf2dda152024-10-23 15:47:23 +02009027 label, label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009028 prf_input, prf_input_len,
9029 out, key_len);
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009030 mbedtls_free(prf_input);
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009031 return ret;
9032}
Max Fillinger281fb792024-10-23 18:35:09 +02009033#endif /* defined(MBEDTLS_SSL_PROTO_TLS1_2) */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009034
Max Fillinger29beade2024-09-21 11:06:28 +02009035#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009036static int mbedtls_ssl_tls13_export_keying_material(mbedtls_ssl_context *ssl,
9037 const mbedtls_md_type_t hash_alg,
Max Fillinger7b722202024-09-21 10:48:57 +02009038 uint8_t *out,
9039 const size_t key_len,
9040 const char *label,
9041 const size_t label_len,
9042 const unsigned char *context,
9043 const size_t context_len)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009044{
9045 const psa_algorithm_t psa_hash_alg = mbedtls_md_psa_alg_from_type(hash_alg);
9046 const size_t hash_len = PSA_HASH_LENGTH(hash_alg);
9047 const unsigned char *secret = ssl->session->app_secrets.exporter_master_secret;
9048
Max Fillinger9c5bae52024-11-21 12:33:46 +01009049 /* The length of the label must be at most 249 bytes to fit into the HkdfLabel
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009050 * struct as defined in RFC 8446, Section 7.1.
Max Fillinger3e129182024-10-29 19:18:54 +01009051 *
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009052 * The length of the context is unlimited even though the context field in the
Max Fillinger9c5bae52024-11-21 12:33:46 +01009053 * struct can only hold up to 255 bytes. This is because we place a *hash* of
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009054 * the context in the field. */
Max Fillinger9c5bae52024-11-21 12:33:46 +01009055 if (label_len > 249) {
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009056 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9057 }
9058
9059 return mbedtls_ssl_tls13_exporter(psa_hash_alg, secret, hash_len,
Max Fillinger7b722202024-09-21 10:48:57 +02009060 (const unsigned char *) label, label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009061 context, context_len, out, key_len);
9062}
Max Fillinger281fb792024-10-23 18:35:09 +02009063#endif /* defined(MBEDTLS_SSL_PROTO_TLS1_3) */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009064
9065int mbedtls_ssl_export_keying_material(mbedtls_ssl_context *ssl,
Max Fillinger9c9989f2024-08-14 16:44:50 +02009066 uint8_t *out, const size_t key_len,
9067 const char *label, const size_t label_len,
9068 const unsigned char *context, const size_t context_len,
9069 const int use_context)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009070{
9071 if (!mbedtls_ssl_is_handshake_over(ssl)) {
Max Fillinger53d91682024-11-18 18:22:51 +01009072 /* TODO: Change this to a more appropriate error code when one is available. */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009073 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9074 }
9075
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009076 if (key_len > MBEDTLS_SSL_EXPORT_MAX_KEY_LEN) {
9077 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9078 }
9079
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009080 int ciphersuite_id = mbedtls_ssl_get_ciphersuite_id_from_ssl(ssl);
9081 const mbedtls_ssl_ciphersuite_t *ciphersuite = mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
9082 const mbedtls_md_type_t hash_alg = ciphersuite->mac;
9083
9084 switch (mbedtls_ssl_get_version_number(ssl)) {
Max Fillinger29beade2024-09-21 11:06:28 +02009085#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009086 case MBEDTLS_SSL_VERSION_TLS1_2:
9087 return mbedtls_ssl_tls12_export_keying_material(ssl, hash_alg, out, key_len,
9088 label, label_len,
9089 context, context_len, use_context);
Max Fillinger29beade2024-09-21 11:06:28 +02009090#endif
9091#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009092 case MBEDTLS_SSL_VERSION_TLS1_3:
Max Fillinger7b722202024-09-21 10:48:57 +02009093 return mbedtls_ssl_tls13_export_keying_material(ssl,
9094 hash_alg,
9095 out,
9096 key_len,
9097 label,
9098 label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009099 use_context ? context : NULL,
9100 use_context ? context_len : 0);
Max Fillinger29beade2024-09-21 11:06:28 +02009101#endif
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009102 default:
9103 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
9104 }
9105}
9106
Max Fillinger2fe35f62024-10-25 00:52:24 +02009107#endif /* defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT) */
Max Fillinger281fb792024-10-23 18:35:09 +02009108
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009109#endif /* MBEDTLS_SSL_TLS_C */