blob: 519b5b4a2b1579bddb84a3b6dcb796e649a6f319 [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
Gilles Peskine449bd832023-01-11 14:50:10 +01001830 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1831 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
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1858 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001859 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 }
Valerio Setti016f6822022-12-09 14:17:50 +01001861
1862 ssl->handshake->psa_pake_ctx_is_ok = 1;
1863
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001865}
1866
Gilles Peskine449bd832023-01-11 14:50:10 +01001867int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1868 const unsigned char *pw,
1869 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001870{
1871 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1872 psa_status_t status;
1873
Gilles Peskine449bd832023-01-11 14:50:10 +01001874 if (ssl->handshake == NULL || ssl->conf == NULL) {
1875 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001876 }
1877
Gilles Peskine449bd832023-01-11 14:50:10 +01001878 /* Empty password is not valid */
1879 if ((pw == NULL) || (pw_len == 0)) {
1880 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1881 }
1882
1883 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
1884 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
1885 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
1886
1887 status = psa_import_key(&attributes, pw, pw_len,
1888 &ssl->handshake->psa_pake_password);
1889 if (status != PSA_SUCCESS) {
1890 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1891 }
1892
1893 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
1894 ssl->handshake->psa_pake_password);
1895 if (status != PSA_SUCCESS) {
1896 psa_destroy_key(ssl->handshake->psa_pake_password);
1897 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1898 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1899 }
1900
1901 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001902}
Valerio Settia9a97dc2022-11-28 18:26:16 +01001903
Gilles Peskine449bd832023-01-11 14:50:10 +01001904int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
1905 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01001906{
Valerio Settia9a97dc2022-11-28 18:26:16 +01001907 psa_status_t status;
1908
Gilles Peskine449bd832023-01-11 14:50:10 +01001909 if (ssl->handshake == NULL || ssl->conf == NULL) {
1910 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001911 }
1912
Gilles Peskine449bd832023-01-11 14:50:10 +01001913 if (mbedtls_svc_key_id_is_null(pwd)) {
1914 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1915 }
1916
1917 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
1918 if (status != PSA_SUCCESS) {
1919 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1920 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1921 }
1922
1923 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001924}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001925#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001926
Ronald Cron73fe8df2022-10-05 14:31:43 +02001927#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001928int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001929{
Gilles Peskine449bd832023-01-11 14:50:10 +01001930 if (conf->psk_identity == NULL ||
1931 conf->psk_identity_len == 0) {
1932 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02001933 }
1934
Gilles Peskine449bd832023-01-11 14:50:10 +01001935 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
1936 return 1;
1937 }
Ronald Crond29e13e2022-10-19 10:33:48 +02001938
Gilles Peskine449bd832023-01-11 14:50:10 +01001939 if (conf->psk != NULL && conf->psk_len != 0) {
1940 return 1;
1941 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001942
Gilles Peskine449bd832023-01-11 14:50:10 +01001943 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001944}
1945
Gilles Peskine449bd832023-01-11 14:50:10 +01001946static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001947{
1948 /* Remove reference to existing PSK, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001950 /* The maintenance of the PSK key slot is the
1951 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001952 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001953 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001954 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01001955 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001956 conf->psk = NULL;
1957 conf->psk_len = 0;
1958 }
1959
1960 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 if (conf->psk_identity != NULL) {
1962 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001963 conf->psk_identity = NULL;
1964 conf->psk_identity_len = 0;
1965 }
1966}
1967
Hanno Becker7390c712018-11-15 13:33:04 +00001968/* This function assumes that PSK identity in the SSL config is unset.
1969 * It checks that the provided identity is well-formed and attempts
1970 * to make a copy of it in the SSL config.
1971 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001972MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001973static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
1974 unsigned char const *psk_identity,
1975 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001976{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001977 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02001979 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 (psk_identity_len >> 16) != 0 ||
1981 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
1982 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001983 }
1984
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
1986 if (conf->psk_identity == NULL) {
1987 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1988 }
Paul Bakker6db455e2013-09-18 17:29:31 +02001989
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001990 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02001992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02001994}
1995
Gilles Peskine449bd832023-01-11 14:50:10 +01001996int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
1997 const unsigned char *psk, size_t psk_len,
1998 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00001999{
Janos Follath865b3eb2019-12-16 11:46:15 +00002000 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002001
2002 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2004 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2005 }
Hanno Becker7390c712018-11-15 13:33:04 +00002006
2007 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002008 if (psk == NULL) {
2009 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2010 }
2011 if (psk_len == 0) {
2012 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2013 }
2014 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2015 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2016 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002017
Gilles Peskine449bd832023-01-11 14:50:10 +01002018 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2019 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2020 }
Hanno Becker7390c712018-11-15 13:33:04 +00002021 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002022 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002023
2024 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002025 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2026 if (ret != 0) {
2027 ssl_conf_remove_psk(conf);
2028 }
Hanno Becker7390c712018-11-15 13:33:04 +00002029
Gilles Peskine449bd832023-01-11 14:50:10 +01002030 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002031}
2032
Gilles Peskine449bd832023-01-11 14:50:10 +01002033static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002034{
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002036 /* The maintenance of the external PSK key slot is the
2037 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 if (ssl->handshake->psk_opaque_is_internal) {
2039 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002040 ssl->handshake->psk_opaque_is_internal = 0;
2041 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002042 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002043 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002044}
2045
Gilles Peskine449bd832023-01-11 14:50:10 +01002046int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2047 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002048{
Neil Armstrong501c9322022-05-03 09:35:09 +02002049 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002050 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002051 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002052 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002053
Gilles Peskine449bd832023-01-11 14:50:10 +01002054 if (psk == NULL || ssl->handshake == NULL) {
2055 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2056 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002057
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2059 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2060 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002061
Gilles Peskine449bd832023-01-11 14:50:10 +01002062 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002063
Jerry Yuccc68a42022-07-26 16:39:20 +08002064#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002065 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2066 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2067 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2068 } else {
2069 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2070 }
2071 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002072 }
2073#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002074
Jerry Yu568ec252022-07-22 21:27:34 +08002075#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2077 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2078 psa_set_key_usage_flags(&key_attributes,
2079 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002080 }
2081#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2082
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 psa_set_key_algorithm(&key_attributes, alg);
2084 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002085
Gilles Peskine449bd832023-01-11 14:50:10 +01002086 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2087 if (status != PSA_SUCCESS) {
2088 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2089 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002090
2091 /* Allow calling psa_destroy_key() on psk remove */
2092 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002093 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002094}
2095
Gilles Peskine449bd832023-01-11 14:50:10 +01002096int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2097 mbedtls_svc_key_id_t psk,
2098 const unsigned char *psk_identity,
2099 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002100{
Janos Follath865b3eb2019-12-16 11:46:15 +00002101 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002102
2103 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2105 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2106 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002107
Hanno Becker7390c712018-11-15 13:33:04 +00002108 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002109 if (mbedtls_svc_key_id_is_null(psk)) {
2110 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2111 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002112 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002113
2114 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002115 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2116 psk_identity_len);
2117 if (ret != 0) {
2118 ssl_conf_remove_psk(conf);
2119 }
Hanno Becker7390c712018-11-15 13:33:04 +00002120
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002122}
2123
Gilles Peskine449bd832023-01-11 14:50:10 +01002124int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2125 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002126{
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 if ((mbedtls_svc_key_id_is_null(psk)) ||
2128 (ssl->handshake == NULL)) {
2129 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2130 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002131
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002133 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002135}
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002136
Jerry Yu8897c072022-08-12 13:56:53 +08002137#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002138void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2139 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2140 size_t),
2141 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002142{
2143 conf->f_psk = f_psk;
2144 conf->p_psk = p_psk;
2145}
Jerry Yu8897c072022-08-12 13:56:53 +08002146#endif /* MBEDTLS_SSL_SRV_C */
2147
Ronald Cron73fe8df2022-10-05 14:31:43 +02002148#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002149
Gilles Peskine301711e2022-04-26 16:57:05 +02002150static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002152{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002153#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002154 if (alg == PSA_ALG_CBC_NO_PADDING) {
2155 return MBEDTLS_SSL_MODE_CBC;
2156 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002157#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 if (PSA_ALG_IS_AEAD(alg)) {
2159 return MBEDTLS_SSL_MODE_AEAD;
2160 }
2161 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002162}
2163
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002164
Gilles Peskinee108d982022-04-26 16:50:40 +02002165static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2166 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002168{
2169#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2171 base_mode == MBEDTLS_SSL_MODE_CBC) {
2172 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002173 }
2174#else
2175 (void) encrypt_then_mac;
2176#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002178}
2179
Neil Armstrongab555e02022-04-04 11:07:59 +02002180mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002182{
Gilles Peskinee108d982022-04-26 16:50:40 +02002183 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 transform->psa_alg
Gilles Peskinee108d982022-04-26 16:50:40 +02002185 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002186
Gilles Peskinee108d982022-04-26 16:50:40 +02002187 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002188#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002189 encrypt_then_mac = transform->encrypt_then_mac;
2190#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002192}
2193
Neil Armstrongab555e02022-04-04 11:07:59 +02002194mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002195#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002197#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002199{
Gilles Peskinee108d982022-04-26 16:50:40 +02002200 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2201
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002202 psa_status_t status;
2203 psa_algorithm_t alg;
2204 psa_key_type_t type;
2205 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002206 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2207 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 if (status == PSA_SUCCESS) {
2209 base_mode = mbedtls_ssl_get_base_mode(alg);
2210 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002211
Gilles Peskinee108d982022-04-26 16:50:40 +02002212#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2213 int encrypt_then_mac = 0;
2214#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002215 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002216}
2217
Jerry Yu251a12e2022-07-13 15:15:48 +08002218
Ronald Cron8b592d22024-11-12 18:08:25 +01002219const mbedtls_error_pair_t psa_to_ssl_errors[] =
2220{
2221 { PSA_SUCCESS, 0 },
2222 { PSA_ERROR_INSUFFICIENT_MEMORY, MBEDTLS_ERR_SSL_ALLOC_FAILED },
2223 { PSA_ERROR_NOT_SUPPORTED, MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE },
2224 { PSA_ERROR_INVALID_SIGNATURE, MBEDTLS_ERR_SSL_INVALID_MAC },
2225 { PSA_ERROR_INVALID_ARGUMENT, MBEDTLS_ERR_SSL_BAD_INPUT_DATA },
2226 { PSA_ERROR_BAD_STATE, MBEDTLS_ERR_SSL_INTERNAL_ERROR },
2227 { PSA_ERROR_BUFFER_TOO_SMALL, MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL }
2228};
2229
Gilles Peskine449bd832023-01-11 14:50:10 +01002230psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2231 size_t taglen,
2232 psa_algorithm_t *alg,
2233 psa_key_type_t *key_type,
2234 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002235{
Elena Uziunaitec2561722024-07-05 11:37:33 +01002236#if !defined(PSA_WANT_ALG_CCM)
Yanray Wang19e4dc82023-11-16 18:02:05 +08002237 (void) taglen;
2238#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 switch (mbedtls_cipher_type) {
Elena Uziunaite74342c72024-07-05 11:31:29 +01002240#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002241 case MBEDTLS_CIPHER_AES_128_CBC:
2242 *alg = PSA_ALG_CBC_NO_PADDING;
2243 *key_type = PSA_KEY_TYPE_AES;
2244 *key_size = 128;
2245 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002246#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002247#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002248 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002249 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002250 *key_type = PSA_KEY_TYPE_AES;
2251 *key_size = 128;
2252 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002253#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002254#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002255 case MBEDTLS_CIPHER_AES_128_GCM:
2256 *alg = PSA_ALG_GCM;
2257 *key_type = PSA_KEY_TYPE_AES;
2258 *key_size = 128;
2259 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002260#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002261#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002262 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002263 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002264 *key_type = PSA_KEY_TYPE_AES;
2265 *key_size = 192;
2266 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002267#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002268#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002269 case MBEDTLS_CIPHER_AES_192_GCM:
2270 *alg = PSA_ALG_GCM;
2271 *key_type = PSA_KEY_TYPE_AES;
2272 *key_size = 192;
2273 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002274#endif
Elena Uziunaite74342c72024-07-05 11:31:29 +01002275#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002276 case MBEDTLS_CIPHER_AES_256_CBC:
2277 *alg = PSA_ALG_CBC_NO_PADDING;
2278 *key_type = PSA_KEY_TYPE_AES;
2279 *key_size = 256;
2280 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002281#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002282#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002283 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002285 *key_type = PSA_KEY_TYPE_AES;
2286 *key_size = 256;
2287 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002288#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002289#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002290 case MBEDTLS_CIPHER_AES_256_GCM:
2291 *alg = PSA_ALG_GCM;
2292 *key_type = PSA_KEY_TYPE_AES;
2293 *key_size = 256;
2294 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002295#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002296#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002297 case MBEDTLS_CIPHER_ARIA_128_CBC:
2298 *alg = PSA_ALG_CBC_NO_PADDING;
2299 *key_type = PSA_KEY_TYPE_ARIA;
2300 *key_size = 128;
2301 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002302#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002303#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002304 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002306 *key_type = PSA_KEY_TYPE_ARIA;
2307 *key_size = 128;
2308 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002309#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002310#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002311 case MBEDTLS_CIPHER_ARIA_128_GCM:
2312 *alg = PSA_ALG_GCM;
2313 *key_type = PSA_KEY_TYPE_ARIA;
2314 *key_size = 128;
2315 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002316#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002317#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002318 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002319 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002320 *key_type = PSA_KEY_TYPE_ARIA;
2321 *key_size = 192;
2322 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002323#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002324#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002325 case MBEDTLS_CIPHER_ARIA_192_GCM:
2326 *alg = PSA_ALG_GCM;
2327 *key_type = PSA_KEY_TYPE_ARIA;
2328 *key_size = 192;
2329 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002330#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002331#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002332 case MBEDTLS_CIPHER_ARIA_256_CBC:
2333 *alg = PSA_ALG_CBC_NO_PADDING;
2334 *key_type = PSA_KEY_TYPE_ARIA;
2335 *key_size = 256;
2336 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002337#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002338#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002339 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002341 *key_type = PSA_KEY_TYPE_ARIA;
2342 *key_size = 256;
2343 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002344#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002345#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002346 case MBEDTLS_CIPHER_ARIA_256_GCM:
2347 *alg = PSA_ALG_GCM;
2348 *key_type = PSA_KEY_TYPE_ARIA;
2349 *key_size = 256;
2350 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002351#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002352#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002353 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2354 *alg = PSA_ALG_CBC_NO_PADDING;
2355 *key_type = PSA_KEY_TYPE_CAMELLIA;
2356 *key_size = 128;
2357 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002358#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002359#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002360 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002362 *key_type = PSA_KEY_TYPE_CAMELLIA;
2363 *key_size = 128;
2364 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002365#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002366#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002367 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2368 *alg = PSA_ALG_GCM;
2369 *key_type = PSA_KEY_TYPE_CAMELLIA;
2370 *key_size = 128;
2371 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002372#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002373#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002374 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002376 *key_type = PSA_KEY_TYPE_CAMELLIA;
2377 *key_size = 192;
2378 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002379#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002380#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002381 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2382 *alg = PSA_ALG_GCM;
2383 *key_type = PSA_KEY_TYPE_CAMELLIA;
2384 *key_size = 192;
2385 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002386#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002387#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002388 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2389 *alg = PSA_ALG_CBC_NO_PADDING;
2390 *key_type = PSA_KEY_TYPE_CAMELLIA;
2391 *key_size = 256;
2392 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002393#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002394#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002395 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002397 *key_type = PSA_KEY_TYPE_CAMELLIA;
2398 *key_size = 256;
2399 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002400#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002401#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002402 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2403 *alg = PSA_ALG_GCM;
2404 *key_type = PSA_KEY_TYPE_CAMELLIA;
2405 *key_size = 256;
2406 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002407#endif
Elena Uziunaite5c70c302024-07-05 11:44:44 +01002408#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002409 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2410 *alg = PSA_ALG_CHACHA20_POLY1305;
2411 *key_type = PSA_KEY_TYPE_CHACHA20;
2412 *key_size = 256;
2413 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002414#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002415 case MBEDTLS_CIPHER_NULL:
2416 *alg = MBEDTLS_SSL_NULL_CIPHER;
2417 *key_type = 0;
2418 *key_size = 0;
2419 break;
2420 default:
2421 return PSA_ERROR_NOT_SUPPORTED;
2422 }
2423
2424 return PSA_SUCCESS;
2425}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002426
Ronald Crone68ab4f2022-10-05 12:46:29 +02002427#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002428#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002429/*
2430 * Set allowed/preferred hashes for handshake signatures
2431 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002432void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2433 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002434{
2435 conf->sig_hashes = hashes;
2436}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002437#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002438
Jerry Yuf017ee42022-01-12 15:49:48 +08002439/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002440void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2441 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002442{
Jerry Yuf017ee42022-01-12 15:49:48 +08002443#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2444 conf->sig_hashes = NULL;
2445#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2446 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002447}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002448#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002449
Brett Warrene0edc842021-08-17 09:53:13 +01002450/*
2451 * Set the allowed groups
2452 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002453void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2454 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002455{
Brett Warrene0edc842021-08-17 09:53:13 +01002456 conf->group_list = group_list;
2457}
2458
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002459#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine4ac40082025-02-20 18:13:58 +01002460
2461#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2462/** Whether mbedtls_ssl_set_hostname() has been called.
2463 *
2464 * \param[in] ssl SSL context
2465 *
2466 * \return \c 1 if mbedtls_ssl_set_hostname() has been called on \p ssl
2467 * (including `mbedtls_ssl_set_hostname(ssl, NULL)`),
2468 * otherwise \c 0.
2469 */
2470static int mbedtls_ssl_has_set_hostname_been_called(
2471 const mbedtls_ssl_context *ssl)
2472{
Gilles Peskine434016e2025-02-20 18:49:59 +01002473 return (ssl->flags & MBEDTLS_SSL_CONTEXT_FLAG_HOSTNAME_SET) != 0;
Gilles Peskine4ac40082025-02-20 18:13:58 +01002474}
2475#endif
2476
2477static void mbedtls_ssl_free_hostname(mbedtls_ssl_context *ssl)
2478{
2479 if (ssl->hostname != NULL) {
2480 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
2481 }
2482 ssl->hostname = NULL;
2483}
2484
Gilles Peskine449bd832023-01-11 14:50:10 +01002485int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002486{
Hanno Becker947194e2017-04-07 13:25:49 +01002487 /* Initialize to suppress unnecessary compiler warning */
2488 size_t hostname_len = 0;
2489
2490 /* Check if new hostname is valid before
2491 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 if (hostname != NULL) {
2493 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002494
Gilles Peskine449bd832023-01-11 14:50:10 +01002495 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2496 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2497 }
Hanno Becker947194e2017-04-07 13:25:49 +01002498 }
2499
2500 /* Now it's clear that we will overwrite the old hostname,
2501 * so we can free it safely */
Gilles Peskine4ac40082025-02-20 18:13:58 +01002502 mbedtls_ssl_free_hostname(ssl);
Hanno Becker947194e2017-04-07 13:25:49 +01002503
2504 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002505
Gilles Peskine449bd832023-01-11 14:50:10 +01002506 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002507 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002508 } else {
2509 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2510 if (ssl->hostname == NULL) {
2511 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2512 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002513
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002515
Hanno Becker947194e2017-04-07 13:25:49 +01002516 ssl->hostname[hostname_len] = '\0';
2517 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002518
Gilles Peskine434016e2025-02-20 18:49:59 +01002519 ssl->flags |= MBEDTLS_SSL_CONTEXT_FLAG_HOSTNAME_SET;
2520
Gilles Peskine449bd832023-01-11 14:50:10 +01002521 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002522}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002523#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002524
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002525#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002526void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2527 int (*f_sni)(void *, mbedtls_ssl_context *,
2528 const unsigned char *, size_t),
2529 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002530{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002531 conf->f_sni = f_sni;
2532 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002533}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002534#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002535
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002536#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002537int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002538{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002539 size_t cur_len, tot_len;
2540 const char **p;
2541
2542 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002543 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2544 * MUST NOT be truncated."
2545 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002546 */
2547 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 for (p = protos; *p != NULL; p++) {
2549 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002550 tot_len += cur_len;
2551
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 if ((cur_len == 0) ||
2553 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2554 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2555 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2556 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002557 }
2558
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002559 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002560
Gilles Peskine449bd832023-01-11 14:50:10 +01002561 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002562}
2563
Gilles Peskine449bd832023-01-11 14:50:10 +01002564const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002565{
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002567}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002568#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002569
Johan Pascalb62bb512015-12-03 21:56:45 +01002570#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002571void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2572 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002573{
2574 conf->dtls_srtp_mki_support = support_mki_value;
2575}
2576
Gilles Peskine449bd832023-01-11 14:50:10 +01002577int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2578 unsigned char *mki_value,
2579 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002580{
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2582 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002583 }
Ron Eldor591f1622018-01-22 12:30:04 +02002584
Gilles Peskine449bd832023-01-11 14:50:10 +01002585 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2586 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002587 }
Ron Eldor591f1622018-01-22 12:30:04 +02002588
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002590 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002591 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002592}
2593
Gilles Peskine449bd832023-01-11 14:50:10 +01002594int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2595 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002596{
Johan Pascal253d0262020-09-22 13:04:45 +02002597 const mbedtls_ssl_srtp_profile *p;
2598 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002599
Johan Pascal253d0262020-09-22 13:04:45 +02002600 /* check the profiles list: all entry must be valid,
2601 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002602 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2603 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2604 p++) {
2605 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002606 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002608 /* unsupported value, stop parsing and set the size to an error value */
2609 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002610 }
2611 }
2612
Gilles Peskine449bd832023-01-11 14:50:10 +01002613 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2614 conf->dtls_srtp_profile_list = NULL;
2615 conf->dtls_srtp_profile_list_len = 0;
2616 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002617 }
2618
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002619 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002620 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002621
Gilles Peskine449bd832023-01-11 14:50:10 +01002622 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002623}
2624
Gilles Peskine449bd832023-01-11 14:50:10 +01002625void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2626 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002627{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002628 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2629 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002631 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002632 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002633 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002634 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2635 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002636 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002637}
Johan Pascalb62bb512015-12-03 21:56:45 +01002638#endif /* MBEDTLS_SSL_DTLS_SRTP */
2639
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302640#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002641void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002642{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002643 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002644}
2645
Gilles Peskine449bd832023-01-11 14:50:10 +01002646void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002647{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002648 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002649}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302650#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002651
Janos Follath088ce432017-04-10 12:42:31 +01002652#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002653void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2654 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002655{
2656 conf->cert_req_ca_list = cert_req_ca_list;
2657}
2658#endif
2659
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002660#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002661void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002662{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002663 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002664}
2665#endif
2666
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002667#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002668void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002669{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002670 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002671}
2672#endif
2673
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002674#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002675int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002676{
Gilles Peskine449bd832023-01-11 14:50:10 +01002677 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2678 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2679 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002680 }
2681
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002682 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002683
Gilles Peskine449bd832023-01-11 14:50:10 +01002684 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002685}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002686#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002687
Gilles Peskine449bd832023-01-11 14:50:10 +01002688void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002689{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002690 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002691}
2692
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002693#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002694void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002695{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002696 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002697}
2698
Gilles Peskine449bd832023-01-11 14:50:10 +01002699void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002700{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002701 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002702}
2703
Gilles Peskine449bd832023-01-11 14:50:10 +01002704void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2705 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002706{
Gilles Peskine449bd832023-01-11 14:50:10 +01002707 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002708}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002709#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002710
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002711#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002712#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002713void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002714{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002715 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002716}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002717#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002718
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002719#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002720
Jerry Yud0766ec2022-09-22 10:46:57 +08002721#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002722void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2723 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002724{
Jerry Yud0766ec2022-09-22 10:46:57 +08002725 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002726}
2727#endif
2728
Gilles Peskine449bd832023-01-11 14:50:10 +01002729void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2730 mbedtls_ssl_ticket_write_t *f_ticket_write,
2731 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2732 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02002733{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002734 conf->f_ticket_write = f_ticket_write;
2735 conf->f_ticket_parse = f_ticket_parse;
2736 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002737}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002738#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002739#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002740
Gilles Peskine449bd832023-01-11 14:50:10 +01002741void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
2742 mbedtls_ssl_export_keys_t *f_export_keys,
2743 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002744{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002745 ssl->f_export_keys = f_export_keys;
2746 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002747}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002748
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002749#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002750void mbedtls_ssl_conf_async_private_cb(
2751 mbedtls_ssl_config *conf,
2752 mbedtls_ssl_async_sign_t *f_async_sign,
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002753 mbedtls_ssl_async_resume_t *f_async_resume,
2754 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01002755 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002756{
2757 conf->f_async_sign_start = f_async_sign;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002758 conf->f_async_resume = f_async_resume;
2759 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002760 conf->p_async_config_data = async_config_data;
2761}
2762
Gilles Peskine449bd832023-01-11 14:50:10 +01002763void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02002764{
Gilles Peskine449bd832023-01-11 14:50:10 +01002765 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02002766}
2767
Gilles Peskine449bd832023-01-11 14:50:10 +01002768void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002769{
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 if (ssl->handshake == NULL) {
2771 return NULL;
2772 } else {
2773 return ssl->handshake->user_async_ctx;
2774 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002775}
2776
Gilles Peskine449bd832023-01-11 14:50:10 +01002777void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2778 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002779{
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002781 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002783}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002784#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002785
Paul Bakker5121ce52009-01-03 21:22:43 +00002786/*
2787 * SSL get accessors
2788 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002789uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002790{
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 if (ssl->session != NULL) {
2792 return ssl->session->verify_result;
2793 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002794
Gilles Peskine449bd832023-01-11 14:50:10 +01002795 if (ssl->session_negotiate != NULL) {
2796 return ssl->session_negotiate->verify_result;
2797 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002798
Gilles Peskine449bd832023-01-11 14:50:10 +01002799 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00002800}
2801
Gilles Peskine449bd832023-01-11 14:50:10 +01002802int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05002803{
Gilles Peskine449bd832023-01-11 14:50:10 +01002804 if (ssl == NULL || ssl->session == NULL) {
2805 return 0;
2806 }
Glenn Strauss8f526902022-01-13 00:04:49 -05002807
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05002809}
2810
Gilles Peskine449bd832023-01-11 14:50:10 +01002811const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00002812{
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 if (ssl == NULL || ssl->session == NULL) {
2814 return NULL;
2815 }
Paul Bakker926c8e42013-03-06 10:23:34 +01002816
Gilles Peskine449bd832023-01-11 14:50:10 +01002817 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00002818}
2819
Gilles Peskine449bd832023-01-11 14:50:10 +01002820const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00002821{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002822#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2824 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002825 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002826 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002827 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002828 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002829 }
2830 }
2831#endif
2832
Gilles Peskine449bd832023-01-11 14:50:10 +01002833 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002834 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002835 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04002836 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01002837 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002838 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002839 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002840 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002841}
2842
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002843#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2844
2845size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
2846{
2847 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2848 size_t record_size_limit = max_len;
2849
2850 if (ssl->session != NULL &&
2851 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2852 ssl->session->record_size_limit < max_len) {
2853 record_size_limit = ssl->session->record_size_limit;
2854 }
2855
2856 // TODO: this is currently untested
2857 /* During a handshake, use the value being negotiated */
2858 if (ssl->session_negotiate != NULL &&
2859 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2860 ssl->session_negotiate->record_size_limit < max_len) {
2861 record_size_limit = ssl->session_negotiate->record_size_limit;
2862 }
2863
2864 return record_size_limit;
2865}
2866#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2867
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002868#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002869size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002870{
David Horstmann95d516f2021-05-04 18:36:56 +01002871 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002872 size_t read_mfl;
2873
Jerry Yuddda0502022-12-01 19:43:12 +08002874#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002875 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2877 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
2878 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002879 }
Jerry Yuddda0502022-12-01 19:43:12 +08002880#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002881
2882 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 if (ssl->session_out != NULL) {
2884 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
2885 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002886 max_len = read_mfl;
2887 }
2888 }
2889
Jerry Yuddda0502022-12-01 19:43:12 +08002890 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002891 if (ssl->session_negotiate != NULL) {
2892 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
2893 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002894 max_len = read_mfl;
2895 }
2896 }
2897
Gilles Peskine449bd832023-01-11 14:50:10 +01002898 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002899}
2900
Gilles Peskine449bd832023-01-11 14:50:10 +01002901size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002902{
2903 size_t max_len;
2904
2905 /*
2906 * Assume mfl_code is correct since it was checked when set
2907 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002908 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002909
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002910 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 if (ssl->session_out != NULL &&
2912 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
2913 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002914 }
2915
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002916 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002917 if (ssl->session_negotiate != NULL &&
2918 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
2919 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002920 }
2921
Gilles Peskine449bd832023-01-11 14:50:10 +01002922 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002923}
2924#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2925
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002926#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002927size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002928{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002929 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002930 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2931 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2932 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
2933 return 0;
2934 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002935
Gilles Peskine449bd832023-01-11 14:50:10 +01002936 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
2937 return ssl->mtu;
2938 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002939
Gilles Peskine449bd832023-01-11 14:50:10 +01002940 if (ssl->mtu == 0) {
2941 return ssl->handshake->mtu;
2942 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002943
Gilles Peskine449bd832023-01-11 14:50:10 +01002944 return ssl->mtu < ssl->handshake->mtu ?
2945 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002946}
2947#endif /* MBEDTLS_SSL_PROTO_DTLS */
2948
Gilles Peskine449bd832023-01-11 14:50:10 +01002949int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002950{
2951 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2952
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002953#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002954 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002955 !defined(MBEDTLS_SSL_PROTO_DTLS)
2956 (void) ssl;
2957#endif
2958
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002959#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002960 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002961
Gilles Peskine449bd832023-01-11 14:50:10 +01002962 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002963 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01002964 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002965#endif
2966
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002967#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2968 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
2969
2970 if (max_len > record_size_limit) {
2971 max_len = record_size_limit;
2972 }
2973#endif
2974
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002975 if (ssl->transform_out != NULL &&
2976 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00002977 /*
2978 * In TLS 1.3 case, when records are protected, `max_len` as computed
2979 * above is the maximum length of the TLSInnerPlaintext structure that
2980 * along the plaintext payload contains the inner content type (one byte)
2981 * and some zero padding. Given the algorithm used for padding
2982 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
2983 * the plaintext payload. Round down to a multiple of
2984 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
2985 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002986 */
2987 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
2988 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
2989 }
2990
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002991#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
2993 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
2994 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002995 const size_t overhead = (size_t) ret;
2996
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 if (ret < 0) {
2998 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002999 }
3000
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 if (mtu <= overhead) {
3002 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3003 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3004 }
3005
3006 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003007 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003009 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003010#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003011
Hanno Becker0defedb2018-08-10 12:35:02 +01003012#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003013 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3014 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003015 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003016#endif
3017
Gilles Peskine449bd832023-01-11 14:50:10 +01003018 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003019}
3020
Gilles Peskine449bd832023-01-11 14:50:10 +01003021int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003022{
3023 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3024
3025#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3026 (void) ssl;
3027#endif
3028
3029#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003031
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003033 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003034 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003035#endif
3036
Gilles Peskine449bd832023-01-11 14:50:10 +01003037 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003038}
3039
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003040#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003041const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003042{
Gilles Peskine449bd832023-01-11 14:50:10 +01003043 if (ssl == NULL || ssl->session == NULL) {
3044 return NULL;
3045 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003046
Hanno Beckere6824572019-02-07 13:18:46 +00003047#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003048 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003049#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003050 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003051#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003052}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003053#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003054
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003055#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003056int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3057 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003058{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003059 int ret;
3060
Gilles Peskine449bd832023-01-11 14:50:10 +01003061 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003062 dst == NULL ||
3063 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3065 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003066 }
3067
Hanno Beckere810bbc2021-05-14 16:01:05 +01003068 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3069 * idempotent: Each session can only be exported once.
3070 *
3071 * (This is in preparation for TLS 1.3 support where we will
3072 * need the ability to export multiple sessions (aka tickets),
3073 * which will be achieved by calling mbedtls_ssl_get_session()
3074 * multiple times until it fails.)
3075 *
3076 * Check whether we have already exported the current session,
3077 * and fail if so.
3078 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 if (ssl->session->exported == 1) {
3080 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3081 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003082
Gilles Peskine449bd832023-01-11 14:50:10 +01003083 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3084 if (ret != 0) {
3085 return ret;
3086 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003087
3088 /* Remember that we've exported the session. */
3089 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003090 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003091}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003092#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003093
David Horstmanncb01b362024-02-29 17:31:46 +00003094#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3095
3096/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003097 *
David Horstmanncb01b362024-02-29 17:31:46 +00003098 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003099 */
3100static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3101 unsigned char *buf,
3102 size_t buf_len)
3103{
3104 unsigned char *p = buf;
3105 size_t used = 0;
3106
3107#if defined(MBEDTLS_HAVE_TIME)
3108 uint64_t start;
3109#endif
3110#if defined(MBEDTLS_X509_CRT_PARSE_C)
3111#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3112 size_t cert_len;
3113#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3114#endif /* MBEDTLS_X509_CRT_PARSE_C */
3115
3116 /*
3117 * Time
3118 */
3119#if defined(MBEDTLS_HAVE_TIME)
3120 used += 8;
3121
3122 if (used <= buf_len) {
3123 start = (uint64_t) session->start;
3124
3125 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3126 p += 8;
3127 }
3128#endif /* MBEDTLS_HAVE_TIME */
3129
3130 /*
3131 * Basic mandatory fields
3132 */
3133 used += 1 /* id_len */
3134 + sizeof(session->id)
3135 + sizeof(session->master)
3136 + 4; /* verify_result */
3137
3138 if (used <= buf_len) {
3139 *p++ = MBEDTLS_BYTE_0(session->id_len);
3140 memcpy(p, session->id, 32);
3141 p += 32;
3142
3143 memcpy(p, session->master, 48);
3144 p += 48;
3145
3146 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3147 p += 4;
3148 }
3149
3150 /*
3151 * Peer's end-entity certificate
3152 */
3153#if defined(MBEDTLS_X509_CRT_PARSE_C)
3154#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3155 if (session->peer_cert == NULL) {
3156 cert_len = 0;
3157 } else {
3158 cert_len = session->peer_cert->raw.len;
3159 }
3160
3161 used += 3 + cert_len;
3162
3163 if (used <= buf_len) {
3164 *p++ = MBEDTLS_BYTE_2(cert_len);
3165 *p++ = MBEDTLS_BYTE_1(cert_len);
3166 *p++ = MBEDTLS_BYTE_0(cert_len);
3167
3168 if (session->peer_cert != NULL) {
3169 memcpy(p, session->peer_cert->raw.p, cert_len);
3170 p += cert_len;
3171 }
3172 }
3173#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3174 if (session->peer_cert_digest != NULL) {
3175 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3176 if (used <= buf_len) {
3177 *p++ = (unsigned char) session->peer_cert_digest_type;
3178 *p++ = (unsigned char) session->peer_cert_digest_len;
3179 memcpy(p, session->peer_cert_digest,
3180 session->peer_cert_digest_len);
3181 p += session->peer_cert_digest_len;
3182 }
3183 } else {
3184 used += 2;
3185 if (used <= buf_len) {
3186 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3187 *p++ = 0;
3188 }
3189 }
3190#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3191#endif /* MBEDTLS_X509_CRT_PARSE_C */
3192
3193 /*
3194 * Session ticket if any, plus associated data
3195 */
3196#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3197#if defined(MBEDTLS_SSL_CLI_C)
3198 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3199 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3200
3201 if (used <= buf_len) {
3202 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3203 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3204 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3205
3206 if (session->ticket != NULL) {
3207 memcpy(p, session->ticket, session->ticket_len);
3208 p += session->ticket_len;
3209 }
3210
3211 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3212 p += 4;
3213 }
3214 }
3215#endif /* MBEDTLS_SSL_CLI_C */
3216#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3217 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3218 used += 8;
3219
3220 if (used <= buf_len) {
3221 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3222 p += 8;
3223 }
3224 }
3225#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3226#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3227
3228 /*
3229 * Misc extension-related info
3230 */
3231#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3232 used += 1;
3233
3234 if (used <= buf_len) {
3235 *p++ = session->mfl_code;
3236 }
3237#endif
3238
3239#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3240 used += 1;
3241
3242 if (used <= buf_len) {
3243 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3244 }
3245#endif
3246
3247 return used;
3248}
3249
3250MBEDTLS_CHECK_RETURN_CRITICAL
3251static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3252 const unsigned char *buf,
3253 size_t len)
3254{
3255#if defined(MBEDTLS_HAVE_TIME)
3256 uint64_t start;
3257#endif
3258#if defined(MBEDTLS_X509_CRT_PARSE_C)
3259#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3260 size_t cert_len;
3261#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3262#endif /* MBEDTLS_X509_CRT_PARSE_C */
3263
3264 const unsigned char *p = buf;
3265 const unsigned char * const end = buf + len;
3266
3267 /*
3268 * Time
3269 */
3270#if defined(MBEDTLS_HAVE_TIME)
3271 if (8 > (size_t) (end - p)) {
3272 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3273 }
3274
3275 start = MBEDTLS_GET_UINT64_BE(p, 0);
3276 p += 8;
3277
3278 session->start = (time_t) start;
3279#endif /* MBEDTLS_HAVE_TIME */
3280
3281 /*
3282 * Basic mandatory fields
3283 */
3284 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3285 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3286 }
3287
3288 session->id_len = *p++;
3289 memcpy(session->id, p, 32);
3290 p += 32;
3291
3292 memcpy(session->master, p, 48);
3293 p += 48;
3294
3295 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3296 p += 4;
3297
3298 /* Immediately clear invalid pointer values that have been read, in case
3299 * we exit early before we replaced them with valid ones. */
3300#if defined(MBEDTLS_X509_CRT_PARSE_C)
3301#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3302 session->peer_cert = NULL;
3303#else
3304 session->peer_cert_digest = NULL;
3305#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3306#endif /* MBEDTLS_X509_CRT_PARSE_C */
3307#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3308 session->ticket = NULL;
3309#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3310
3311 /*
3312 * Peer certificate
3313 */
3314#if defined(MBEDTLS_X509_CRT_PARSE_C)
3315#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3316 /* Deserialize CRT from the end of the ticket. */
3317 if (3 > (size_t) (end - p)) {
3318 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3319 }
3320
3321 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3322 p += 3;
3323
3324 if (cert_len != 0) {
3325 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3326
3327 if (cert_len > (size_t) (end - p)) {
3328 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3329 }
3330
3331 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3332
3333 if (session->peer_cert == NULL) {
3334 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3335 }
3336
3337 mbedtls_x509_crt_init(session->peer_cert);
3338
3339 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3340 p, cert_len)) != 0) {
3341 mbedtls_x509_crt_free(session->peer_cert);
3342 mbedtls_free(session->peer_cert);
3343 session->peer_cert = NULL;
3344 return ret;
3345 }
3346
3347 p += cert_len;
3348 }
3349#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3350 /* Deserialize CRT digest from the end of the ticket. */
3351 if (2 > (size_t) (end - p)) {
3352 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3353 }
3354
3355 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3356 session->peer_cert_digest_len = (size_t) *p++;
3357
3358 if (session->peer_cert_digest_len != 0) {
3359 const mbedtls_md_info_t *md_info =
3360 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3361 if (md_info == NULL) {
3362 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3363 }
3364 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3365 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3366 }
3367
3368 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3369 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3370 }
3371
3372 session->peer_cert_digest =
3373 mbedtls_calloc(1, session->peer_cert_digest_len);
3374 if (session->peer_cert_digest == NULL) {
3375 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3376 }
3377
3378 memcpy(session->peer_cert_digest, p,
3379 session->peer_cert_digest_len);
3380 p += session->peer_cert_digest_len;
3381 }
3382#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3383#endif /* MBEDTLS_X509_CRT_PARSE_C */
3384
3385 /*
3386 * Session ticket and associated data
3387 */
3388#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3389#if defined(MBEDTLS_SSL_CLI_C)
3390 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3391 if (3 > (size_t) (end - p)) {
3392 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3393 }
3394
3395 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3396 p += 3;
3397
3398 if (session->ticket_len != 0) {
3399 if (session->ticket_len > (size_t) (end - p)) {
3400 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3401 }
3402
3403 session->ticket = mbedtls_calloc(1, session->ticket_len);
3404 if (session->ticket == NULL) {
3405 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3406 }
3407
3408 memcpy(session->ticket, p, session->ticket_len);
3409 p += session->ticket_len;
3410 }
3411
3412 if (4 > (size_t) (end - p)) {
3413 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3414 }
3415
3416 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3417 p += 4;
3418 }
3419#endif /* MBEDTLS_SSL_CLI_C */
3420#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3421 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3422 if (8 > (size_t) (end - p)) {
3423 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3424 }
3425 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3426 p += 8;
3427 }
3428#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3429#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3430
3431 /*
3432 * Misc extension-related info
3433 */
3434#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3435 if (1 > (size_t) (end - p)) {
3436 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3437 }
3438
3439 session->mfl_code = *p++;
3440#endif
3441
3442#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3443 if (1 > (size_t) (end - p)) {
3444 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3445 }
3446
3447 session->encrypt_then_mac = *p++;
3448#endif
3449
3450 /* Done, should have consumed entire buffer */
3451 if (p != end) {
3452 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3453 }
3454
3455 return 0;
3456}
3457
3458#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3459
3460#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3461/* Serialization of TLS 1.3 sessions:
3462 *
David Horstmanncb01b362024-02-29 17:31:46 +00003463 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003464 */
3465#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3466MBEDTLS_CHECK_RETURN_CRITICAL
3467static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3468 unsigned char *buf,
3469 size_t buf_len,
3470 size_t *olen)
3471{
3472 unsigned char *p = buf;
3473#if defined(MBEDTLS_SSL_CLI_C) && \
3474 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3475 size_t hostname_len = (session->hostname == NULL) ?
3476 0 : strlen(session->hostname) + 1;
3477#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003478
3479#if defined(MBEDTLS_SSL_SRV_C) && \
3480 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003481 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003482 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003483#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003484 size_t needed = 4 /* ticket_age_add */
3485 + 1 /* ticket_flags */
3486 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003487
David Horstmanne59f9702024-02-29 16:08:57 +00003488 *olen = 0;
3489
3490 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3491 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3492 }
3493 needed += session->resumption_key_len; /* resumption_key */
3494
3495#if defined(MBEDTLS_SSL_EARLY_DATA)
3496 needed += 4; /* max_early_data_size */
3497#endif
3498#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3499 needed += 2; /* record_size_limit */
3500#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3501
3502#if defined(MBEDTLS_HAVE_TIME)
3503 needed += 8; /* ticket_creation_time or ticket_reception_time */
3504#endif
3505
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003506#if defined(MBEDTLS_SSL_SRV_C)
3507 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3508#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003509 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003510 + alpn_len; /* alpn */
3511#endif
3512 }
3513#endif /* MBEDTLS_SSL_SRV_C */
3514
David Horstmanne59f9702024-02-29 16:08:57 +00003515#if defined(MBEDTLS_SSL_CLI_C)
3516 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3517#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3518 needed += 2 /* hostname_len */
3519 + hostname_len; /* hostname */
3520#endif
3521
3522 needed += 4 /* ticket_lifetime */
3523 + 2; /* ticket_len */
3524
3525 /* Check size_t overflow */
3526 if (session->ticket_len > SIZE_MAX - needed) {
3527 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3528 }
3529
3530 needed += session->ticket_len; /* ticket */
3531 }
3532#endif /* MBEDTLS_SSL_CLI_C */
3533
3534 *olen = needed;
3535 if (needed > buf_len) {
3536 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3537 }
3538
3539 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3540 p[4] = session->ticket_flags;
3541
3542 /* save resumption_key */
3543 p[5] = session->resumption_key_len;
3544 p += 6;
3545 memcpy(p, session->resumption_key, session->resumption_key_len);
3546 p += session->resumption_key_len;
3547
3548#if defined(MBEDTLS_SSL_EARLY_DATA)
3549 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3550 p += 4;
3551#endif
3552#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3553 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3554 p += 2;
3555#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3556
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003557#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003558 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003559#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003560 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3561 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003562#endif /* MBEDTLS_HAVE_TIME */
3563
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003564#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003565 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3566 p += 2;
3567
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003568 if (alpn_len > 0) {
3569 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003570 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003571 p += alpn_len;
3572 }
3573#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3574 }
3575#endif /* MBEDTLS_SSL_SRV_C */
3576
David Horstmanne59f9702024-02-29 16:08:57 +00003577#if defined(MBEDTLS_SSL_CLI_C)
3578 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3579#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3580 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3581 p += 2;
3582 if (hostname_len > 0) {
3583 /* save host name */
3584 memcpy(p, session->hostname, hostname_len);
3585 p += hostname_len;
3586 }
3587#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3588
3589#if defined(MBEDTLS_HAVE_TIME)
3590 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3591 p += 8;
3592#endif
3593 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3594 p += 4;
3595
3596 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3597 p += 2;
3598
3599 if (session->ticket != NULL && session->ticket_len > 0) {
3600 memcpy(p, session->ticket, session->ticket_len);
3601 p += session->ticket_len;
3602 }
3603 }
3604#endif /* MBEDTLS_SSL_CLI_C */
3605 return 0;
3606}
3607
3608MBEDTLS_CHECK_RETURN_CRITICAL
3609static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3610 const unsigned char *buf,
3611 size_t len)
3612{
3613 const unsigned char *p = buf;
3614 const unsigned char *end = buf + len;
3615
3616 if (end - p < 6) {
3617 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3618 }
3619 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3620 session->ticket_flags = p[4];
3621
3622 /* load resumption_key */
3623 session->resumption_key_len = p[5];
3624 p += 6;
3625
3626 if (end - p < session->resumption_key_len) {
3627 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3628 }
3629
3630 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3631 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3632 }
3633 memcpy(session->resumption_key, p, session->resumption_key_len);
3634 p += session->resumption_key_len;
3635
3636#if defined(MBEDTLS_SSL_EARLY_DATA)
3637 if (end - p < 4) {
3638 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3639 }
3640 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3641 p += 4;
3642#endif
3643#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3644 if (end - p < 2) {
3645 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3646 }
3647 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3648 p += 2;
3649#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3650
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003651#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003652 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003653#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003654 if (end - p < 8) {
3655 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3656 }
3657 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3658 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003659#endif /* MBEDTLS_HAVE_TIME */
3660
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003661#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003662 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003663
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003664 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003665 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3666 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003667
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003668 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3669 p += 2;
3670
3671 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003672 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3673 }
3674
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003675 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003676 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3677 if (ret != 0) {
3678 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003679 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003680 p += alpn_len;
3681 }
3682#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3683 }
3684#endif /* MBEDTLS_SSL_SRV_C */
3685
David Horstmanne59f9702024-02-29 16:08:57 +00003686#if defined(MBEDTLS_SSL_CLI_C)
3687 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3688#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3689 size_t hostname_len;
3690 /* load host name */
3691 if (end - p < 2) {
3692 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3693 }
3694 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3695 p += 2;
3696
3697 if (end - p < (long int) hostname_len) {
3698 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3699 }
3700 if (hostname_len > 0) {
3701 session->hostname = mbedtls_calloc(1, hostname_len);
3702 if (session->hostname == NULL) {
3703 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3704 }
3705 memcpy(session->hostname, p, hostname_len);
3706 p += hostname_len;
3707 }
3708#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3709
3710#if defined(MBEDTLS_HAVE_TIME)
3711 if (end - p < 8) {
3712 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3713 }
3714 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3715 p += 8;
3716#endif
3717 if (end - p < 4) {
3718 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3719 }
3720 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3721 p += 4;
3722
3723 if (end - p < 2) {
3724 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3725 }
3726 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
3727 p += 2;
3728
3729 if (end - p < (long int) session->ticket_len) {
3730 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3731 }
3732 if (session->ticket_len > 0) {
3733 session->ticket = mbedtls_calloc(1, session->ticket_len);
3734 if (session->ticket == NULL) {
3735 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3736 }
3737 memcpy(session->ticket, p, session->ticket_len);
3738 p += session->ticket_len;
3739 }
3740 }
3741#endif /* MBEDTLS_SSL_CLI_C */
3742
3743 return 0;
3744
3745}
3746#else /* MBEDTLS_SSL_SESSION_TICKETS */
3747MBEDTLS_CHECK_RETURN_CRITICAL
3748static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3749 unsigned char *buf,
3750 size_t buf_len,
3751 size_t *olen)
3752{
3753 ((void) session);
3754 ((void) buf);
3755 ((void) buf_len);
3756 *olen = 0;
3757 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3758}
3759
3760static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01003761 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00003762 size_t buf_len)
3763{
3764 ((void) session);
3765 ((void) buf);
3766 ((void) buf_len);
3767 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3768}
3769#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
3770#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3771
Paul Bakker5121ce52009-01-03 21:22:43 +00003772/*
Hanno Beckera835da52019-05-16 12:39:07 +01003773 * Define ticket header determining Mbed TLS version
3774 * and structure of the ticket.
3775 */
3776
Hanno Becker94ef3b32019-05-16 12:50:45 +01003777/*
Hanno Becker50b59662019-05-28 14:30:45 +01003778 * Define bitflag determining compile-time settings influencing
3779 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003780 */
3781
Hanno Becker50b59662019-05-28 14:30:45 +01003782#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003783#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003784#else
Hanno Becker3e088662019-05-29 11:10:18 +01003785#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003786#endif /* MBEDTLS_HAVE_TIME */
3787
3788#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003789#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003790#else
Hanno Becker3e088662019-05-29 11:10:18 +01003791#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003792#endif /* MBEDTLS_X509_CRT_PARSE_C */
3793
David Horstmann5c5a32f2024-02-13 17:53:35 +00003794#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00003795#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00003796#else
David Horstmannf686f1d2024-03-01 11:20:32 +00003797#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00003798#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3799
Hanno Becker94ef3b32019-05-16 12:50:45 +01003800#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003801#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003802#else
Hanno Becker3e088662019-05-29 11:10:18 +01003803#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003804#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3805
3806#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003807#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003808#else
Hanno Becker3e088662019-05-29 11:10:18 +01003809#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003810#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3811
Hanno Becker94ef3b32019-05-16 12:50:45 +01003812#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003813#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003814#else
Hanno Becker3e088662019-05-29 11:10:18 +01003815#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003816#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3817
Hanno Becker94ef3b32019-05-16 12:50:45 +01003818#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3819#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3820#else
3821#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3822#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3823
David Horstmann92b258b2024-02-13 17:23:34 +00003824#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3825#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
3826#else
3827#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
3828#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3829
3830#if defined(MBEDTLS_SSL_EARLY_DATA)
3831#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
3832#else
3833#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
3834#endif /* MBEDTLS_SSL_EARLY_DATA */
3835
3836#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3837#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
3838#else
3839#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
3840#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3841
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003842#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
3843 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00003844#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
3845#else
3846#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
3847#endif /* MBEDTLS_SSL_ALPN */
3848
Hanno Becker3e088662019-05-29 11:10:18 +01003849#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3850#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3851#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3852#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003853#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3854#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00003855#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00003856#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
3857#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
3858#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00003859#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01003860
Hanno Becker50b59662019-05-28 14:30:45 +01003861#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003862 ((uint16_t) ( \
3863 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3864 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3865 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3866 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3867 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3868 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00003869 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00003870 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
3871 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00003872 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
3873 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
3874 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
3875 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003876 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00003877 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003878 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003879
Chien Wong4e9683e2023-12-28 17:07:43 +08003880static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003881 MBEDTLS_VERSION_MAJOR,
3882 MBEDTLS_VERSION_MINOR,
3883 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003884 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3885 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003886};
Hanno Beckera835da52019-05-16 12:39:07 +01003887
3888/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003889 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003890 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003891 *
David Horstmanncb01b362024-02-29 17:31:46 +00003892 * TLS 1.2 session:
3893 *
3894 * struct {
3895 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
3896 * opaque ticket<0..2^24-1>; // length 0 means no ticket
3897 * uint32 ticket_lifetime;
3898 * #endif
3899 * } ClientOnlyData;
3900 *
3901 * struct {
3902 * #if defined(MBEDTLS_HAVE_TIME)
3903 * uint64 start_time;
3904 * #endif
3905 * uint8 session_id_len; // at most 32
3906 * opaque session_id[32];
3907 * opaque master[48]; // fixed length in the standard
3908 * uint32 verify_result;
3909 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
3910 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
3911 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00003912 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00003913 * opaque peer_cert_digest<0..2^8-1>
3914 * #endif
3915 * select (endpoint) {
3916 * case client: ClientOnlyData;
3917 * case server: uint64 ticket_creation_time;
3918 * };
3919 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3920 * uint8 mfl_code; // up to 255 according to standard
3921 * #endif
3922 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3923 * uint8 encrypt_then_mac; // 0 or 1
3924 * #endif
3925 * } serialized_session_tls12;
3926 *
3927 *
3928 * TLS 1.3 Session:
3929 *
3930 * struct {
3931 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3932 * opaque hostname<0..2^16-1>;
3933 * #endif
3934 * #if defined(MBEDTLS_HAVE_TIME)
3935 * uint64 ticket_reception_time;
3936 * #endif
3937 * uint32 ticket_lifetime;
3938 * opaque ticket<1..2^16-1>;
3939 * } ClientOnlyData;
3940 *
3941 * struct {
3942 * uint32 ticket_age_add;
3943 * uint8 ticket_flags;
3944 * opaque resumption_key<0..255>;
3945 * #if defined(MBEDTLS_SSL_EARLY_DATA)
3946 * uint32 max_early_data_size;
3947 * #endif
3948 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3949 * uint16 record_size_limit;
3950 * #endif
3951 * select ( endpoint ) {
3952 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003953 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00003954 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003955 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00003956 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00003957 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003958 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00003959 * #endif
3960 * };
3961 * } serialized_session_tls13;
3962 *
3963 *
3964 * SSL session:
3965 *
3966 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003967 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003968 * opaque mbedtls_version[3]; // library version: major, minor, patch
3969 * opaque session_format[2]; // library-version specific 16-bit field
3970 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003971 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003972 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003973 * Note: When updating the format, remember to keep
3974 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003975 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003976 * // In this version, `session_format` determines
3977 * // the setting of those compile-time
3978 * // configuration options which influence
3979 * // the structure of mbedtls_ssl_session.
3980 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003981 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003982 * // - TLS 1.2 (0x0303)
3983 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00003984 * uint8_t endpoint;
3985 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003986 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003987 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003988 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003989 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003990 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003991 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003992 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003993 *
3994 * };
3995 *
3996 * } serialized_session;
3997 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003998 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003999
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004000MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004001static int ssl_session_save(const mbedtls_ssl_session *session,
4002 unsigned char omit_header,
4003 unsigned char *buf,
4004 size_t buf_len,
4005 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004006{
4007 unsigned char *p = buf;
4008 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004009 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004010#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4011 size_t out_len;
4012 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4013#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004014 if (session == NULL) {
4015 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4016 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004017
Gilles Peskine449bd832023-01-11 14:50:10 +01004018 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004019 /*
4020 * Add Mbed TLS version identifier
4021 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004022 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004023
Gilles Peskine449bd832023-01-11 14:50:10 +01004024 if (used <= buf_len) {
4025 memcpy(p, ssl_serialized_session_header,
4026 sizeof(ssl_serialized_session_header));
4027 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004028 }
4029 }
4030
4031 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004032 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004033 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004034 used += 1 /* TLS version */
4035 + 1 /* endpoint */
4036 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004037 if (used <= buf_len) {
4038 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004039 *p++ = session->endpoint;
4040 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4041 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004042 }
4043
4044 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004045 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004046 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004047#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004048 case MBEDTLS_SSL_VERSION_TLS1_2:
4049 used += ssl_tls12_session_save(session, p, remaining_len);
4050 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004051#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4052
Jerry Yu251a12e2022-07-13 15:15:48 +08004053#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004054 case MBEDTLS_SSL_VERSION_TLS1_3:
4055 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4056 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4057 return ret;
4058 }
4059 used += out_len;
4060 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004061#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4062
Gilles Peskine449bd832023-01-11 14:50:10 +01004063 default:
4064 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004065 }
4066
4067 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004068 if (used > buf_len) {
4069 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4070 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004071
Gilles Peskine449bd832023-01-11 14:50:10 +01004072 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004073}
4074
4075/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004076 * Public wrapper for ssl_session_save()
4077 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004078int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4079 unsigned char *buf,
4080 size_t buf_len,
4081 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004082{
Gilles Peskine449bd832023-01-11 14:50:10 +01004083 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004084}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004085
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004086/*
4087 * Deserialize session, see mbedtls_ssl_session_save() for format.
4088 *
4089 * This internal version is wrapped by a public function that cleans up in
4090 * case of error, and has an extra option omit_header.
4091 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004092MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004093static int ssl_session_load(mbedtls_ssl_session *session,
4094 unsigned char omit_header,
4095 const unsigned char *buf,
4096 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004097{
4098 const unsigned char *p = buf;
4099 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004100 size_t remaining_len;
4101
4102
Gilles Peskine449bd832023-01-11 14:50:10 +01004103 if (session == NULL) {
4104 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4105 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004106
Gilles Peskine449bd832023-01-11 14:50:10 +01004107 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004108 /*
4109 * Check Mbed TLS version identifier
4110 */
4111
Gilles Peskine449bd832023-01-11 14:50:10 +01004112 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4113 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004114 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004115
4116 if (memcmp(p, ssl_serialized_session_header,
4117 sizeof(ssl_serialized_session_header)) != 0) {
4118 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4119 }
4120 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004121 }
4122
4123 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004124 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004125 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004126 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004127 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4128 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004129 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004130 session->endpoint = *p++;
4131 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4132 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004133
4134 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004135 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004136 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004137#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004138 case MBEDTLS_SSL_VERSION_TLS1_2:
4139 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004140#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4141
Jerry Yu438ddd82022-07-07 06:55:50 +00004142#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004143 case MBEDTLS_SSL_VERSION_TLS1_3:
4144 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004145#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4146
Gilles Peskine449bd832023-01-11 14:50:10 +01004147 default:
4148 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004149 }
4150}
4151
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004152/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004153 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004154 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004155int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4156 const unsigned char *buf,
4157 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004158{
Gilles Peskine449bd832023-01-11 14:50:10 +01004159 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004160
Gilles Peskine449bd832023-01-11 14:50:10 +01004161 if (ret != 0) {
4162 mbedtls_ssl_session_free(session);
4163 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004164
Gilles Peskine449bd832023-01-11 14:50:10 +01004165 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004166}
4167
4168/*
Paul Bakker1961b702013-01-25 14:49:24 +01004169 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004170 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004171MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004172static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004173{
4174 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4175
Ronald Cron66dbf912022-02-02 15:33:46 +01004176 /*
4177 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004178 * that were written into the output buffer by the previous handshake step,
4179 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004180 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4181 * We proceed to the next handshake step only when all data from the
4182 * previous one have been sent to the peer, thus we make sure that this is
4183 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4184 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4185 * we have to wait before to go ahead.
4186 * In the case of TLS 1.3, handshake step handlers do not send data to the
4187 * peer. Data are only sent here and through
4188 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004189 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004190 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004191 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4192 return ret;
4193 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004194
4195#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004196 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4197 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4198 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4199 return ret;
4200 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004201 }
4202#endif /* MBEDTLS_SSL_PROTO_DTLS */
4203
Gilles Peskine449bd832023-01-11 14:50:10 +01004204 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004205}
4206
Gilles Peskine449bd832023-01-11 14:50:10 +01004207int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004208{
Hanno Becker41934dd2021-08-07 19:13:43 +01004209 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004210
Gilles Peskine449bd832023-01-11 14:50:10 +01004211 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004212 ssl->conf == NULL ||
4213 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004214 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4215 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004216 }
4217
Gilles Peskine449bd832023-01-11 14:50:10 +01004218 ret = ssl_prepare_handshake_step(ssl);
4219 if (ret != 0) {
4220 return ret;
4221 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004222
Gilles Peskine449bd832023-01-11 14:50:10 +01004223 ret = mbedtls_ssl_handle_pending_alert(ssl);
4224 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004225 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004226 }
Jerry Yue7047812021-09-13 19:26:39 +08004227
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004228 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4229 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4230 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4231
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004232#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004233 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4234 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004235 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004236
Gilles Peskine449bd832023-01-11 14:50:10 +01004237 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004238 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskinef670ba52025-03-07 15:09:32 +01004239 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004240 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004241 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004242
Ronald Cron9f0fba32022-02-10 16:45:15 +01004243 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004244 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004245 break;
4246
4247 default:
4248#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004249 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4250 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4251 } else {
4252 ret = mbedtls_ssl_handshake_client_step(ssl);
4253 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004254#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004255 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004256#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004257 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004258#endif
4259 }
Jerry Yub9930e72021-08-06 17:11:51 +08004260 }
Ronald Cron6291b232023-03-08 15:51:25 +01004261#endif /* MBEDTLS_SSL_CLI_C */
4262
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004263#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004264 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004265#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4266 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004267 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004268 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004269 ret = mbedtls_ssl_handshake_server_step(ssl);
4270 }
Ronald Cron6291b232023-03-08 15:51:25 +01004271#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4272 ret = mbedtls_ssl_handshake_server_step(ssl);
4273#else
4274 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004275#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004276 }
4277#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004278
Gilles Peskine449bd832023-01-11 14:50:10 +01004279 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004280 /* handshake_step return error. And it is same
4281 * with alert_reason.
4282 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004283 if (ssl->send_alert) {
4284 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004285 goto cleanup;
4286 }
4287 }
4288
4289cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004291}
4292
4293/*
4294 * Perform the SSL handshake
4295 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004296int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004297{
4298 int ret = 0;
4299
Hanno Beckera817ea42020-10-20 15:20:23 +01004300 /* Sanity checks */
4301
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 if (ssl == NULL || ssl->conf == NULL) {
4303 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4304 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004305
Hanno Beckera817ea42020-10-20 15:20:23 +01004306#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004307 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4308 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4309 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4310 "mbedtls_ssl_set_timer_cb() for DTLS"));
4311 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004312 }
4313#endif /* MBEDTLS_SSL_PROTO_DTLS */
4314
Gilles Peskine449bd832023-01-11 14:50:10 +01004315 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004316
Hanno Beckera817ea42020-10-20 15:20:23 +01004317 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004318 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4319 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004320
Gilles Peskine449bd832023-01-11 14:50:10 +01004321 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004322 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 }
Paul Bakker1961b702013-01-25 14:49:24 +01004324 }
4325
Gilles Peskine449bd832023-01-11 14:50:10 +01004326 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004327
Gilles Peskine449bd832023-01-11 14:50:10 +01004328 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004329}
4330
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004331#if defined(MBEDTLS_SSL_RENEGOTIATION)
4332#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004333/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004334 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004335 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004336MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004337static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004338{
Janos Follath865b3eb2019-12-16 11:46:15 +00004339 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004340
Gilles Peskine449bd832023-01-11 14:50:10 +01004341 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004342
4343 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004344 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4345 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004346
Gilles Peskine449bd832023-01-11 14:50:10 +01004347 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4348 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4349 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004350 }
4351
Gilles Peskine449bd832023-01-11 14:50:10 +01004352 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004353
Gilles Peskine449bd832023-01-11 14:50:10 +01004354 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004355}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004356#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004357
4358/*
4359 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004360 * - any side: calling mbedtls_ssl_renegotiate(),
4361 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4362 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004363 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004364 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004365 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004366 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004367int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004368{
Janos Follath865b3eb2019-12-16 11:46:15 +00004369 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004370
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004372
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 if ((ret = ssl_handshake_init(ssl)) != 0) {
4374 return ret;
4375 }
Paul Bakker48916f92012-09-16 19:57:18 +00004376
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004377 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4378 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004379#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004380 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4381 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4382 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004383 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004384 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004385 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004386 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004387 }
4388#endif
4389
Gilles Peskinef670ba52025-03-07 15:09:32 +01004390 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_REQUEST);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004391 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004392
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4394 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4395 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004396 }
4397
Gilles Peskine449bd832023-01-11 14:50:10 +01004398 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004399
Gilles Peskine449bd832023-01-11 14:50:10 +01004400 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004401}
4402
4403/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004404 * Renegotiate current connection on client,
4405 * or request renegotiation on server
4406 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004407int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004408{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004409 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004410
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 if (ssl == NULL || ssl->conf == NULL) {
4412 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4413 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004414
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004415#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004416 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004417 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4418 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4419 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4420 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004421
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004422 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004423
4424 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004425 if (ssl->out_left != 0) {
4426 return mbedtls_ssl_flush_output(ssl);
4427 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004428
Gilles Peskine449bd832023-01-11 14:50:10 +01004429 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004430 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004431#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004432
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004433#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004434 /*
4435 * On client, either start the renegotiation process or,
4436 * if already in progress, continue the handshake
4437 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4439 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4440 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004441 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004442
4443 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4444 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4445 return ret;
4446 }
4447 } else {
4448 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4449 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4450 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004451 }
4452 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004453#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004454
Gilles Peskine449bd832023-01-11 14:50:10 +01004455 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004456}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004457#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004458
Gilles Peskine449bd832023-01-11 14:50:10 +01004459void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004460{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004461 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4462
Gilles Peskine449bd832023-01-11 14:50:10 +01004463 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004464 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004465 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004466
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004467#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Brett Warrene0edc842021-08-17 09:53:13 +01004468#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004469 if (ssl->handshake->group_list_heap_allocated) {
4470 mbedtls_free((void *) handshake->group_list);
4471 }
Brett Warrene0edc842021-08-17 09:53:13 +01004472 handshake->group_list = NULL;
4473#endif /* MBEDTLS_DEPRECATED_REMOVED */
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004474#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Brett Warrene0edc842021-08-17 09:53:13 +01004475
Ronald Crone68ab4f2022-10-05 12:46:29 +02004476#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004477#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004478 if (ssl->handshake->sig_algs_heap_allocated) {
4479 mbedtls_free((void *) handshake->sig_algs);
4480 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004481 handshake->sig_algs = NULL;
4482#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004483#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 if (ssl->handshake->certificate_request_context) {
4485 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004486 }
4487#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004488#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004489
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004490#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Ben Taylorcd2660f2025-03-21 13:13:29 +00004491 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
Ben Taylorc12152e2025-03-21 11:03:04 +00004492 ssl->conf->f_async_cancel(ssl);
4493 handshake->async_in_progress = 0;
Ben Taylor1cd1e012025-03-18 11:50:39 +00004494 }
Ben Taylor6ff2da12025-03-17 09:26:20 +00004495
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004496#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4497
Elena Uziunaite0916cd72024-05-23 17:01:07 +01004498#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01004499 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004500#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01004501#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004503#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004504
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004505#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004507 /*
4508 * Opaque keys are not stored in the handshake's data and it's the user
4509 * responsibility to destroy them. Clear ones, instead, are created by
4510 * the TLS library and should be destroyed at the same level
4511 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4513 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004514 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004515 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004516#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004517 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004518 handshake->ecjpake_cache = NULL;
4519 handshake->ecjpake_cache_len = 0;
4520#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004521#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004522
Valerio Setti7aeec542023-07-05 18:57:21 +02004523#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004524 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004525 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004526 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004528#endif
4529
Ronald Cron73fe8df2022-10-05 14:31:43 +02004530#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004532 /* The maintenance of the external PSK key slot is the
4533 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 if (ssl->handshake->psk_opaque_is_internal) {
4535 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004536 ssl->handshake->psk_opaque_is_internal = 0;
4537 }
4538 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4539 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02004540#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004541
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004542#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4543 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004544 /*
4545 * Free only the linked list wrapper, not the keys themselves
4546 * since the belong to the SNI callback
4547 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004548 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004549#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004550
Gilles Peskineeccd8882020-03-10 12:19:08 +01004551#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004552 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4553 if (handshake->ecrs_peer_cert != NULL) {
4554 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4555 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004556 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004557#endif
4558
Hanno Becker75173122019-02-06 16:18:31 +00004559#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4560 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004561 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004562#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4563
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004564#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004565 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4566 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004567#endif /* MBEDTLS_SSL_CLI_C &&
4568 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004569
4570#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004571 mbedtls_ssl_flight_free(handshake->flight);
4572 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004573#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004574
Valerio Settiea59c432023-07-25 11:14:03 +02004575#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004576 if (handshake->xxdh_psa_privkey_is_external == 0) {
4577 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004578 }
Valerio Settiea59c432023-07-25 11:14:03 +02004579#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004580
Ronald Cron6f135e12021-12-08 16:57:54 +01004581#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004582 mbedtls_ssl_transform_free(handshake->transform_handshake);
4583 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004584#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004585 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4586 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004587#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004588#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004589
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004590
4591#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4592 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4593 * processes datagrams and the fact that a datagram is allowed to have
4594 * several records in it, it is possible that the I/O buffers are not
4595 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004596 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4597 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004598#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004599
Jerry Yuba9c7272021-10-30 11:54:10 +08004600 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 mbedtls_platform_zeroize(handshake,
4602 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004603}
4604
Gilles Peskine449bd832023-01-11 14:50:10 +01004605void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004606{
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004608 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004609 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004610
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004611#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004612 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004613#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004614
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004615#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004616#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4617 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004618 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004619#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004620 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004621#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004622
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004623#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4624 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004625 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004626#endif
4627
Gilles Peskine449bd832023-01-11 14:50:10 +01004628 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004629}
4630
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004631#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004632
4633#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4634#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4635#else
4636#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4637#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4638
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004639#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004640
4641#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4642#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4643#else
4644#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4645#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4646
4647#if defined(MBEDTLS_SSL_ALPN)
4648#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4649#else
4650#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4651#endif /* MBEDTLS_SSL_ALPN */
4652
4653#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4654#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4655#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4656#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4657
4658#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004659 ((uint32_t) ( \
4660 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4661 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4662 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4663 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4664 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4665 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4666 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4667 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004668
Chien Wong4e9683e2023-12-28 17:07:43 +08004669static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004670 MBEDTLS_VERSION_MAJOR,
4671 MBEDTLS_VERSION_MINOR,
4672 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4674 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4675 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4676 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4677 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004678};
4679
Paul Bakker5121ce52009-01-03 21:22:43 +00004680/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004681 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004682 *
4683 * The format of the serialized data is:
4684 * (in the presentation language of TLS, RFC 8446 section 3)
4685 *
4686 * // header
4687 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004688 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004689 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004690 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004691 * Note: When updating the format, remember to keep these
4692 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004693 *
4694 * // session sub-structure
4695 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4696 * // transform sub-structure
4697 * uint8 random[64]; // ServerHello.random+ClientHello.random
4698 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4699 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4700 * // fields from ssl_context
4701 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4702 * uint64 in_window_top; // DTLS: last validated record seq_num
4703 * uint64 in_window; // DTLS: bitmask for replay protection
4704 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4705 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4706 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4707 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4708 *
4709 * Note that many fields of the ssl_context or sub-structures are not
4710 * serialized, as they fall in one of the following categories:
4711 *
4712 * 1. forced value (eg in_left must be 0)
4713 * 2. pointer to dynamically-allocated memory (eg session, transform)
4714 * 3. value can be re-derived from other data (eg session keys from MS)
4715 * 4. value was temporary (eg content of input buffer)
4716 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004717 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004718int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4719 unsigned char *buf,
4720 size_t buf_len,
4721 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004722{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004723 unsigned char *p = buf;
4724 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004725 size_t session_len;
4726 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004727
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004728 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004729 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4730 * this function's documentation.
4731 *
4732 * These are due to assumptions/limitations in the implementation. Some of
4733 * them are likely to stay (no handshake in progress) some might go away
4734 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004735 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004736 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4738 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4739 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004740 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004741 if (ssl->handshake != NULL) {
4742 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4743 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004744 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004745 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004746 if (ssl->transform == NULL || ssl->session == NULL) {
4747 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4748 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004749 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004750 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004751 if (mbedtls_ssl_check_pending(ssl) != 0) {
4752 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4753 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004754 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 if (ssl->out_left != 0) {
4756 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4757 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004758 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004759 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004760 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4761 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4762 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004763 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004764 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004765 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4766 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4767 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004768 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004769 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004770 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4771 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4772 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004773 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004774 /* Renegotiation must not be enabled */
4775#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004776 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4777 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4778 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004779 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004780#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004781
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004782 /*
4783 * Version and format identifier
4784 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004785 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004786
Gilles Peskine449bd832023-01-11 14:50:10 +01004787 if (used <= buf_len) {
4788 memcpy(p, ssl_serialized_context_header,
4789 sizeof(ssl_serialized_context_header));
4790 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004791 }
4792
4793 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004794 * Session (length + data)
4795 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004796 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4797 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4798 return ret;
4799 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004800
4801 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 if (used <= buf_len) {
4803 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004804 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004805
Gilles Peskine449bd832023-01-11 14:50:10 +01004806 ret = ssl_session_save(ssl->session, 1,
4807 p, session_len, &session_len);
4808 if (ret != 0) {
4809 return ret;
4810 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004811
4812 p += session_len;
4813 }
4814
4815 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004816 * Transform
4817 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 used += sizeof(ssl->transform->randbytes);
4819 if (used <= buf_len) {
4820 memcpy(p, ssl->transform->randbytes,
4821 sizeof(ssl->transform->randbytes));
4822 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004823 }
4824
4825#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004826 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004828 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004830 p += ssl->transform->in_cid_len;
4831
4832 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004834 p += ssl->transform->out_cid_len;
4835 }
4836#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4837
4838 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004839 * Saved fields from top-level ssl_context structure
4840 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004841 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004842 if (used <= buf_len) {
4843 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004844 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004845 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004846
4847#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4848 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004849 if (used <= buf_len) {
4850 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004851 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004852
Gilles Peskine449bd832023-01-11 14:50:10 +01004853 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004854 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004855 }
4856#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4857
4858#if defined(MBEDTLS_SSL_PROTO_DTLS)
4859 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004861 *p++ = ssl->disable_datagram_packing;
4862 }
4863#endif /* MBEDTLS_SSL_PROTO_DTLS */
4864
Jerry Yuae0b2e22021-10-08 15:21:19 +08004865 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 if (used <= buf_len) {
4867 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004868 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004869 }
4870
4871#if defined(MBEDTLS_SSL_PROTO_DTLS)
4872 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 if (used <= buf_len) {
4874 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004875 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004876 }
4877#endif /* MBEDTLS_SSL_PROTO_DTLS */
4878
4879#if defined(MBEDTLS_SSL_ALPN)
4880 {
4881 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004883 : 0;
4884
4885 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004886 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004887 *p++ = alpn_len;
4888
Gilles Peskine449bd832023-01-11 14:50:10 +01004889 if (ssl->alpn_chosen != NULL) {
4890 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004891 p += alpn_len;
4892 }
4893 }
4894 }
4895#endif /* MBEDTLS_SSL_ALPN */
4896
4897 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004898 * Done
4899 */
4900 *olen = used;
4901
Gilles Peskine449bd832023-01-11 14:50:10 +01004902 if (used > buf_len) {
4903 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4904 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004905
Gilles Peskine449bd832023-01-11 14:50:10 +01004906 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004907
Gilles Peskine449bd832023-01-11 14:50:10 +01004908 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004909}
4910
4911/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004912 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004913 *
4914 * This internal version is wrapped by a public function that cleans up in
4915 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004916 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004917MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004918static int ssl_context_load(mbedtls_ssl_context *ssl,
4919 const unsigned char *buf,
4920 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004921{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004922 const unsigned char *p = buf;
4923 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004924 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004925 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004926#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004927 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004928#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004929
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004930 /*
4931 * The context should have been freshly setup or reset.
4932 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004933 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004934 * renegotiating, or if the user mistakenly loaded a session first.)
4935 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004936 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4937 ssl->session != NULL) {
4938 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004939 }
4940
4941 /*
4942 * We can't check that the config matches the initial one, but we can at
4943 * least check it matches the requirements for serializing.
4944 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004945 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004946#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004947 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004948#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004949 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4950 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4951 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4952 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004954 }
4955
Gilles Peskine449bd832023-01-11 14:50:10 +01004956 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004957
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004958 /*
4959 * Check version identifier
4960 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004961 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4962 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004963 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004964
4965 if (memcmp(p, ssl_serialized_context_header,
4966 sizeof(ssl_serialized_context_header)) != 0) {
4967 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4968 }
4969 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004970
4971 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004972 * Session
4973 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004974 if ((size_t) (end - p) < 4) {
4975 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4976 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004977
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004978 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004979 p += 4;
4980
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004981 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004982 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004983 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004984 ssl->session_in = ssl->session;
4985 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004986 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004987
Gilles Peskine449bd832023-01-11 14:50:10 +01004988 if ((size_t) (end - p) < session_len) {
4989 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4990 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004991
Gilles Peskine449bd832023-01-11 14:50:10 +01004992 ret = ssl_session_load(ssl->session, 1, p, session_len);
4993 if (ret != 0) {
4994 mbedtls_ssl_session_free(ssl->session);
4995 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004996 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004997
4998 p += session_len;
4999
5000 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005001 * Transform
5002 */
5003
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005004 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005005 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005006#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005007 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005008 ssl->transform_in = ssl->transform;
5009 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005010 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005011#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005012
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005013#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005014 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5015 if (prf_func == NULL) {
5016 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5017 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005018
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005019 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005020 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5021 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5022 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005023
Gilles Peskine449bd832023-01-11 14:50:10 +01005024 ret = ssl_tls12_populate_transform(ssl->transform,
5025 ssl->session->ciphersuite,
5026 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005027#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005028 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005029#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005030 prf_func,
5031 p, /* currently pointing to randbytes */
5032 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5033 ssl->conf->endpoint,
5034 ssl);
5035 if (ret != 0) {
5036 return ret;
5037 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005038#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005039 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005040
5041#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5042 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005043 if ((size_t) (end - p) < 1) {
5044 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5045 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005046
5047 ssl->transform->in_cid_len = *p++;
5048
Gilles Peskine449bd832023-01-11 14:50:10 +01005049 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5050 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5051 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005052
Gilles Peskine449bd832023-01-11 14:50:10 +01005053 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005054 p += ssl->transform->in_cid_len;
5055
5056 ssl->transform->out_cid_len = *p++;
5057
Gilles Peskine449bd832023-01-11 14:50:10 +01005058 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5059 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5060 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005061
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005063 p += ssl->transform->out_cid_len;
5064#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5065
5066 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005067 * Saved fields from top-level ssl_context structure
5068 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005069 if ((size_t) (end - p) < 4) {
5070 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5071 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005072
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005073 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005074 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005075
5076#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 if ((size_t) (end - p) < 16) {
5078 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5079 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005080
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005081 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005082 p += 8;
5083
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005084 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005085 p += 8;
5086#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5087
5088#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005089 if ((size_t) (end - p) < 1) {
5090 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5091 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005092
5093 ssl->disable_datagram_packing = *p++;
5094#endif /* MBEDTLS_SSL_PROTO_DTLS */
5095
Gilles Peskine449bd832023-01-11 14:50:10 +01005096 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5097 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5098 }
5099 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5100 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005101
5102#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005103 if ((size_t) (end - p) < 2) {
5104 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5105 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005106
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005107 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005108 p += 2;
5109#endif /* MBEDTLS_SSL_PROTO_DTLS */
5110
5111#if defined(MBEDTLS_SSL_ALPN)
5112 {
5113 uint8_t alpn_len;
5114 const char **cur;
5115
Gilles Peskine449bd832023-01-11 14:50:10 +01005116 if ((size_t) (end - p) < 1) {
5117 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5118 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005119
5120 alpn_len = *p++;
5121
Gilles Peskine449bd832023-01-11 14:50:10 +01005122 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005123 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005124 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5125 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005126 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005127 ssl->alpn_chosen = *cur;
5128 break;
5129 }
5130 }
5131 }
5132
5133 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005134 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5135 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5136 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005137
5138 p += alpn_len;
5139 }
5140#endif /* MBEDTLS_SSL_ALPN */
5141
5142 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005143 * Forced fields from top-level ssl_context structure
5144 *
5145 * Most of them already set to the correct value by mbedtls_ssl_init() and
5146 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5147 */
Gilles Peskinef670ba52025-03-07 15:09:32 +01005148 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Glenn Strauss60bfe602022-03-14 19:04:24 -04005149 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005150
Hanno Becker361b10d2019-08-30 10:42:49 +01005151 /* Adjust pointers for header fields of outgoing records to
5152 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005153 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005154
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005155#if defined(MBEDTLS_SSL_PROTO_DTLS)
5156 ssl->in_epoch = 1;
5157#endif
5158
5159 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5160 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005161 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5162 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005163 if (ssl->handshake != NULL) {
5164 mbedtls_ssl_handshake_free(ssl);
5165 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005166 ssl->handshake = NULL;
5167 }
5168
5169 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005170 * Done - should have consumed entire buffer
5171 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005172 if (p != end) {
5173 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5174 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005175
Gilles Peskine449bd832023-01-11 14:50:10 +01005176 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005177}
5178
5179/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005180 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005181 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005182int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5183 const unsigned char *buf,
5184 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005185{
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005187
Gilles Peskine449bd832023-01-11 14:50:10 +01005188 if (ret != 0) {
5189 mbedtls_ssl_free(context);
5190 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005191
Gilles Peskine449bd832023-01-11 14:50:10 +01005192 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005193}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005194#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005195
5196/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005197 * Free an SSL context
5198 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005199void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005200{
Gilles Peskine449bd832023-01-11 14:50:10 +01005201 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005202 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005203 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005204
Gilles Peskine449bd832023-01-11 14:50:10 +01005205 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005206
Gilles Peskine449bd832023-01-11 14:50:10 +01005207 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005208#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5209 size_t out_buf_len = ssl->out_buf_len;
5210#else
5211 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5212#endif
5213
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005214 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005215 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005216 }
5217
Gilles Peskine449bd832023-01-11 14:50:10 +01005218 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005219#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5220 size_t in_buf_len = ssl->in_buf_len;
5221#else
5222 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5223#endif
5224
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005225 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005226 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005227 }
5228
Gilles Peskine449bd832023-01-11 14:50:10 +01005229 if (ssl->transform) {
5230 mbedtls_ssl_transform_free(ssl->transform);
5231 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005232 }
5233
Gilles Peskine449bd832023-01-11 14:50:10 +01005234 if (ssl->handshake) {
5235 mbedtls_ssl_handshake_free(ssl);
5236 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005237
5238#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005239 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5240 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005241#endif
5242
Gilles Peskine449bd832023-01-11 14:50:10 +01005243 mbedtls_ssl_session_free(ssl->session_negotiate);
5244 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005245 }
5246
Ronald Cron6f135e12021-12-08 16:57:54 +01005247#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005248 mbedtls_ssl_transform_free(ssl->transform_application);
5249 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005250#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005251
Gilles Peskine449bd832023-01-11 14:50:10 +01005252 if (ssl->session) {
5253 mbedtls_ssl_session_free(ssl->session);
5254 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005255 }
5256
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005257#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine4ac40082025-02-20 18:13:58 +01005258 mbedtls_ssl_free_hostname(ssl);
Paul Bakker0be444a2013-08-27 21:55:01 +02005259#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005260
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005261#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005262 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005263#endif
5264
Gilles Peskine449bd832023-01-11 14:50:10 +01005265 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005266
Paul Bakker86f04f42013-02-14 11:20:09 +01005267 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005268 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005269}
5270
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005271/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005272 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005273 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005274void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005275{
Gilles Peskine449bd832023-01-11 14:50:10 +01005276 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005277}
5278
Gilles Peskineae270bf2021-06-02 00:05:29 +02005279/* The selection should be the same as mbedtls_x509_crt_profile_default in
5280 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005281 * curves with a lower resource usage come first.
Manuel Pégourié-Gonnard93d45912025-01-14 11:45:44 +01005282 * See the documentation of mbedtls_ssl_conf_groups() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005283 * about this list.
5284 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005285static const uint16_t ssl_preset_default_groups[] = {
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005286#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Brett Warrene0edc842021-08-17 09:53:13 +01005287 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005288#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005289#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005290 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005291#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005292#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005293 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005294#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005295#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Brett Warrene0edc842021-08-17 09:53:13 +01005296 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005297#endif
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005298#if defined(PSA_WANT_ECC_SECP_R1_521)
Brett Warrene0edc842021-08-17 09:53:13 +01005299 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005300#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005301#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005302 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005303#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005304#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005305 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005306#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005307#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Brett Warrene0edc842021-08-17 09:53:13 +01005308 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005309#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005310#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005311 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5312 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5313 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5314 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5315 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5316#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005317 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005318};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005319
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005320static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005321 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5322 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5323 0
5324};
5325
Ronald Crone68ab4f2022-10-05 12:46:29 +02005326#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005327
Jerry Yu909df7b2022-01-22 11:56:27 +08005328/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005329 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005330 * rules SHOULD be upheld.
5331 * - No duplicate entries.
5332 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005333 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005334 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005335 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005336static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005337
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005338#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005339 defined(PSA_WANT_ALG_SHA_256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005340 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005341 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005342 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5343#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005344
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005345#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005346 defined(PSA_WANT_ALG_SHA_384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005347 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005348 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005349 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5350#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005351
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005352#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Gabor Mezeic15ef932024-06-13 12:53:54 +02005353 defined(PSA_WANT_ALG_SHA_512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005354 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005355 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005356 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5357#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005358
Gabor Mezeic15ef932024-06-13 12:53:54 +02005359#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005360 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005361#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005362
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005363#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005364 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005365#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005366
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005367#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005368 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005369#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005370
Gabor Mezeic15ef932024-06-13 12:53:54 +02005371#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005372 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Gabor Mezeic15ef932024-06-13 12:53:54 +02005373#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005374
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005375#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005376 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005377#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005378
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005379#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005380 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005381#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005382
Gabor Mezei15b95a62022-05-09 16:37:58 +02005383 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005384};
5385
5386/* NOTICE: see above */
5387#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Deomid rojer Ryabkove2d71cc2024-03-18 12:32:30 +00005388static const uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005389
Gabor Mezeic15ef932024-06-13 12:53:54 +02005390#if defined(PSA_WANT_ALG_SHA_512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005391#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005393#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005394#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5395 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005396#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005397#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005398 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005399#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005400#endif /* PSA_WANT_ALG_SHA_512 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005401
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005402#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005403#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005405#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005406#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5407 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005408#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005409#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005410 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005411#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005412#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005413
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005414#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005415#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005417#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005418#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5419 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005420#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005421#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005422 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005423#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005424#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005425
Gabor Mezei15b95a62022-05-09 16:37:58 +02005426 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005427};
5428#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005429
Jerry Yu909df7b2022-01-22 11:56:27 +08005430/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005431static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005432
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005433#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005434 defined(PSA_WANT_ALG_SHA_256) && \
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005435 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005436 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005437 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5438#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005439
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005440#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005441 defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005442 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu53037892022-01-25 11:02:06 +08005443 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005444 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5445#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005446
Gabor Mezei15b95a62022-05-09 16:37:58 +02005447 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005448};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005449
Jerry Yu909df7b2022-01-22 11:56:27 +08005450/* NOTICE: see above */
5451#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Deomid rojer Ryabkov7dddc172024-03-20 00:43:34 +00005452static const uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005453
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005454#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005455#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005456 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005457#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005458#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005459
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005460#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005461#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005462 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005463#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005464#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005465
Gabor Mezei15b95a62022-05-09 16:37:58 +02005466 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005467};
Jerry Yu909df7b2022-01-22 11:56:27 +08005468#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5469
Ronald Crone68ab4f2022-10-05 12:46:29 +02005470#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005471
Chien Wong4e9683e2023-12-28 17:07:43 +08005472static const uint16_t ssl_preset_suiteb_groups[] = {
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005473#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005474 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005475#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005476#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005477 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005478#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005479 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005480};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005481
Ronald Crone68ab4f2022-10-05 12:46:29 +02005482#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005483/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005484 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005485MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005486static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005487{
5488 size_t i, j;
5489 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005490
Gilles Peskine449bd832023-01-11 14:50:10 +01005491 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5492 for (j = 0; j < i; j++) {
5493 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005494 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005495 }
5496 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5497 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5498 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005499 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005500 }
5501 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005503}
5504
Ronald Crone68ab4f2022-10-05 12:46:29 +02005505#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005506
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005507/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005508 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005509 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005510int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5511 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005512{
Ronald Crone68ab4f2022-10-05 12:46:29 +02005513#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005514 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5515 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5516 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005517 }
5518
Gilles Peskine449bd832023-01-11 14:50:10 +01005519 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5520 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5521 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005522 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005523
5524#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5526 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5527 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005528 }
5529
Gilles Peskine449bd832023-01-11 14:50:10 +01005530 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5531 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5532 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005533 }
5534#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005535#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005536
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005537 /* Use the functions here so that they are covered in tests,
5538 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005539 mbedtls_ssl_conf_endpoint(conf, endpoint);
5540 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005541
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005542 /*
5543 * Things that are common to all presets
5544 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005545#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005546 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005547 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5548#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5549 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5550#endif
5551 }
5552#endif
5553
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005554#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5555 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5556#endif
5557
5558#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5559 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5560#endif
5561
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005562#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005563 conf->f_cookie_write = ssl_cookie_write_dummy;
5564 conf->f_cookie_check = ssl_cookie_check_dummy;
5565#endif
5566
5567#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5568 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5569#endif
5570
Janos Follath088ce432017-04-10 12:42:31 +01005571#if defined(MBEDTLS_SSL_SRV_C)
5572 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005573 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005574#endif
5575
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005576#if defined(MBEDTLS_SSL_PROTO_DTLS)
5577 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5578 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5579#endif
5580
5581#if defined(MBEDTLS_SSL_RENEGOTIATION)
5582 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005583 memset(conf->renego_period, 0x00, 2);
5584 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005585#endif
5586
Ronald Cron6f135e12021-12-08 16:57:54 +01005587#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005588
5589#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005590 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005591#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005592 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005593#endif
5594#endif /* MBEDTLS_SSL_EARLY_DATA */
5595
Jerry Yud0766ec2022-09-22 10:46:57 +08005596#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005597 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005598 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005599#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005600 /*
5601 * Allow all TLS 1.3 key exchange modes by default.
5602 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005603 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005604#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005605
Gilles Peskine449bd832023-01-11 14:50:10 +01005606 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005607#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005608 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005609 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005610#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005611 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005612#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005613 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005614#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005615 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5616 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005617#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5618 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5619 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5620#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5621 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5622 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5623#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005624 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005625#endif
5626 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005627
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005628 /*
5629 * Preset-specific defaults
5630 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005631 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005632 /*
5633 * NSA Suite B
5634 */
5635 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005636
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005637 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005638
5639#if defined(MBEDTLS_X509_CRT_PARSE_C)
5640 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005641#endif
5642
Ronald Crone68ab4f2022-10-05 12:46:29 +02005643#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005644#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005645 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005646 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005647 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005648#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005649 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005650#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005651
Brett Warrene0edc842021-08-17 09:53:13 +01005652 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005653 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005654
5655 /*
5656 * Default
5657 */
5658 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005659
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005660 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005661
5662#if defined(MBEDTLS_X509_CRT_PARSE_C)
5663 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5664#endif
5665
Ronald Crone68ab4f2022-10-05 12:46:29 +02005666#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005667#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005668 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005669 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005670 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005671#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005672 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005673#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005674
Brett Warrene0edc842021-08-17 09:53:13 +01005675 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005676 }
5677
Gilles Peskine449bd832023-01-11 14:50:10 +01005678 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005679}
5680
5681/*
5682 * Free mbedtls_ssl_config
5683 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005684void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005685{
Troy-Butlerda73abc2024-04-02 13:37:31 -04005686 if (conf == NULL) {
5687 return;
5688 }
5689
Ronald Cron73fe8df2022-10-05 14:31:43 +02005690#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005691 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005692 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5693 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005694 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005695 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005696 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005697 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005698 }
5699
Gilles Peskine449bd832023-01-11 14:50:10 +01005700 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005701 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005702 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005703 conf->psk_identity_len = 0;
5704 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005705#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005706
5707#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005708 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005709#endif
5710
Gilles Peskine449bd832023-01-11 14:50:10 +01005711 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005712}
5713
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005714#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005715 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005716/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005717 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005718 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005719unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005720{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005721#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005722 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5723 return MBEDTLS_SSL_SIG_RSA;
5724 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005725#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005726#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005727 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5728 return MBEDTLS_SSL_SIG_ECDSA;
5729 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005730#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005731 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005732}
5733
Gilles Peskine449bd832023-01-11 14:50:10 +01005734unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005735{
Gilles Peskine449bd832023-01-11 14:50:10 +01005736 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005737 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005738 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005739 case MBEDTLS_PK_ECDSA:
5740 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005741 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005742 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005743 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005744 }
5745}
5746
Gilles Peskine449bd832023-01-11 14:50:10 +01005747mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005748{
Gilles Peskine449bd832023-01-11 14:50:10 +01005749 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005750#if defined(MBEDTLS_RSA_C)
5751 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005752 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005753#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005754#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005755 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005756 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005757#endif
5758 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005759 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005760 }
5761}
Valerio Settie9646ec2023-08-02 20:02:28 +02005762#endif /* MBEDTLS_PK_C &&
5763 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005764
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005765/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005766 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005767 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005768mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005769{
Gilles Peskine449bd832023-01-11 14:50:10 +01005770 switch (hash) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005771#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005772 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005773 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005774#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005775#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005776 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005777 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005778#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005779#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005780 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005781 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005782#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005783#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005784 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005785 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005786#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005787#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005788 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005789 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005790#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005791#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005792 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005793 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005794#endif
5795 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005796 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005797 }
5798}
5799
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005800/*
5801 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5802 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005803unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005804{
Gilles Peskine449bd832023-01-11 14:50:10 +01005805 switch (md) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005806#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005807 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005808 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005809#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005810#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005811 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005812 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005813#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005814#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005815 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005816 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005817#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005818#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005819 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005820 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005821#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005822#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005823 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005824 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005825#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005826#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005827 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005828 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005829#endif
5830 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005831 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005832 }
5833}
5834
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005835/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005836 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005837 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005838 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005839int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005840{
Manuel Pégourié-Gonnard6402c352025-01-14 12:23:56 +01005841 const uint16_t *group_list = ssl->conf->group_list;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005842
Gilles Peskine449bd832023-01-11 14:50:10 +01005843 if (group_list == NULL) {
5844 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005845 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005846
Gilles Peskine449bd832023-01-11 14:50:10 +01005847 for (; *group_list != 0; group_list++) {
5848 if (*group_list == tls_id) {
5849 return 0;
5850 }
5851 }
5852
5853 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005854}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005855
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005856#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005857/*
5858 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5859 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005860int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005861{
Gilles Peskine449bd832023-01-11 14:50:10 +01005862 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005863
Gilles Peskine449bd832023-01-11 14:50:10 +01005864 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005865 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005866 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005867
Gilles Peskine449bd832023-01-11 14:50:10 +01005868 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005869}
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005870#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Valerio Setti67419f02023-01-04 16:12:42 +01005871
Valerio Setti18c9fed2022-12-30 17:44:24 +01005872static const struct {
5873 uint16_t tls_id;
5874 mbedtls_ecp_group_id ecp_group_id;
5875 psa_ecc_family_t psa_family;
5876 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005877} tls_id_match_table[] =
5878{
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005879#if defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02005880 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005881#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005882#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02005883 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005884#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005885#if defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005886 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005887#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005888#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005889 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005890#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005891#if defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005892 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005893#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005894#if defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005895 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005896#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005897#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005898 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005899#endif
Elena Uziunaiteeaa0cf02024-07-04 17:41:25 +01005900#if defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02005901 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005902#endif
Elena Uziunaitea3632862024-07-04 13:52:43 +01005903#if defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005904 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005905#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005906#if defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005907 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005908#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005909#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02005910 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005911#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005912#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005913 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005914#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005915 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005916};
5917
Gilles Peskine449bd832023-01-11 14:50:10 +01005918int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005919 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005920 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005921{
Gilles Peskine449bd832023-01-11 14:50:10 +01005922 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5923 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005924 if (type != NULL) {
5925 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005926 }
5927 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005928 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005929 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005930 return PSA_SUCCESS;
5931 }
5932 }
5933
5934 return PSA_ERROR_NOT_SUPPORTED;
5935}
5936
Gilles Peskine449bd832023-01-11 14:50:10 +01005937mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005938{
Gilles Peskine449bd832023-01-11 14:50:10 +01005939 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5940 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005941 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005942 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005943 }
5944
5945 return MBEDTLS_ECP_DP_NONE;
5946}
5947
Gilles Peskine449bd832023-01-11 14:50:10 +01005948uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005949{
Gilles Peskine449bd832023-01-11 14:50:10 +01005950 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5951 i++) {
5952 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005953 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005954 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005955 }
5956
5957 return 0;
5958}
5959
Valerio Setti67419f02023-01-04 16:12:42 +01005960#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005961static const struct {
5962 uint16_t tls_id;
5963 const char *name;
5964} tls_id_curve_name_table[] =
5965{
Valerio Setti54e23792023-07-07 10:49:27 +02005966 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5967 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5968 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5969 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5970 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5971 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5972 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5973 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5974 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5975 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5976 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5977 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5978 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005979 { 0, NULL },
5980};
5981
Gilles Peskine449bd832023-01-11 14:50:10 +01005982const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005983{
Valerio Settiacd32c02023-06-29 18:06:29 +02005984 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5985 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5986 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005987 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005988 }
5989
5990 return NULL;
5991}
Valerio Setti67419f02023-01-04 16:12:42 +01005992#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005993
Gilles Peskine449bd832023-01-11 14:50:10 +01005994int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5995 const mbedtls_md_type_t md,
5996 unsigned char *dst,
5997 size_t dst_len,
5998 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005999{
Ronald Cronf6893e12022-01-07 22:09:01 +01006000 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6001 psa_hash_operation_t *hash_operation_to_clone;
6002 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6003
Jerry Yu148165c2021-09-24 23:20:59 +08006004 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006005
Gilles Peskine449bd832023-01-11 14:50:10 +01006006 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006007#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006008 case MBEDTLS_MD_SHA384:
6009 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6010 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006011#endif
6012
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006013#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006014 case MBEDTLS_MD_SHA256:
6015 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6016 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006017#endif
6018
Gilles Peskine449bd832023-01-11 14:50:10 +01006019 default:
6020 goto exit;
6021 }
6022
6023 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6024 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006025 goto exit;
6026 }
6027
Gilles Peskine449bd832023-01-11 14:50:10 +01006028 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6029 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006030 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006031 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006032
6033exit:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006034#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006035 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006036 (void) ssl;
6037#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006038 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006039}
Jerry Yu24c0ec32021-09-09 14:21:07 +08006040
Ronald Crone68ab4f2022-10-05 12:46:29 +02006041#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006042/* mbedtls_ssl_parse_sig_alg_ext()
6043 *
6044 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6045 * value (TLS 1.3 RFC8446):
6046 * enum {
6047 * ....
6048 * ecdsa_secp256r1_sha256( 0x0403 ),
6049 * ecdsa_secp384r1_sha384( 0x0503 ),
6050 * ecdsa_secp521r1_sha512( 0x0603 ),
6051 * ....
6052 * } SignatureScheme;
6053 *
6054 * struct {
6055 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6056 * } SignatureSchemeList;
6057 *
6058 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6059 * value (TLS 1.2 RFC5246):
6060 * enum {
6061 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6062 * sha512(6), (255)
6063 * } HashAlgorithm;
6064 *
6065 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6066 * SignatureAlgorithm;
6067 *
6068 * struct {
6069 * HashAlgorithm hash;
6070 * SignatureAlgorithm signature;
6071 * } SignatureAndHashAlgorithm;
6072 *
6073 * SignatureAndHashAlgorithm
6074 * supported_signature_algorithms<2..2^16-2>;
6075 *
6076 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6077 * generalization of the TLS 1.2 signature algorithm extension.
6078 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6079 * `SignatureScheme` field of TLS 1.3
6080 *
6081 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006082int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6083 const unsigned char *buf,
6084 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006085{
6086 const unsigned char *p = buf;
6087 size_t supported_sig_algs_len = 0;
6088 const unsigned char *supported_sig_algs_end;
6089 uint16_t sig_alg;
6090 uint32_t common_idx = 0;
6091
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6093 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006094 p += 2;
6095
Gilles Peskine449bd832023-01-11 14:50:10 +01006096 memset(ssl->handshake->received_sig_algs, 0,
6097 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006098
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006100 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 while (p < supported_sig_algs_end) {
6102 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6103 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006104 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6106 sig_alg,
6107 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006108#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006109 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6110 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6111 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006112 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006113 }
6114#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006115
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6117 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006118
Gilles Peskine449bd832023-01-11 14:50:10 +01006119 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006120 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6121 common_idx += 1;
6122 }
6123 }
6124 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006125 if (p != end) {
6126 MBEDTLS_SSL_DEBUG_MSG(1,
6127 ("Signature algorithms extension length misaligned"));
6128 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6129 MBEDTLS_ERR_SSL_DECODE_ERROR);
6130 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006131 }
6132
Gilles Peskine449bd832023-01-11 14:50:10 +01006133 if (common_idx == 0) {
6134 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6135 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6136 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6137 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006138 }
6139
Gabor Mezei15b95a62022-05-09 16:37:58 +02006140 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006141 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006142}
6143
Ronald Crone68ab4f2022-10-05 12:46:29 +02006144#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006145
Jerry Yudc7bd172022-02-17 13:44:15 +08006146#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6147
Jerry Yudc7bd172022-02-17 13:44:15 +08006148
Gilles Peskine449bd832023-01-11 14:50:10 +01006149static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6150 mbedtls_svc_key_id_t key,
6151 psa_algorithm_t alg,
6152 const unsigned char *raw_psk, size_t raw_psk_length,
6153 const unsigned char *seed, size_t seed_length,
6154 const unsigned char *label, size_t label_length,
6155 const unsigned char *other_secret,
6156 size_t other_secret_length,
6157 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006158{
6159 psa_status_t status;
6160
Gilles Peskine449bd832023-01-11 14:50:10 +01006161 status = psa_key_derivation_setup(derivation, alg);
6162 if (status != PSA_SUCCESS) {
6163 return status;
6164 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006165
Gilles Peskine449bd832023-01-11 14:50:10 +01006166 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6167 status = psa_key_derivation_input_bytes(derivation,
6168 PSA_KEY_DERIVATION_INPUT_SEED,
6169 seed, seed_length);
6170 if (status != PSA_SUCCESS) {
6171 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006172 }
6173
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 if (other_secret != NULL) {
6175 status = psa_key_derivation_input_bytes(derivation,
6176 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6177 other_secret, other_secret_length);
6178 if (status != PSA_SUCCESS) {
6179 return status;
6180 }
6181 }
6182
6183 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006184 status = psa_key_derivation_input_bytes(
6185 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006186 raw_psk, raw_psk_length);
6187 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006188 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006189 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006190 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006191 if (status != PSA_SUCCESS) {
6192 return status;
6193 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006194
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 status = psa_key_derivation_input_bytes(derivation,
6196 PSA_KEY_DERIVATION_INPUT_LABEL,
6197 label, label_length);
6198 if (status != PSA_SUCCESS) {
6199 return status;
6200 }
6201 } else {
6202 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006203 }
6204
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 status = psa_key_derivation_set_capacity(derivation, capacity);
6206 if (status != PSA_SUCCESS) {
6207 return status;
6208 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006209
Gilles Peskine449bd832023-01-11 14:50:10 +01006210 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006211}
6212
Andrzej Kurek57d10632022-10-24 10:32:01 -04006213#if defined(PSA_WANT_ALG_SHA_384) || \
6214 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006215MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006216static int tls_prf_generic(mbedtls_md_type_t md_type,
6217 const unsigned char *secret, size_t slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006218 const char *label, size_t label_len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006219 const unsigned char *random, size_t rlen,
6220 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006221{
6222 psa_status_t status;
6223 psa_algorithm_t alg;
6224 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6225 psa_key_derivation_operation_t derivation =
6226 PSA_KEY_DERIVATION_OPERATION_INIT;
6227
Gilles Peskine449bd832023-01-11 14:50:10 +01006228 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006229 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006231 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006232 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006233
6234 /* Normally a "secret" should be long enough to be impossible to
6235 * find by brute force, and in particular should not be empty. But
6236 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6237 * and for this use case it makes sense to have a 0-length "secret".
6238 * Since the key API doesn't allow importing a key of length 0,
6239 * keep master_key=0, which setup_psa_key_derivation() understands
6240 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006241 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006242 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006243 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6244 psa_set_key_algorithm(&key_attributes, alg);
6245 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006246
Gilles Peskine449bd832023-01-11 14:50:10 +01006247 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6248 if (status != PSA_SUCCESS) {
6249 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6250 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006251 }
6252
Gilles Peskine449bd832023-01-11 14:50:10 +01006253 status = setup_psa_key_derivation(&derivation,
6254 master_key, alg,
6255 NULL, 0,
6256 random, rlen,
6257 (unsigned char const *) label,
Max Fillingerf2dda152024-10-23 15:47:23 +02006258 label_len,
Gilles Peskine449bd832023-01-11 14:50:10 +01006259 NULL, 0,
6260 dlen);
6261 if (status != PSA_SUCCESS) {
6262 psa_key_derivation_abort(&derivation);
6263 psa_destroy_key(master_key);
6264 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006265 }
6266
Gilles Peskine449bd832023-01-11 14:50:10 +01006267 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6268 if (status != PSA_SUCCESS) {
6269 psa_key_derivation_abort(&derivation);
6270 psa_destroy_key(master_key);
6271 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006272 }
6273
Gilles Peskine449bd832023-01-11 14:50:10 +01006274 status = psa_key_derivation_abort(&derivation);
6275 if (status != PSA_SUCCESS) {
6276 psa_destroy_key(master_key);
6277 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006278 }
6279
Gilles Peskine449bd832023-01-11 14:50:10 +01006280 if (!mbedtls_svc_key_id_is_null(master_key)) {
6281 status = psa_destroy_key(master_key);
6282 }
6283 if (status != PSA_SUCCESS) {
6284 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6285 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006286
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006288}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006289#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006290
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006291#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006292MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006293static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6294 const char *label,
6295 const unsigned char *random, size_t rlen,
6296 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006297{
Gilles Peskine449bd832023-01-11 14:50:10 +01006298 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006299 label, strlen(label), random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006300}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006301#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006302
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006303#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006304MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006305static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6306 const char *label,
6307 const unsigned char *random, size_t rlen,
6308 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006309{
Gilles Peskine449bd832023-01-11 14:50:10 +01006310 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
Max Fillingerf2dda152024-10-23 15:47:23 +02006311 label, strlen(label), random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006312}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006313#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006314
Jerry Yuf009d862022-02-17 14:01:37 +08006315/*
6316 * Set appropriate PRF function and other SSL / TLS1.2 functions
6317 *
6318 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006319 * - hash associated with the ciphersuite (only used by TLS 1.2)
6320 *
6321 * Outputs:
6322 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6323 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006324MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006325static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6326 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006327{
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006328#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006329 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006330 handshake->tls_prf = tls_prf_sha384;
6331 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6332 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006333 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006334#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006335#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuf009d862022-02-17 14:01:37 +08006336 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006337 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006338 handshake->tls_prf = tls_prf_sha256;
6339 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6340 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6341 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006342#else
Jerry Yuf009d862022-02-17 14:01:37 +08006343 {
Jerry Yuf009d862022-02-17 14:01:37 +08006344 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006345 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006346 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006347 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006348#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006349
Gilles Peskine449bd832023-01-11 14:50:10 +01006350 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006351}
Jerry Yud6ab2352022-02-17 14:03:43 +08006352
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006353/*
6354 * Compute master secret if needed
6355 *
6356 * Parameters:
6357 * [in/out] handshake
6358 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6359 * (PSA-PSK) ciphersuite_info, psk_opaque
6360 * [out] premaster (cleared)
6361 * [out] master
6362 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6363 * debug: conf->f_dbg, conf->p_dbg
6364 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006365 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006366 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006367MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006368static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6369 unsigned char *master,
6370 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006371{
6372 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6373
6374 /* cf. RFC 5246, Section 8.1:
6375 * "The master secret is always exactly 48 bytes in length." */
6376 size_t const master_secret_len = 48;
6377
6378#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6379 unsigned char session_hash[48];
6380#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6381
6382 /* The label for the KDF used for key expansion.
6383 * This is either "master secret" or "extended master secret"
6384 * depending on whether the Extended Master Secret extension
6385 * is used. */
6386 char const *lbl = "master secret";
6387
Przemek Stekielae4ed302022-04-05 17:15:55 +02006388 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006389 * - If the Extended Master Secret extension is not used,
6390 * this is ClientHello.Random + ServerHello.Random
6391 * (see Sect. 8.1 in RFC 5246).
6392 * - If the Extended Master Secret extension is used,
6393 * this is the transcript of the handshake so far.
6394 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006395 unsigned char const *seed = handshake->randbytes;
6396 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006397
6398#if !defined(MBEDTLS_DEBUG_C) && \
6399 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006400 !defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006401 ssl = NULL; /* make sure we don't use it except for those cases */
6402 (void) ssl;
6403#endif
6404
Gilles Peskine449bd832023-01-11 14:50:10 +01006405 if (handshake->resume != 0) {
6406 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6407 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006408 }
6409
6410#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006411 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006412 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006413 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006414 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6415 if (ret != 0) {
6416 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6417 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006418
Gilles Peskine449bd832023-01-11 14:50:10 +01006419 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6420 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006421 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006422#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006423
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006424#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006425 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006426 /* Perform PSK-to-MS expansion in a single step. */
6427 psa_status_t status;
6428 psa_algorithm_t alg;
6429 mbedtls_svc_key_id_t psk;
6430 psa_key_derivation_operation_t derivation =
6431 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006432 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006433
Gilles Peskine449bd832023-01-11 14:50:10 +01006434 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006435
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006437
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006439 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006440 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006441 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006442 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006443
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006444 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006445 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006446
Gilles Peskine449bd832023-01-11 14:50:10 +01006447 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006448 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006449 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006450 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006451 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006452 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
6453 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6454 other_secret = handshake->premaster + 2;
6455 break;
6456 default:
6457 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006458 }
6459
Gilles Peskine449bd832023-01-11 14:50:10 +01006460 status = setup_psa_key_derivation(&derivation, psk, alg,
6461 ssl->conf->psk, ssl->conf->psk_len,
6462 seed, seed_len,
6463 (unsigned char const *) lbl,
6464 (size_t) strlen(lbl),
6465 other_secret, other_secret_len,
6466 master_secret_len);
6467 if (status != PSA_SUCCESS) {
6468 psa_key_derivation_abort(&derivation);
6469 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006470 }
6471
Gilles Peskine449bd832023-01-11 14:50:10 +01006472 status = psa_key_derivation_output_bytes(&derivation,
6473 master,
6474 master_secret_len);
6475 if (status != PSA_SUCCESS) {
6476 psa_key_derivation_abort(&derivation);
6477 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006478 }
6479
Gilles Peskine449bd832023-01-11 14:50:10 +01006480 status = psa_key_derivation_abort(&derivation);
6481 if (status != PSA_SUCCESS) {
6482 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6483 }
6484 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006485#endif
6486 {
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006487#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006488 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006489 psa_status_t status;
6490 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6491 psa_key_derivation_operation_t derivation =
6492 PSA_KEY_DERIVATION_OPERATION_INIT;
6493
Gilles Peskine449bd832023-01-11 14:50:10 +01006494 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006495
6496 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6497
Gilles Peskine449bd832023-01-11 14:50:10 +01006498 status = psa_key_derivation_setup(&derivation, alg);
6499 if (status != PSA_SUCCESS) {
6500 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006501 }
6502
Gilles Peskine449bd832023-01-11 14:50:10 +01006503 status = psa_key_derivation_set_capacity(&derivation,
6504 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6505 if (status != PSA_SUCCESS) {
6506 psa_key_derivation_abort(&derivation);
6507 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006508 }
6509
Gilles Peskine449bd832023-01-11 14:50:10 +01006510 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6511 &derivation);
6512 if (status != PSA_SUCCESS) {
6513 psa_key_derivation_abort(&derivation);
6514 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006515 }
6516
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 status = psa_key_derivation_output_bytes(&derivation,
6518 handshake->premaster,
6519 handshake->pmslen);
6520 if (status != PSA_SUCCESS) {
6521 psa_key_derivation_abort(&derivation);
6522 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6523 }
6524
6525 status = psa_key_derivation_abort(&derivation);
6526 if (status != PSA_SUCCESS) {
6527 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006528 }
6529 }
6530#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006531 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6532 lbl, seed, seed_len,
6533 master,
6534 master_secret_len);
6535 if (ret != 0) {
6536 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6537 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006538 }
6539
Gilles Peskine449bd832023-01-11 14:50:10 +01006540 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6541 handshake->premaster,
6542 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006543
Gilles Peskine449bd832023-01-11 14:50:10 +01006544 mbedtls_platform_zeroize(handshake->premaster,
6545 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006546 }
6547
Gilles Peskine449bd832023-01-11 14:50:10 +01006548 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006549}
6550
Gilles Peskine449bd832023-01-11 14:50:10 +01006551int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006552{
6553 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6554 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6555 ssl->handshake->ciphersuite_info;
6556
Gilles Peskine449bd832023-01-11 14:50:10 +01006557 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006558
6559 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006560 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006561 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006562 if (ret != 0) {
6563 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6564 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006565 }
6566
6567 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006568 ret = ssl_compute_master(ssl->handshake,
6569 ssl->session_negotiate->master,
6570 ssl);
6571 if (ret != 0) {
6572 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6573 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006574 }
6575
6576 /* Swap the client and server random values:
6577 * - MS derivation wanted client+server (RFC 5246 8.1)
6578 * - key derivation wants server+client (RFC 5246 6.3) */
6579 {
6580 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006581 memcpy(tmp, ssl->handshake->randbytes, 64);
6582 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6583 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6584 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006585 }
6586
6587 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006588 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6589 ssl->session_negotiate->ciphersuite,
6590 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006591#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006592 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006593#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006594 ssl->handshake->tls_prf,
6595 ssl->handshake->randbytes,
6596 ssl->tls_version,
6597 ssl->conf->endpoint,
6598 ssl);
6599 if (ret != 0) {
6600 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6601 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006602 }
6603
6604 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006605 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6606 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006607
Gilles Peskine449bd832023-01-11 14:50:10 +01006608 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006609
Gilles Peskine449bd832023-01-11 14:50:10 +01006610 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006611}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006612
Gilles Peskine449bd832023-01-11 14:50:10 +01006613int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006614{
Gilles Peskine449bd832023-01-11 14:50:10 +01006615 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006616#if defined(PSA_WANT_ALG_SHA_384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006617 case MBEDTLS_SSL_HASH_SHA384:
6618 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6619 break;
6620#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006621#if defined(PSA_WANT_ALG_SHA_256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006622 case MBEDTLS_SSL_HASH_SHA256:
6623 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6624 break;
6625#endif
6626 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006627 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006628 }
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006629#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006630 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006631 (void) ssl;
6632#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006633 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006634}
6635
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006636static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6637 const psa_hash_operation_t *hs_op,
6638 size_t buffer_size,
6639 unsigned char *hash,
6640 size_t *hlen)
6641{
6642 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006643 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006644
6645#if !defined(MBEDTLS_DEBUG_C)
6646 (void) ssl;
6647#endif
6648 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006649 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006650 if (status != PSA_SUCCESS) {
6651 goto exit;
6652 }
6653
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006654 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006655 if (status != PSA_SUCCESS) {
6656 goto exit;
6657 }
6658
6659 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6660 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6661
6662exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006663 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006664 return mbedtls_md_error_from_psa(status);
6665}
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006666
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006667#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006668int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6669 unsigned char *hash,
6670 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006671{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006672 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6673 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006674}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006675#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006676
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006677#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006678int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6679 unsigned char *hash,
6680 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006681{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006682 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6683 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006684}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006685#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006686
Jerry Yuc2c673d2022-02-17 14:20:39 +08006687#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006688MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006689static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006690
6691#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006692int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006693{
6694 /* If renegotiation is not enforced, retransmit until we would reach max
6695 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006696 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006697 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6698 unsigned char doublings = 1;
6699
Gilles Peskine449bd832023-01-11 14:50:10 +01006700 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006701 ++doublings;
6702 ratio >>= 1;
6703 }
6704
Gilles Peskine449bd832023-01-11 14:50:10 +01006705 if (++ssl->renego_records_seen > doublings) {
6706 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6707 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006708 }
6709 }
6710
Gilles Peskine449bd832023-01-11 14:50:10 +01006711 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006712}
6713#endif
6714#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006715
Jerry Yud9526692022-02-17 14:23:47 +08006716/*
6717 * Handshake functions
6718 */
6719#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6720/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006721int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006722{
6723 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6724 ssl->handshake->ciphersuite_info;
6725
Gilles Peskine449bd832023-01-11 14:50:10 +01006726 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006727
Gilles Peskine449bd832023-01-11 14:50:10 +01006728 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6729 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006730 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006731 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006732 }
6733
Gilles Peskine449bd832023-01-11 14:50:10 +01006734 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6735 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006736}
6737
Gilles Peskine449bd832023-01-11 14:50:10 +01006738int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006739{
6740 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6741 ssl->handshake->ciphersuite_info;
6742
Gilles Peskine449bd832023-01-11 14:50:10 +01006743 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006744
Gilles Peskine449bd832023-01-11 14:50:10 +01006745 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6746 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006747 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006748 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006749 }
6750
Gilles Peskine449bd832023-01-11 14:50:10 +01006751 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6752 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006753}
6754
6755#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6756/* Some certificate support -> implement write and parse */
6757
Gilles Peskine449bd832023-01-11 14:50:10 +01006758int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006759{
6760 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6761 size_t i, n;
6762 const mbedtls_x509_crt *crt;
6763 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6764 ssl->handshake->ciphersuite_info;
6765
Gilles Peskine449bd832023-01-11 14:50:10 +01006766 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006767
Gilles Peskine449bd832023-01-11 14:50:10 +01006768 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6769 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006770 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006771 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006772 }
6773
6774#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006775 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6776 if (ssl->handshake->client_auth == 0) {
6777 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006778 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006779 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006780 }
6781 }
6782#endif /* MBEDTLS_SSL_CLI_C */
6783#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006784 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6785 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006786 /* Should never happen because we shouldn't have picked the
6787 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006788 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006789 }
6790 }
6791#endif
6792
Gilles Peskine449bd832023-01-11 14:50:10 +01006793 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006794
6795 /*
6796 * 0 . 0 handshake type
6797 * 1 . 3 handshake length
6798 * 4 . 6 length of all certs
6799 * 7 . 9 length of cert. 1
6800 * 10 . n-1 peer certificate
6801 * n . n+2 length of cert. 2
6802 * n+3 . ... upper level cert, etc.
6803 */
6804 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006805 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006806
Gilles Peskine449bd832023-01-11 14:50:10 +01006807 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006808 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006809 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6810 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6811 " > %" MBEDTLS_PRINTF_SIZET,
6812 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6813 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006814 }
6815
Gilles Peskine449bd832023-01-11 14:50:10 +01006816 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6817 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6818 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006819
Gilles Peskine449bd832023-01-11 14:50:10 +01006820 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006821 i += n; crt = crt->next;
6822 }
6823
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6825 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6826 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006827
6828 ssl->out_msglen = i;
6829 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6830 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6831
Gilles Peskinef670ba52025-03-07 15:09:32 +01006832 mbedtls_ssl_handshake_increment_state(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006833
Gilles Peskine449bd832023-01-11 14:50:10 +01006834 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
6835 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
6836 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006837 }
6838
Gilles Peskine449bd832023-01-11 14:50:10 +01006839 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006840
Gilles Peskine449bd832023-01-11 14:50:10 +01006841 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006842}
6843
6844#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6845
6846#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006847MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006848static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6849 unsigned char *crt_buf,
6850 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006851{
6852 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6853
Gilles Peskine449bd832023-01-11 14:50:10 +01006854 if (peer_crt == NULL) {
6855 return -1;
6856 }
Jerry Yud9526692022-02-17 14:23:47 +08006857
Gilles Peskine449bd832023-01-11 14:50:10 +01006858 if (peer_crt->raw.len != crt_buf_len) {
6859 return -1;
6860 }
Jerry Yud9526692022-02-17 14:23:47 +08006861
Gilles Peskine449bd832023-01-11 14:50:10 +01006862 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08006863}
6864#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006865MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006866static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6867 unsigned char *crt_buf,
6868 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006869{
6870 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6871 unsigned char const * const peer_cert_digest =
6872 ssl->session->peer_cert_digest;
6873 mbedtls_md_type_t const peer_cert_digest_type =
6874 ssl->session->peer_cert_digest_type;
6875 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01006876 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08006877 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6878 size_t digest_len;
6879
Gilles Peskine449bd832023-01-11 14:50:10 +01006880 if (peer_cert_digest == NULL || digest_info == NULL) {
6881 return -1;
6882 }
Jerry Yud9526692022-02-17 14:23:47 +08006883
Gilles Peskine449bd832023-01-11 14:50:10 +01006884 digest_len = mbedtls_md_get_size(digest_info);
6885 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
6886 return -1;
6887 }
Jerry Yud9526692022-02-17 14:23:47 +08006888
Gilles Peskine449bd832023-01-11 14:50:10 +01006889 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
6890 if (ret != 0) {
6891 return -1;
6892 }
Jerry Yud9526692022-02-17 14:23:47 +08006893
Gilles Peskine449bd832023-01-11 14:50:10 +01006894 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08006895}
6896#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6897#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6898
6899/*
6900 * Once the certificate message is read, parse it into a cert chain and
6901 * perform basic checks, but leave actual verification to the caller
6902 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006903MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006904static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
6905 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08006906{
6907 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6908#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006909 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08006910#endif
6911 size_t i, n;
6912 uint8_t alert;
6913
Gilles Peskine449bd832023-01-11 14:50:10 +01006914 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
6915 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6916 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6917 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6918 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006919 }
6920
Gilles Peskine449bd832023-01-11 14:50:10 +01006921 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
6922 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6923 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6924 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006925 }
6926
Gilles Peskine449bd832023-01-11 14:50:10 +01006927 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
6928 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6929 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6930 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6931 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006932 }
6933
Gilles Peskine449bd832023-01-11 14:50:10 +01006934 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006935
6936 /*
6937 * Same message structure as in mbedtls_ssl_write_certificate()
6938 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006939 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006940
Gilles Peskine449bd832023-01-11 14:50:10 +01006941 if (ssl->in_msg[i] != 0 ||
6942 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
6943 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6944 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6945 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6946 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006947 }
6948
6949 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6950 i += 3;
6951
6952 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006953 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08006954 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006955 if (i + 3 > ssl->in_hslen) {
6956 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6957 mbedtls_ssl_send_alert_message(ssl,
6958 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6959 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6960 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006961 }
6962 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6963 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006964 if (ssl->in_msg[i] != 0) {
6965 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6966 mbedtls_ssl_send_alert_message(ssl,
6967 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6968 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
6969 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08006970 }
6971
6972 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006973 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006974 i += 3;
6975
Gilles Peskine449bd832023-01-11 14:50:10 +01006976 if (n < 128 || i + n > ssl->in_hslen) {
6977 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6978 mbedtls_ssl_send_alert_message(ssl,
6979 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6980 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6981 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006982 }
6983
6984 /* Check if we're handling the first CRT in the chain. */
6985#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006986 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08006987 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01006988 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08006989 /* During client-side renegotiation, check that the server's
6990 * end-CRTs hasn't changed compared to the initial handshake,
6991 * mitigating the triple handshake attack. On success, reuse
6992 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006993 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
6994 if (ssl_check_peer_crt_unchanged(ssl,
6995 &ssl->in_msg[i],
6996 n) != 0) {
6997 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
6998 mbedtls_ssl_send_alert_message(ssl,
6999 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7000 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7001 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007002 }
7003
7004 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007005 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007006 }
7007#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7008
7009 /* Parse the next certificate in the chain. */
7010#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007011 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007012#else
7013 /* If we don't need to store the CRT chain permanently, parse
7014 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007015 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007016#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007017 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007018 case 0: /*ok*/
Gilles Peskine4c832212025-05-07 23:05:12 +02007019 case MBEDTLS_ERR_X509_UNKNOWN_OID:
Jerry Yud9526692022-02-17 14:23:47 +08007020 /* Ignore certificate with an unknown algorithm: maybe a
7021 prior certificate was already trusted. */
7022 break;
7023
7024 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7025 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7026 goto crt_parse_der_failed;
7027
7028 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7029 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7030 goto crt_parse_der_failed;
7031
7032 default:
7033 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007034crt_parse_der_failed:
7035 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7036 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7037 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007038 }
7039
7040 i += n;
7041 }
7042
Gilles Peskine449bd832023-01-11 14:50:10 +01007043 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7044 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007045}
7046
7047#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007048MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007049static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007050{
Gilles Peskine449bd832023-01-11 14:50:10 +01007051 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7052 return -1;
7053 }
Jerry Yud9526692022-02-17 14:23:47 +08007054
Gilles Peskine449bd832023-01-11 14:50:10 +01007055 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007056 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7057 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007058 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7059 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7060 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007061 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007062 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007063}
7064#endif /* MBEDTLS_SSL_SRV_C */
7065
7066/* Check if a certificate message is expected.
7067 * Return either
7068 * - SSL_CERTIFICATE_EXPECTED, or
7069 * - SSL_CERTIFICATE_SKIP
7070 * indicating whether a Certificate message is expected or not.
7071 */
7072#define SSL_CERTIFICATE_EXPECTED 0
7073#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007074MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007075static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7076 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007077{
7078 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7079 ssl->handshake->ciphersuite_info;
7080
Gilles Peskine449bd832023-01-11 14:50:10 +01007081 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7082 return SSL_CERTIFICATE_SKIP;
7083 }
Jerry Yud9526692022-02-17 14:23:47 +08007084
7085#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007086 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007087 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007088 ssl->session_negotiate->verify_result =
7089 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007090 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007091 }
7092 }
7093#else
7094 ((void) authmode);
7095#endif /* MBEDTLS_SSL_SRV_C */
7096
Gilles Peskine449bd832023-01-11 14:50:10 +01007097 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007098}
7099
Jerry Yud9526692022-02-17 14:23:47 +08007100#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007101MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007102static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7103 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007104{
7105 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7106 /* Remember digest of the peer's end-CRT. */
7107 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007108 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7109 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7110 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7111 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7112 mbedtls_ssl_send_alert_message(ssl,
7113 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7114 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007115
Gilles Peskine449bd832023-01-11 14:50:10 +01007116 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007117 }
7118
Gilles Peskine449bd832023-01-11 14:50:10 +01007119 ret = mbedtls_md(mbedtls_md_info_from_type(
7120 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7121 start, len,
7122 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007123
7124 ssl->session_negotiate->peer_cert_digest_type =
7125 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7126 ssl->session_negotiate->peer_cert_digest_len =
7127 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7128
Gilles Peskine449bd832023-01-11 14:50:10 +01007129 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007130}
7131
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007132MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007133static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7134 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007135{
7136 unsigned char *end = start + len;
7137 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7138
7139 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007140 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7141 ret = mbedtls_pk_parse_subpubkey(&start, end,
7142 &ssl->handshake->peer_pubkey);
7143 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007144 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007145 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007146 }
7147
Gilles Peskine449bd832023-01-11 14:50:10 +01007148 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007149}
7150#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7151
Gilles Peskine449bd832023-01-11 14:50:10 +01007152int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007153{
7154 int ret = 0;
7155 int crt_expected;
Manuel Pégourié-Gonnard58ab9ba2024-08-14 09:47:38 +02007156 /* Authmode: precedence order is SNI if used else configuration */
Jerry Yud9526692022-02-17 14:23:47 +08007157#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7158 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7159 ? ssl->handshake->sni_authmode
7160 : ssl->conf->authmode;
7161#else
7162 const int authmode = ssl->conf->authmode;
7163#endif
7164 void *rs_ctx = NULL;
7165 mbedtls_x509_crt *chain = NULL;
7166
Gilles Peskine449bd832023-01-11 14:50:10 +01007167 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007168
Gilles Peskine449bd832023-01-11 14:50:10 +01007169 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7170 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7171 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007172 goto exit;
7173 }
7174
7175#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007176 if (ssl->handshake->ecrs_enabled &&
7177 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007178 chain = ssl->handshake->ecrs_peer_cert;
7179 ssl->handshake->ecrs_peer_cert = NULL;
7180 goto crt_verify;
7181 }
7182#endif
7183
Gilles Peskine449bd832023-01-11 14:50:10 +01007184 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007185 /* mbedtls_ssl_read_record may have sent an alert already. We
7186 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007187 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007188 goto exit;
7189 }
7190
7191#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007192 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007193 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7194
Gilles Peskine449bd832023-01-11 14:50:10 +01007195 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007196 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 }
Jerry Yud9526692022-02-17 14:23:47 +08007198
7199 goto exit;
7200 }
7201#endif /* MBEDTLS_SSL_SRV_C */
7202
7203 /* Clear existing peer CRT structure in case we tried to
7204 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007205 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007206
Gilles Peskine449bd832023-01-11 14:50:10 +01007207 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7208 if (chain == NULL) {
7209 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7210 sizeof(mbedtls_x509_crt)));
7211 mbedtls_ssl_send_alert_message(ssl,
7212 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7213 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007214
7215 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7216 goto exit;
7217 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007218 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007219
Gilles Peskine449bd832023-01-11 14:50:10 +01007220 ret = ssl_parse_certificate_chain(ssl, chain);
7221 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007222 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007223 }
Jerry Yud9526692022-02-17 14:23:47 +08007224
7225#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007226 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007227 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007228 }
Jerry Yud9526692022-02-17 14:23:47 +08007229
7230crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007231 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007232 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007233 }
Jerry Yud9526692022-02-17 14:23:47 +08007234#endif
7235
Manuel Pégourié-Gonnard19dd9f52024-08-16 11:03:42 +02007236 ret = mbedtls_ssl_verify_certificate(ssl, authmode, chain,
7237 ssl->handshake->ciphersuite_info,
7238 rs_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +01007239 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007240 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007241 }
Jerry Yud9526692022-02-17 14:23:47 +08007242
7243#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7244 {
7245 unsigned char *crt_start, *pk_start;
7246 size_t crt_len, pk_len;
7247
7248 /* We parse the CRT chain without copying, so
7249 * these pointers point into the input buffer,
7250 * and are hence still valid after freeing the
7251 * CRT chain. */
7252
7253 crt_start = chain->raw.p;
7254 crt_len = chain->raw.len;
7255
7256 pk_start = chain->pk_raw.p;
7257 pk_len = chain->pk_raw.len;
7258
7259 /* Free the CRT structures before computing
7260 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007261 mbedtls_x509_crt_free(chain);
7262 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007263 chain = NULL;
7264
Gilles Peskine449bd832023-01-11 14:50:10 +01007265 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7266 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007267 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007268 }
Jerry Yud9526692022-02-17 14:23:47 +08007269
Gilles Peskine449bd832023-01-11 14:50:10 +01007270 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7271 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007272 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007273 }
Jerry Yud9526692022-02-17 14:23:47 +08007274 }
7275#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7276 /* Pass ownership to session structure. */
7277 ssl->session_negotiate->peer_cert = chain;
7278 chain = NULL;
7279#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7280
Gilles Peskine449bd832023-01-11 14:50:10 +01007281 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007282
7283exit:
7284
Gilles Peskine449bd832023-01-11 14:50:10 +01007285 if (ret == 0) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007286 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007287 }
Jerry Yud9526692022-02-17 14:23:47 +08007288
7289#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007290 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007291 ssl->handshake->ecrs_peer_cert = chain;
7292 chain = NULL;
7293 }
7294#endif
7295
Gilles Peskine449bd832023-01-11 14:50:10 +01007296 if (chain != NULL) {
7297 mbedtls_x509_crt_free(chain);
7298 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007299 }
7300
Gilles Peskine449bd832023-01-11 14:50:10 +01007301 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007302}
7303#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7304
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007305static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7306 unsigned char *padbuf, size_t hlen,
7307 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007308{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007309 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007310 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007311 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007312 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007313 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007314 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007315
7316 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007317 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007318 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007319 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007320
Gilles Peskine449bd832023-01-11 14:50:10 +01007321 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007322 ? "client finished"
7323 : "server finished";
7324
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007325 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007326
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007327 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007328 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007329 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007330 }
7331
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007332 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007333 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007334 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007335 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007336 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007337
7338 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7339
Jerry Yu615bd6f2022-02-17 14:25:15 +08007340 /*
7341 * TLSv1.2:
7342 * hash = PRF( master, finished_label,
7343 * Hash( handshake ) )[0.11]
7344 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007345 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007346 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007347
Gilles Peskine449bd832023-01-11 14:50:10 +01007348 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007349
Paul Elliottecb95be2023-08-11 16:41:04 +01007350 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007351
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007352 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007353
7354exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007355 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007356 return mbedtls_md_error_from_psa(status);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007357}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007358
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007359#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007360static int ssl_calc_finished_tls_sha256(
7361 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7362{
7363 unsigned char padbuf[32];
7364 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007365 &ssl->handshake->fin_sha256_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007366 padbuf, sizeof(padbuf),
7367 buf, from);
7368}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007369#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007370
Jerry Yub7ba49e2022-02-17 14:25:53 +08007371
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007372#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007373static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007374 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007375{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007376 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007377 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007378 &ssl->handshake->fin_sha384_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007379 padbuf, sizeof(padbuf),
7380 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007381}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007382#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007383
Gilles Peskine449bd832023-01-11 14:50:10 +01007384void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007385{
Gilles Peskine449bd832023-01-11 14:50:10 +01007386 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007387
7388 /*
7389 * Free our handshake params
7390 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007391 mbedtls_ssl_handshake_free(ssl);
7392 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007393 ssl->handshake = NULL;
7394
7395 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007396 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007397 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007398 if (ssl->transform) {
7399 mbedtls_ssl_transform_free(ssl->transform);
7400 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007401 }
7402 ssl->transform = ssl->transform_negotiate;
7403 ssl->transform_negotiate = NULL;
7404
Gilles Peskine449bd832023-01-11 14:50:10 +01007405 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007406}
7407
Gilles Peskine449bd832023-01-11 14:50:10 +01007408void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007409{
7410 int resume = ssl->handshake->resume;
7411
Gilles Peskine449bd832023-01-11 14:50:10 +01007412 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007413
7414#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007415 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007416 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7417 ssl->renego_records_seen = 0;
7418 }
7419#endif
7420
7421 /*
7422 * Free the previous session and switch in the current one
7423 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007424 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007425#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7426 /* RFC 7366 3.1: keep the EtM state */
7427 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007428 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007429#endif
7430
Gilles Peskine449bd832023-01-11 14:50:10 +01007431 mbedtls_ssl_session_free(ssl->session);
7432 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007433 }
7434 ssl->session = ssl->session_negotiate;
7435 ssl->session_negotiate = NULL;
7436
7437 /*
7438 * Add cache entry
7439 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007441 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007442 resume == 0) {
7443 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7444 ssl->session->id,
7445 ssl->session->id_len,
7446 ssl->session) != 0) {
7447 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7448 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007449 }
7450
7451#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007452 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7453 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007454 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007455 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007456
7457 /* Keep last flight around in case we need to resend it:
7458 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007459 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7460 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007461#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007462 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007463
Gilles Peskinef670ba52025-03-07 15:09:32 +01007464 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007465
Gilles Peskine449bd832023-01-11 14:50:10 +01007466 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007467}
7468
Gilles Peskine449bd832023-01-11 14:50:10 +01007469int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007470{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007471 int ret;
7472 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007473
Gilles Peskine449bd832023-01-11 14:50:10 +01007474 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007475
Gilles Peskine449bd832023-01-11 14:50:10 +01007476 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007477
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007478 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7479 if (ret != 0) {
7480 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
David Horstmann816b7122025-03-07 17:20:59 +00007481 return ret;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007482 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007483
7484 /*
7485 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7486 * may define some other value. Currently (early 2016), no defined
7487 * ciphersuite does this (and this is unlikely to change as activity has
7488 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7489 */
7490 hash_len = 12;
7491
7492#if defined(MBEDTLS_SSL_RENEGOTIATION)
7493 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007495#endif
7496
7497 ssl->out_msglen = 4 + hash_len;
7498 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7499 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7500
7501 /*
7502 * In case of session resuming, invert the client and server
7503 * ChangeCipherSpec messages order.
7504 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007506#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007508 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
Gilles Peskine449bd832023-01-11 14:50:10 +01007509 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007510#endif
7511#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007512 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007513 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC);
Gilles Peskine449bd832023-01-11 14:50:10 +01007514 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007515#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007516 } else {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007517 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007518 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007519
7520 /*
7521 * Switch to our negotiated transform and session parameters for outbound
7522 * data.
7523 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007524 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007525
7526#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007527 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007528 unsigned char i;
7529
7530 /* Remember current epoch settings for resending */
7531 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007532 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7533 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007534
7535 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007536 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007537
7538
7539 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007540 for (i = 2; i > 0; i--) {
7541 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007542 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 }
7544 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007545
7546 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007547 if (i == 0) {
7548 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7549 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007550 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007551 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007552#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007554
7555 ssl->transform_out = ssl->transform_negotiate;
7556 ssl->session_out = ssl->session_negotiate;
7557
7558#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007559 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7560 mbedtls_ssl_send_flight_completed(ssl);
7561 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007562#endif
7563
Gilles Peskine449bd832023-01-11 14:50:10 +01007564 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7565 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7566 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007567 }
7568
7569#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007570 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7571 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7572 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7573 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007574 }
7575#endif
7576
Gilles Peskine449bd832023-01-11 14:50:10 +01007577 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007578
Gilles Peskine449bd832023-01-11 14:50:10 +01007579 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007580}
7581
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007582#define SSL_MAX_HASH_LEN 12
7583
Gilles Peskine449bd832023-01-11 14:50:10 +01007584int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007585{
7586 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7587 unsigned int hash_len = 12;
7588 unsigned char buf[SSL_MAX_HASH_LEN];
7589
Gilles Peskine449bd832023-01-11 14:50:10 +01007590 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007591
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007592 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7593 if (ret != 0) {
7594 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
David Horstmann816b7122025-03-07 17:20:59 +00007595 return ret;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007596 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007597
Gilles Peskine449bd832023-01-11 14:50:10 +01007598 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7599 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007600 goto exit;
7601 }
7602
Gilles Peskine449bd832023-01-11 14:50:10 +01007603 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7604 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7605 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7606 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007607 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7608 goto exit;
7609 }
7610
Gilles Peskine449bd832023-01-11 14:50:10 +01007611 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
7612 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7613 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007614 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7615 goto exit;
7616 }
7617
Gilles Peskine449bd832023-01-11 14:50:10 +01007618 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
7619 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7620 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7621 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007622 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7623 goto exit;
7624 }
7625
Gilles Peskine449bd832023-01-11 14:50:10 +01007626 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
7627 buf, hash_len) != 0) {
7628 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7629 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7630 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007631 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7632 goto exit;
7633 }
7634
7635#if defined(MBEDTLS_SSL_RENEGOTIATION)
7636 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007637 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007638#endif
7639
Gilles Peskine449bd832023-01-11 14:50:10 +01007640 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007641#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007642 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007643 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC);
Gilles Peskine449bd832023-01-11 14:50:10 +01007644 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007645#endif
7646#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007647 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007648 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
Gilles Peskine449bd832023-01-11 14:50:10 +01007649 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007650#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007651 } else {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007652 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007653 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007654
7655#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007656 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7657 mbedtls_ssl_recv_flight_completed(ssl);
7658 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007659#endif
7660
Gilles Peskine449bd832023-01-11 14:50:10 +01007661 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007662
7663exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007664 mbedtls_platform_zeroize(buf, hash_len);
7665 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007666}
7667
Jerry Yu392112c2022-02-17 14:34:10 +08007668#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7669/*
7670 * Helper to get TLS 1.2 PRF from ciphersuite
7671 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7672 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007673static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08007674{
Jerry Yu392112c2022-02-17 14:34:10 +08007675 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007676 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007677#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007678 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
7679 return tls_prf_sha384;
7680 } else
Jerry Yu392112c2022-02-17 14:34:10 +08007681#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007682#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007683 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007684 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
7685 return tls_prf_sha256;
7686 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04007687 }
7688#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007689#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007690 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007691 (void) ciphersuite_info;
7692#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007693
Gilles Peskine449bd832023-01-11 14:50:10 +01007694 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08007695}
7696#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007697
Gilles Peskine449bd832023-01-11 14:50:10 +01007698static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007699{
7700 ((void) tls_prf);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007701#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007702 if (tls_prf == tls_prf_sha384) {
7703 return MBEDTLS_SSL_TLS_PRF_SHA384;
7704 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007705#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007706#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01007707 if (tls_prf == tls_prf_sha256) {
7708 return MBEDTLS_SSL_TLS_PRF_SHA256;
7709 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007710#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007711 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08007712}
7713
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007714/*
7715 * Populate a transform structure with session keys and all the other
7716 * necessary information.
7717 *
7718 * Parameters:
7719 * - [in/out]: transform: structure to populate
7720 * [in] must be just initialised with mbedtls_ssl_transform_init()
7721 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7722 * - [in] ciphersuite
7723 * - [in] master
7724 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007725 * - [in] tls_prf: pointer to PRF to use for key derivation
7726 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007727 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007728 * - [in] endpoint: client or server
7729 * - [in] ssl: used for:
7730 * - ssl->conf->{f,p}_export_keys
7731 * [in] optionally used for:
7732 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7733 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007734MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007735static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
7736 int ciphersuite,
7737 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007738#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007739 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007740#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007741 ssl_tls_prf_t tls_prf,
7742 const unsigned char randbytes[64],
7743 mbedtls_ssl_protocol_version tls_version,
7744 unsigned endpoint,
7745 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007746{
7747 int ret = 0;
7748 unsigned char keyblk[256];
7749 unsigned char *key1;
7750 unsigned char *key2;
7751 unsigned char *mac_enc;
7752 unsigned char *mac_dec;
7753 size_t mac_key_len = 0;
7754 size_t iv_copy_len;
7755 size_t keylen;
7756 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007757 mbedtls_ssl_mode_t ssl_mode;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007758
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007759 psa_key_type_t key_type;
7760 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7761 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007762 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007763 size_t key_bits;
7764 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007765
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007766 /*
7767 * Some data just needs copying into the structure
7768 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007769#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007770 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007771#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007772 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007773
Max Fillinger2fe35f62024-10-25 00:52:24 +02007774#if defined(MBEDTLS_SSL_KEEP_RANDBYTES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007775 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007776#endif
7777
7778#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01007779 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007780 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7781 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007782 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007783 }
7784#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7785
7786 /*
7787 * Get various info structures
7788 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007789 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
7790 if (ciphersuite_info == NULL) {
7791 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
7792 ciphersuite));
7793 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007794 }
7795
Neil Armstrongab555e02022-04-04 11:07:59 +02007796 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007797#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007798 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007799#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007800 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007801
Gilles Peskine449bd832023-01-11 14:50:10 +01007802 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007803 transform->taglen =
7804 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01007805 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007806
Dave Rodgman2eab4622023-10-05 13:30:37 +01007807 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01007808 transform->taglen,
7809 &alg,
7810 &key_type,
7811 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007812 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007813 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007814 goto end;
7815 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007816
Dave Rodgman2eab4622023-10-05 13:30:37 +01007817 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007818 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02007819 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01007820 (unsigned) ciphersuite_info->mac));
7821 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01007822 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007823
7824#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7825 /* Copy own and peer's CID if the use of the CID
7826 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007827 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
7828 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007829
7830 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007831 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
7832 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
7833 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007834
7835 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007836 memcpy(transform->out_cid, ssl->handshake->peer_cid,
7837 ssl->handshake->peer_cid_len);
7838 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
7839 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007840 }
7841#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7842
7843 /*
7844 * Compute key block using the PRF
7845 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007846 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
7847 if (ret != 0) {
7848 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7849 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007850 }
7851
Gilles Peskine449bd832023-01-11 14:50:10 +01007852 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
7853 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
7854 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
7855 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
7856 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007857
7858 /*
7859 * Determine the appropriate key, IV and MAC length.
7860 */
7861
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007862 keylen = PSA_BITS_TO_BYTES(key_bits);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007863
Valerio Settie5707042023-10-11 11:54:42 +02007864#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01007865 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007866 size_t explicit_ivlen;
7867
7868 transform->maclen = 0;
7869 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007870
7871 /* All modes haves 96-bit IVs, but the length of the static parts vary
7872 * with mode and version:
7873 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7874 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7875 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7876 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7877 * sequence number).
7878 */
7879 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01007880
7881 int is_chachapoly = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007882 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
David Horstmann3b2276a2022-10-06 14:49:08 +01007883
Gilles Peskine449bd832023-01-11 14:50:10 +01007884 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007885 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01007886 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007887 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01007888 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007889
7890 /* Minimum length of encrypted record */
7891 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7892 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007893 } else
Valerio Settie5707042023-10-11 11:54:42 +02007894#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007895#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007896 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007897 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01007898 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007899 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007900
Neil Armstronge4512952022-03-08 09:08:22 +01007901 /* Get MAC length */
7902 mac_key_len = PSA_HASH_LENGTH(mac_alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007903 transform->maclen = mac_key_len;
7904
7905 /* IV length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007906 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007907
7908 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007909 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007910 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007911 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007912 /*
7913 * GenericBlockCipher:
7914 * 1. if EtM is in use: one block plus MAC
7915 * otherwise: * first multiple of blocklen greater than maclen
7916 * 2. IV
7917 */
7918#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007919 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007920 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007921 + block_size;
7922 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007923#endif
7924 {
7925 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 + block_size
7927 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007928 }
7929
Gilles Peskine449bd832023-01-11 14:50:10 +01007930 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007931 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007932 } else {
7933 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007934 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7935 goto end;
7936 }
7937 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007938 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007939#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7940 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007941 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7942 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007943 }
7944
Gilles Peskine449bd832023-01-11 14:50:10 +01007945 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7946 (unsigned) keylen,
7947 (unsigned) transform->minlen,
7948 (unsigned) transform->ivlen,
7949 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007950
7951 /*
7952 * Finally setup the cipher contexts, IVs and MAC secrets.
7953 */
7954#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007955 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007956 key1 = keyblk + mac_key_len * 2;
7957 key2 = keyblk + mac_key_len * 2 + keylen;
7958
7959 mac_enc = keyblk;
7960 mac_dec = keyblk + mac_key_len;
7961
Gilles Peskine449bd832023-01-11 14:50:10 +01007962 iv_copy_len = (transform->fixed_ivlen) ?
7963 transform->fixed_ivlen : transform->ivlen;
7964 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
7965 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
7966 iv_copy_len);
7967 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007968#endif /* MBEDTLS_SSL_CLI_C */
7969#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007970 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007971 key1 = keyblk + mac_key_len * 2 + keylen;
7972 key2 = keyblk + mac_key_len * 2;
7973
7974 mac_enc = keyblk + mac_key_len;
7975 mac_dec = keyblk;
7976
Gilles Peskine449bd832023-01-11 14:50:10 +01007977 iv_copy_len = (transform->fixed_ivlen) ?
7978 transform->fixed_ivlen : transform->ivlen;
7979 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
7980 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
7981 iv_copy_len);
7982 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007983#endif /* MBEDTLS_SSL_SRV_C */
7984 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007985 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007986 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7987 goto end;
7988 }
7989
Paul Elliott4fb19552023-10-18 12:15:30 +01007990 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007991 ssl->f_export_keys(ssl->p_export_keys,
7992 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7993 master, 48,
7994 randbytes + 32,
7995 randbytes,
7996 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007997 }
7998
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007999 transform->psa_alg = alg;
8000
Gilles Peskine449bd832023-01-11 14:50:10 +01008001 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8002 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8003 psa_set_key_algorithm(&attributes, alg);
8004 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008005
Gilles Peskine449bd832023-01-11 14:50:10 +01008006 if ((status = psa_import_key(&attributes,
8007 key1,
8008 PSA_BITS_TO_BYTES(key_bits),
8009 &transform->psa_key_enc)) != PSA_SUCCESS) {
8010 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008011 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008012 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008013 goto end;
8014 }
8015
Gilles Peskine449bd832023-01-11 14:50:10 +01008016 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008017
Gilles Peskine449bd832023-01-11 14:50:10 +01008018 if ((status = psa_import_key(&attributes,
8019 key2,
8020 PSA_BITS_TO_BYTES(key_bits),
8021 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008022 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008023 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008024 goto end;
8025 }
8026 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008027
Neil Armstrong29c0c042022-03-17 17:47:28 +01008028#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8029 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8030 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008031 if (mac_key_len != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008032 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008033
Gilles Peskine449bd832023-01-11 14:50:10 +01008034 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8035 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8036 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008037
Gilles Peskine449bd832023-01-11 14:50:10 +01008038 if ((status = psa_import_key(&attributes,
8039 mac_enc, mac_key_len,
8040 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008041 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008042 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008043 goto end;
8044 }
8045
Gilles Peskine449bd832023-01-11 14:50:10 +01008046 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8047 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008048#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008049 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008050#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008051 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008052 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008053 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8054 PSA_KEY_USAGE_VERIFY_HASH);
8055 } else {
8056 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8057 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008058
Gilles Peskine449bd832023-01-11 14:50:10 +01008059 if ((status = psa_import_key(&attributes,
8060 mac_dec, mac_key_len,
8061 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008062 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008063 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008064 goto end;
8065 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008066 }
8067#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8068
8069 ((void) mac_dec);
8070 ((void) mac_enc);
8071
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008072end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008073 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8074 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008075}
8076
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008077#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008078int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008079 psa_pake_operation_t *pake_ctx,
8080 const unsigned char *buf,
8081 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008082{
8083 psa_status_t status;
8084 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008085 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008086 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8087 * At round two perform a single cycle
8088 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008089 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008090
Gilles Peskine449bd832023-01-11 14:50:10 +01008091 for (; remaining_steps > 0; remaining_steps--) {
8092 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008093 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008094 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008095 /* Length is stored at the first byte */
8096 size_t length = buf[input_offset];
8097 input_offset += 1;
8098
Gilles Peskine449bd832023-01-11 14:50:10 +01008099 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008100 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8101 }
8102
Gilles Peskine449bd832023-01-11 14:50:10 +01008103 status = psa_pake_input(pake_ctx, step,
8104 buf + input_offset, length);
8105 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008106 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008107 }
8108
8109 input_offset += length;
8110 }
8111 }
8112
Gilles Peskine449bd832023-01-11 14:50:10 +01008113 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008114 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008115 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008116
Gilles Peskine449bd832023-01-11 14:50:10 +01008117 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008118}
8119
Valerio Setti6b3dab02022-11-17 17:14:54 +01008120int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008121 psa_pake_operation_t *pake_ctx,
8122 unsigned char *buf,
8123 size_t len, size_t *olen,
8124 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008125{
8126 psa_status_t status;
8127 size_t output_offset = 0;
8128 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008129 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008130 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8131 * At round two perform a single cycle
8132 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008133 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008134
Gilles Peskine449bd832023-01-11 14:50:10 +01008135 for (; remaining_steps > 0; remaining_steps--) {
8136 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8137 step <= PSA_PAKE_STEP_ZK_PROOF;
8138 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008139 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008140 * For each step, prepend 1 byte with the length of the data as
8141 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008142 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008143 status = psa_pake_output(pake_ctx, step,
8144 buf + output_offset + 1,
8145 len - output_offset - 1,
8146 &output_len);
8147 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008148 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008149 }
8150
Valerio Setti99d88c12022-11-22 16:03:43 +01008151 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008152
8153 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008154 }
8155 }
8156
8157 *olen = output_offset;
8158
Gilles Peskine449bd832023-01-11 14:50:10 +01008159 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008160}
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008161#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Valerio Settia08b1a42022-11-17 15:10:02 +01008162
Gilles Peskine449bd832023-01-11 14:50:10 +01008163int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8164 unsigned char *hash, size_t *hashlen,
8165 unsigned char *data, size_t data_len,
8166 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008167{
8168 psa_status_t status;
8169 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008170 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008171
Gilles Peskine449bd832023-01-11 14:50:10 +01008172 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008173
Gilles Peskine449bd832023-01-11 14:50:10 +01008174 if ((status = psa_hash_setup(&hash_operation,
8175 hash_alg)) != PSA_SUCCESS) {
8176 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008177 goto exit;
8178 }
8179
Gilles Peskine449bd832023-01-11 14:50:10 +01008180 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8181 64)) != PSA_SUCCESS) {
8182 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008183 goto exit;
8184 }
8185
Gilles Peskine449bd832023-01-11 14:50:10 +01008186 if ((status = psa_hash_update(&hash_operation,
8187 data, data_len)) != PSA_SUCCESS) {
8188 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008189 goto exit;
8190 }
8191
Gilles Peskine449bd832023-01-11 14:50:10 +01008192 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8193 hashlen)) != PSA_SUCCESS) {
8194 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8195 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008196 }
8197
8198exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008199 if (status != PSA_SUCCESS) {
8200 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8201 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8202 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008203 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008204 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008205 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8206 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008207 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008208 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008209 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008210 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008211 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008212 }
8213 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008214 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008215}
8216
Jerry Yuee40f9d2022-02-17 14:55:16 +08008217
Jerry Yud9d91da2022-02-17 14:57:06 +08008218#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8219
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008220/* Find the preferred hash for a given signature algorithm. */
8221unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008222 mbedtls_ssl_context *ssl,
8223 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008224{
Gabor Mezei078e8032022-04-27 21:17:56 +02008225 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008226 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008227
Gilles Peskine449bd832023-01-11 14:50:10 +01008228 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8229 return MBEDTLS_SSL_HASH_NONE;
8230 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008231
Gilles Peskine449bd832023-01-11 14:50:10 +01008232 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008233 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008234 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8235 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008236 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008237 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8238 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008239
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008240 mbedtls_md_type_t md_alg =
8241 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8242 if (md_alg == MBEDTLS_MD_NONE) {
8243 continue;
8244 }
8245
Gilles Peskine449bd832023-01-11 14:50:10 +01008246 if (sig_alg == sig_alg_received) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008247 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008248 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008249 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008250
Gilles Peskine449bd832023-01-11 14:50:10 +01008251 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8252 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8253 PSA_ALG_ECDSA(psa_hash_alg),
8254 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008255 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008256 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008257
Gilles Peskine449bd832023-01-11 14:50:10 +01008258 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8259 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8260 PSA_ALG_RSA_PKCS1V15_SIGN(
8261 psa_hash_alg),
8262 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008263 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008264 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008265 }
Neil Armstrong96eceb82022-06-30 18:05:05 +02008266
Gilles Peskine449bd832023-01-11 14:50:10 +01008267 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008268 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008269 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008270
Gilles Peskine449bd832023-01-11 14:50:10 +01008271 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008272}
8273
8274#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8275
Jerry Yudc7bd172022-02-17 13:44:15 +08008276#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8277
XiaokangQian75d40ef2022-04-20 11:05:24 +00008278int mbedtls_ssl_validate_ciphersuite(
8279 const mbedtls_ssl_context *ssl,
8280 const mbedtls_ssl_ciphersuite_t *suite_info,
8281 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01008282 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008283{
8284 (void) ssl;
8285
Gilles Peskine449bd832023-01-11 14:50:10 +01008286 if (suite_info == NULL) {
8287 return -1;
8288 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00008289
Gilles Peskine449bd832023-01-11 14:50:10 +01008290 if ((suite_info->min_tls_version > max_tls_version) ||
8291 (suite_info->max_tls_version < min_tls_version)) {
8292 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008293 }
8294
XiaokangQian060d8672022-04-21 09:24:56 +00008295#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008296#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008297 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
Manuel Pégourié-Gonnard88800dd2025-01-23 11:01:35 +01008298 ssl->handshake->psa_pake_ctx_is_ok != 1) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008299 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008300 }
8301#endif
8302
8303 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8304#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008305 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
8306 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
8307 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008308 }
8309#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8310#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8311
Gilles Peskine449bd832023-01-11 14:50:10 +01008312 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008313}
8314
Ronald Crone68ab4f2022-10-05 12:46:29 +02008315#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00008316/*
8317 * Function for writing a signature algorithm extension.
8318 *
8319 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8320 * value (TLS 1.3 RFC8446):
8321 * enum {
8322 * ....
8323 * ecdsa_secp256r1_sha256( 0x0403 ),
8324 * ecdsa_secp384r1_sha384( 0x0503 ),
8325 * ecdsa_secp521r1_sha512( 0x0603 ),
8326 * ....
8327 * } SignatureScheme;
8328 *
8329 * struct {
8330 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8331 * } SignatureSchemeList;
8332 *
8333 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8334 * value (TLS 1.2 RFC5246):
8335 * enum {
8336 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8337 * sha512(6), (255)
8338 * } HashAlgorithm;
8339 *
8340 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8341 * SignatureAlgorithm;
8342 *
8343 * struct {
8344 * HashAlgorithm hash;
8345 * SignatureAlgorithm signature;
8346 * } SignatureAndHashAlgorithm;
8347 *
8348 * SignatureAndHashAlgorithm
8349 * supported_signature_algorithms<2..2^16-2>;
8350 *
8351 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8352 * generalization of the TLS 1.2 signature algorithm extension.
8353 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8354 * `SignatureScheme` field of TLS 1.3
8355 *
8356 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008357int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
8358 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00008359{
8360 unsigned char *p = buf;
8361 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8362 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8363
8364 *out_len = 0;
8365
Gilles Peskine449bd832023-01-11 14:50:10 +01008366 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00008367
8368 /* Check if we have space for header and length field:
8369 * - extension_type (2 bytes)
8370 * - extension_data_length (2 bytes)
8371 * - supported_signature_algorithms_length (2 bytes)
8372 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008373 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00008374 p += 6;
8375
8376 /*
8377 * Write supported_signature_algorithms
8378 */
8379 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01008380 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
8381 if (sig_alg == NULL) {
8382 return MBEDTLS_ERR_SSL_BAD_CONFIG;
8383 }
XiaokangQianeaf36512022-04-24 09:07:44 +00008384
Gilles Peskine449bd832023-01-11 14:50:10 +01008385 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
8386 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
8387 *sig_alg,
8388 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
8389 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00008390 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008391 }
8392 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
8393 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00008394 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008395 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
8396 *sig_alg,
8397 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00008398 }
8399
8400 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008401 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01008402 if (supported_sig_alg_len == 0) {
8403 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
8404 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00008405 }
8406
Gilles Peskine449bd832023-01-11 14:50:10 +01008407 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
8408 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
8409 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00008410
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008411 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00008412
8413#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008414 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00008415#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08008416
Gilles Peskine449bd832023-01-11 14:50:10 +01008417 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00008418}
Ronald Crone68ab4f2022-10-05 12:46:29 +02008419#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00008420
XiaokangQian40a35232022-05-07 09:02:40 +00008421#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008422/*
8423 * mbedtls_ssl_parse_server_name_ext
8424 *
8425 * Structure of server_name extension:
8426 *
8427 * enum {
8428 * host_name(0), (255)
8429 * } NameType;
8430 * opaque HostName<1..2^16-1>;
8431 *
8432 * struct {
8433 * NameType name_type;
8434 * select (name_type) {
8435 * case host_name: HostName;
8436 * } name;
8437 * } ServerName;
8438 * struct {
8439 * ServerName server_name_list<1..2^16-1>
8440 * } ServerNameList;
8441 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008442MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008443int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
8444 const unsigned char *buf,
8445 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00008446{
8447 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8448 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008449 size_t server_name_list_len, hostname_len;
8450 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008451
Gilles Peskine449bd832023-01-11 14:50:10 +01008452 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00008453
Gilles Peskine449bd832023-01-11 14:50:10 +01008454 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
8455 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00008456 p += 2;
8457
Gilles Peskine449bd832023-01-11 14:50:10 +01008458 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00008459 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008460 while (p < server_name_list_end) {
8461 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
8462 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
8463 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
8464 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00008465
Gilles Peskine449bd832023-01-11 14:50:10 +01008466 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008467 /* sni_name is intended to be used only during the parsing of the
8468 * ClientHello message (it is reset to NULL before the end of
8469 * the message parsing). Thus it is ok to just point to the
8470 * reception buffer and not make a copy of it.
8471 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008472 ssl->handshake->sni_name = p + 3;
8473 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008474 if (ssl->conf->f_sni == NULL) {
8475 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008476 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008477 ret = ssl->conf->f_sni(ssl->conf->p_sni,
8478 ssl, p + 3, hostname_len);
8479 if (ret != 0) {
8480 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
8481 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8482 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
8483 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
8484 }
8485 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008486 }
8487
8488 p += hostname_len + 3;
8489 }
8490
Gilles Peskine449bd832023-01-11 14:50:10 +01008491 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008492}
8493#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8494
XiaokangQianacb39922022-06-17 10:18:48 +00008495#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008496MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008497int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
8498 const unsigned char *buf,
8499 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00008500{
8501 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008502 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008503 const unsigned char *protocol_name_list;
8504 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008505 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008506
8507 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01008508 if (ssl->conf->alpn_list == NULL) {
8509 return 0;
8510 }
XiaokangQianacb39922022-06-17 10:18:48 +00008511
8512 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008513 * RFC7301, section 3.1
8514 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008515 *
XiaokangQianc7403452022-06-23 03:24:12 +00008516 * struct {
8517 * ProtocolName protocol_name_list<2..2^16-1>
8518 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008519 */
8520
XiaokangQianc7403452022-06-23 03:24:12 +00008521 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008522 * protocol_name_list_len 2 bytes
8523 * protocol_name_len 1 bytes
8524 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008525 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008526 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00008527
Gilles Peskine449bd832023-01-11 14:50:10 +01008528 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008529 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008530 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00008531 protocol_name_list = p;
8532 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008533
8534 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01008535 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008536 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008537 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
8538 protocol_name_len);
8539 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008540 MBEDTLS_SSL_PEND_FATAL_ALERT(
8541 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01008542 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
8543 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00008544 }
8545
8546 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008547 }
8548
8549 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01008550 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
8551 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00008552 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01008553 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008554 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008555 if (protocol_name_len == alpn_len &&
8556 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00008557 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01008558 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008559 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008560
8561 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008562 }
8563 }
8564
XiaokangQian95d5f542022-06-24 02:29:26 +00008565 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008566 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01008567 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8568 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
8569 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00008570}
8571
Gilles Peskine449bd832023-01-11 14:50:10 +01008572int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
8573 unsigned char *buf,
8574 unsigned char *end,
8575 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00008576{
8577 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008578 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008579 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008580
Gilles Peskine449bd832023-01-11 14:50:10 +01008581 if (ssl->alpn_chosen == NULL) {
8582 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008583 }
8584
Gilles Peskine449bd832023-01-11 14:50:10 +01008585 protocol_name_len = strlen(ssl->alpn_chosen);
8586 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008587
Gilles Peskine449bd832023-01-11 14:50:10 +01008588 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00008589 /*
8590 * 0 . 1 ext identifier
8591 * 2 . 3 ext length
8592 * 4 . 5 protocol list length
8593 * 6 . 6 protocol name length
8594 * 7 . 7+n protocol name
8595 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008596 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008597
XiaokangQian95d5f542022-06-24 02:29:26 +00008598 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008599
Gilles Peskine449bd832023-01-11 14:50:10 +01008600 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
8601 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00008602 /* Note: the length of the chosen protocol has been checked to be less
8603 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8604 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008605 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008606
Gilles Peskine449bd832023-01-11 14:50:10 +01008607 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08008608
8609#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008610 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08008611#endif
8612
Gilles Peskine449bd832023-01-11 14:50:10 +01008613 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008614}
8615#endif /* MBEDTLS_SSL_ALPN */
8616
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008617#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00008618 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008619 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008620 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008621int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
8622 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008623{
8624 /* Initialize to suppress unnecessary compiler warning */
8625 size_t hostname_len = 0;
8626
8627 /* Check if new hostname is valid before
8628 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008629 if (hostname != NULL) {
8630 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008631
Gilles Peskine449bd832023-01-11 14:50:10 +01008632 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
8633 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8634 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008635 }
8636
8637 /* Now it's clear that we will overwrite the old hostname,
8638 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01008639 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008640 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01008641 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008642 }
8643
8644 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008645 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008646 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01008647 } else {
8648 session->hostname = mbedtls_calloc(1, hostname_len + 1);
8649 if (session->hostname == NULL) {
8650 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8651 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008652
Gilles Peskine449bd832023-01-11 14:50:10 +01008653 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008654 }
8655
Gilles Peskine449bd832023-01-11 14:50:10 +01008656 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008657}
Xiaokang Qian03409292022-10-12 02:49:52 +00008658#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
8659 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008660 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008661 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008662
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008663#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
8664 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008665int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
8666 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008667{
8668 size_t alpn_len = 0;
8669
8670 if (alpn != NULL) {
8671 alpn_len = strlen(alpn);
8672
8673 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
8674 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8675 }
8676 }
8677
8678 if (session->ticket_alpn != NULL) {
8679 mbedtls_zeroize_and_free(session->ticket_alpn,
8680 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008681 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008682 }
8683
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008684 if (alpn != NULL) {
8685 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008686 if (session->ticket_alpn == NULL) {
8687 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8688 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008689 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008690 }
8691
8692 return 0;
8693}
8694#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008695
8696/*
8697 * The following functions are used by 1.2 and 1.3, client and server.
8698 */
8699#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
8700int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
8701 const mbedtls_ssl_ciphersuite_t *ciphersuite,
8702 int recv_endpoint,
8703 mbedtls_ssl_protocol_version tls_version,
8704 uint32_t *flags)
8705{
8706 int ret = 0;
8707 unsigned int usage = 0;
8708 const char *ext_oid;
8709 size_t ext_len;
8710
8711 /*
8712 * keyUsage
8713 */
8714
8715 /* Note: don't guard this with MBEDTLS_SSL_CLI_C because the server wants
8716 * to check what a compliant client will think while choosing which cert
8717 * to send to the client. */
8718#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
8719 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8720 recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8721 /* TLS 1.2 server part of the key exchange */
8722 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008723 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
8724 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
8725 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8726 break;
8727
8728 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
8729 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
8730 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
8731 break;
8732
8733 /* Don't use default: we want warnings when adding new values */
8734 case MBEDTLS_KEY_EXCHANGE_NONE:
8735 case MBEDTLS_KEY_EXCHANGE_PSK:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008736 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
8737 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
8738 usage = 0;
8739 }
8740 } else
8741#endif
8742 {
8743 /* This is either TLS 1.3 authentication, which always uses signatures,
8744 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
8745 * options we implement, both using signatures. */
8746 (void) tls_version;
8747 (void) ciphersuite;
8748 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8749 }
8750
8751 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
8752 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
8753 ret = -1;
8754 }
8755
8756 /*
8757 * extKeyUsage
8758 */
8759
8760 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8761 ext_oid = MBEDTLS_OID_SERVER_AUTH;
8762 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
8763 } else {
8764 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
8765 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
8766 }
8767
8768 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
8769 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
8770 ret = -1;
8771 }
8772
8773 return ret;
8774}
8775
Gilles Peskine4ac40082025-02-20 18:13:58 +01008776static int get_hostname_for_verification(mbedtls_ssl_context *ssl,
8777 const char **hostname)
8778{
8779 if (!mbedtls_ssl_has_set_hostname_been_called(ssl)) {
8780 MBEDTLS_SSL_DEBUG_MSG(1, ("Certificate verification without having set hostname"));
Gilles Peskine488b9192025-02-13 14:39:02 +01008781 if (mbedtls_ssl_conf_get_endpoint(ssl->conf) == MBEDTLS_SSL_IS_CLIENT &&
8782 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8783 return MBEDTLS_ERR_SSL_CERTIFICATE_VERIFICATION_WITHOUT_HOSTNAME;
8784 }
Gilles Peskine4ac40082025-02-20 18:13:58 +01008785 }
8786
8787 *hostname = ssl->hostname;
8788 if (*hostname == NULL) {
8789 MBEDTLS_SSL_DEBUG_MSG(2, ("Certificate verification without CN verification"));
8790 }
8791
8792 return 0;
8793}
8794
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008795int mbedtls_ssl_verify_certificate(mbedtls_ssl_context *ssl,
8796 int authmode,
8797 mbedtls_x509_crt *chain,
8798 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
8799 void *rs_ctx)
8800{
8801 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
8802 return 0;
8803 }
8804
8805 /*
8806 * Primary check: use the appropriate X.509 verification function
8807 */
8808 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
8809 void *p_vrfy;
8810 if (ssl->f_vrfy != NULL) {
8811 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
8812 f_vrfy = ssl->f_vrfy;
8813 p_vrfy = ssl->p_vrfy;
8814 } else {
8815 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
8816 f_vrfy = ssl->conf->f_vrfy;
8817 p_vrfy = ssl->conf->p_vrfy;
8818 }
8819
Gilles Peskine4ac40082025-02-20 18:13:58 +01008820 const char *hostname = "";
8821 int ret = get_hostname_for_verification(ssl, &hostname);
8822 if (ret != 0) {
8823 MBEDTLS_SSL_DEBUG_RET(1, "get_hostname_for_verification", ret);
8824 return ret;
8825 }
8826
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008827 int have_ca_chain_or_callback = 0;
8828#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
8829 if (ssl->conf->f_ca_cb != NULL) {
8830 ((void) rs_ctx);
8831 have_ca_chain_or_callback = 1;
8832
8833 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
8834 ret = mbedtls_x509_crt_verify_with_ca_cb(
8835 chain,
8836 ssl->conf->f_ca_cb,
8837 ssl->conf->p_ca_cb,
8838 ssl->conf->cert_profile,
Gilles Peskine4ac40082025-02-20 18:13:58 +01008839 hostname,
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008840 &ssl->session_negotiate->verify_result,
8841 f_vrfy, p_vrfy);
8842 } else
8843#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
8844 {
8845 mbedtls_x509_crt *ca_chain;
8846 mbedtls_x509_crl *ca_crl;
8847#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8848 if (ssl->handshake->sni_ca_chain != NULL) {
8849 ca_chain = ssl->handshake->sni_ca_chain;
8850 ca_crl = ssl->handshake->sni_ca_crl;
8851 } else
8852#endif
8853 {
8854 ca_chain = ssl->conf->ca_chain;
8855 ca_crl = ssl->conf->ca_crl;
8856 }
8857
8858 if (ca_chain != NULL) {
8859 have_ca_chain_or_callback = 1;
8860 }
8861
8862 ret = mbedtls_x509_crt_verify_restartable(
8863 chain,
8864 ca_chain, ca_crl,
8865 ssl->conf->cert_profile,
Gilles Peskine4ac40082025-02-20 18:13:58 +01008866 hostname,
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008867 &ssl->session_negotiate->verify_result,
8868 f_vrfy, p_vrfy, rs_ctx);
8869 }
8870
8871 if (ret != 0) {
8872 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
8873 }
8874
8875#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
8876 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8877 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8878 }
8879#endif
8880
8881 /*
8882 * Secondary checks: always done, but change 'ret' only if it was 0
8883 */
8884
8885 /* With TLS 1.2 and ECC certs, check that the curve used by the
8886 * certificate is on our list of acceptable curves.
8887 *
8888 * With TLS 1.3 this is not needed because the curve is part of the
8889 * signature algorithm (eg ecdsa_secp256r1_sha256) which is checked when
8890 * we validate the signature made with the key associated to this cert.
8891 */
8892#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
8893 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
8894 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8895 mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY)) {
8896 if (mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
8897 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8898 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
8899 if (ret == 0) {
8900 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8901 }
8902 }
8903 }
8904#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
8905
8906 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
8907 if (mbedtls_ssl_check_cert_usage(chain,
8908 ciphersuite_info,
8909 ssl->conf->endpoint,
8910 ssl->tls_version,
8911 &ssl->session_negotiate->verify_result) != 0) {
8912 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8913 if (ret == 0) {
8914 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8915 }
8916 }
8917
8918 /* With authmode optional, we want to keep going if the certificate was
8919 * unacceptable, but still fail on other errors (out of memory etc),
8920 * including fatal errors from the f_vrfy callback.
8921 *
8922 * The only acceptable errors are:
8923 * - MBEDTLS_ERR_X509_CERT_VERIFY_FAILED: cert rejected by primary check;
8924 * - MBEDTLS_ERR_SSL_BAD_CERTIFICATE: cert rejected by secondary checks.
8925 * Anything else is a fatal error. */
8926 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8927 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8928 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
8929 ret = 0;
8930 }
8931
8932 /* Return a specific error as this is a user error: inconsistent
8933 * configuration - can't verify without trust anchors. */
8934 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8935 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
8936 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8937 }
8938
8939 if (ret != 0) {
8940 uint8_t alert;
8941
8942 /* The certificate may have been rejected for several reasons.
8943 Pick one and send the corresponding alert. Which alert to send
8944 may be a subject of debate in some cases. */
8945 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
8946 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
8947 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
8948 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
8949 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
8950 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8951 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
8952 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8953 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
8954 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8955 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
8956 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8957 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
8958 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
8959 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
8960 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
8961 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
8962 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
8963 } else {
8964 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
8965 }
8966 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8967 alert);
8968 }
8969
8970#if defined(MBEDTLS_DEBUG_C)
8971 if (ssl->session_negotiate->verify_result != 0) {
8972 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8973 (unsigned int) ssl->session_negotiate->verify_result));
8974 } else {
8975 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
8976 }
8977#endif /* MBEDTLS_DEBUG_C */
8978
8979 return ret;
8980}
8981#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
8982
Max Fillinger2fe35f62024-10-25 00:52:24 +02008983#if defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT)
Max Fillinger281fb792024-10-23 18:35:09 +02008984
Max Fillinger29beade2024-09-21 11:06:28 +02008985#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008986static int mbedtls_ssl_tls12_export_keying_material(const mbedtls_ssl_context *ssl,
8987 const mbedtls_md_type_t hash_alg,
Max Fillinger7b722202024-09-21 10:48:57 +02008988 uint8_t *out,
8989 const size_t key_len,
8990 const char *label,
8991 const size_t label_len,
8992 const unsigned char *context,
8993 const size_t context_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008994 const int use_context)
8995{
8996 int ret = 0;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008997 unsigned char *prf_input = NULL;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008998
Max Fillingerbd81c9d2024-07-22 14:43:56 +02008999 /* The input to the PRF is client_random, then server_random.
9000 * If a context is provided, this is then followed by the context length
9001 * as a 16-bit big-endian integer, and then the context itself. */
Max Fillinger155cea02024-10-23 16:32:54 +02009002 const size_t randbytes_len = MBEDTLS_CLIENT_HELLO_RANDOM_LEN + MBEDTLS_SERVER_HELLO_RANDOM_LEN;
9003 size_t prf_input_len = randbytes_len;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009004 if (use_context) {
Max Fillinger155cea02024-10-23 16:32:54 +02009005 if (context_len > UINT16_MAX) {
9006 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9007 }
9008
9009 /* This does not overflow a 32-bit size_t because the current value of
9010 * prf_input_len is 64 (length of client_random + server_random) and
9011 * context_len fits into two bytes (checked above). */
9012 prf_input_len += sizeof(uint16_t) + context_len;
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009013 }
Max Fillinger155cea02024-10-23 16:32:54 +02009014
9015 prf_input = mbedtls_calloc(prf_input_len, sizeof(unsigned char));
9016 if (prf_input == NULL) {
9017 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9018 }
9019
9020 memcpy(prf_input,
9021 ssl->transform->randbytes + MBEDTLS_SERVER_HELLO_RANDOM_LEN,
9022 MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
9023 memcpy(prf_input + MBEDTLS_CLIENT_HELLO_RANDOM_LEN,
9024 ssl->transform->randbytes,
9025 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
9026 if (use_context) {
9027 MBEDTLS_PUT_UINT16_BE(context_len, prf_input, randbytes_len);
9028 memcpy(prf_input + randbytes_len + sizeof(uint16_t), context, context_len);
9029 }
9030 ret = tls_prf_generic(hash_alg, ssl->session->master, sizeof(ssl->session->master),
Max Fillingerf2dda152024-10-23 15:47:23 +02009031 label, label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009032 prf_input, prf_input_len,
9033 out, key_len);
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009034 mbedtls_free(prf_input);
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009035 return ret;
9036}
Max Fillinger281fb792024-10-23 18:35:09 +02009037#endif /* defined(MBEDTLS_SSL_PROTO_TLS1_2) */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009038
Max Fillinger29beade2024-09-21 11:06:28 +02009039#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009040static int mbedtls_ssl_tls13_export_keying_material(mbedtls_ssl_context *ssl,
9041 const mbedtls_md_type_t hash_alg,
Max Fillinger7b722202024-09-21 10:48:57 +02009042 uint8_t *out,
9043 const size_t key_len,
9044 const char *label,
9045 const size_t label_len,
9046 const unsigned char *context,
9047 const size_t context_len)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009048{
9049 const psa_algorithm_t psa_hash_alg = mbedtls_md_psa_alg_from_type(hash_alg);
9050 const size_t hash_len = PSA_HASH_LENGTH(hash_alg);
9051 const unsigned char *secret = ssl->session->app_secrets.exporter_master_secret;
9052
Max Fillinger9c5bae52024-11-21 12:33:46 +01009053 /* The length of the label must be at most 249 bytes to fit into the HkdfLabel
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009054 * struct as defined in RFC 8446, Section 7.1.
Max Fillinger3e129182024-10-29 19:18:54 +01009055 *
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009056 * The length of the context is unlimited even though the context field in the
Max Fillinger9c5bae52024-11-21 12:33:46 +01009057 * struct can only hold up to 255 bytes. This is because we place a *hash* of
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009058 * the context in the field. */
Max Fillinger9c5bae52024-11-21 12:33:46 +01009059 if (label_len > 249) {
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009060 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9061 }
9062
9063 return mbedtls_ssl_tls13_exporter(psa_hash_alg, secret, hash_len,
Max Fillinger7b722202024-09-21 10:48:57 +02009064 (const unsigned char *) label, label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009065 context, context_len, out, key_len);
9066}
Max Fillinger281fb792024-10-23 18:35:09 +02009067#endif /* defined(MBEDTLS_SSL_PROTO_TLS1_3) */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009068
9069int mbedtls_ssl_export_keying_material(mbedtls_ssl_context *ssl,
Max Fillinger9c9989f2024-08-14 16:44:50 +02009070 uint8_t *out, const size_t key_len,
9071 const char *label, const size_t label_len,
9072 const unsigned char *context, const size_t context_len,
9073 const int use_context)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009074{
9075 if (!mbedtls_ssl_is_handshake_over(ssl)) {
Max Fillinger53d91682024-11-18 18:22:51 +01009076 /* TODO: Change this to a more appropriate error code when one is available. */
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009077 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9078 }
9079
Max Fillingerc6fd1a22024-11-01 16:05:34 +01009080 if (key_len > MBEDTLS_SSL_EXPORT_MAX_KEY_LEN) {
9081 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9082 }
9083
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009084 int ciphersuite_id = mbedtls_ssl_get_ciphersuite_id_from_ssl(ssl);
9085 const mbedtls_ssl_ciphersuite_t *ciphersuite = mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
9086 const mbedtls_md_type_t hash_alg = ciphersuite->mac;
9087
9088 switch (mbedtls_ssl_get_version_number(ssl)) {
Max Fillinger29beade2024-09-21 11:06:28 +02009089#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009090 case MBEDTLS_SSL_VERSION_TLS1_2:
9091 return mbedtls_ssl_tls12_export_keying_material(ssl, hash_alg, out, key_len,
9092 label, label_len,
9093 context, context_len, use_context);
Max Fillinger29beade2024-09-21 11:06:28 +02009094#endif
9095#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009096 case MBEDTLS_SSL_VERSION_TLS1_3:
Max Fillinger7b722202024-09-21 10:48:57 +02009097 return mbedtls_ssl_tls13_export_keying_material(ssl,
9098 hash_alg,
9099 out,
9100 key_len,
9101 label,
9102 label_len,
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009103 use_context ? context : NULL,
9104 use_context ? context_len : 0);
Max Fillinger29beade2024-09-21 11:06:28 +02009105#endif
Max Fillingerbd81c9d2024-07-22 14:43:56 +02009106 default:
9107 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
9108 }
9109}
9110
Max Fillinger2fe35f62024-10-25 00:52:24 +02009111#endif /* defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT) */
Max Fillinger281fb792024-10-23 18:35:09 +02009112
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009113#endif /* MBEDTLS_SSL_TLS_C */