blob: 75dde2b8eec4f22816e673f4de74d24544a72721 [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"
Andrzej Kurek25f27152022-08-17 16:09:31 -040021
Valerio Settib4f50762024-01-17 10:24:52 +010022#include "debug_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000023#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050024#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010025#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020026#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020027
Rich Evans00ab4702015-02-06 13:43:58 +000028#include <string.h>
29
Valerio Setti384fbde2024-01-02 13:26:40 +010030#include "mbedtls/psa_util.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020031#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020032#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050033#include "psa/crypto.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050034
Janos Follath23bdca02016-10-07 14:47:14 +010035#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000036#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020037#endif
38
Andrzej Kurek00644842023-05-30 05:45:00 -040039/* Define local translating functions to save code size by not using too many
40 * arguments in each translating place. */
41static int local_err_translation(psa_status_t status)
42{
43 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040044 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040045 psa_generic_status_to_mbedtls);
46}
47#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050048
Ronald Cronad8c17b2022-06-10 17:18:09 +020049#if defined(MBEDTLS_TEST_HOOKS)
50static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
51
52void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010053 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020054{
55 chk_buf_ptr_fail_args.cur = cur;
56 chk_buf_ptr_fail_args.end = end;
57 chk_buf_ptr_fail_args.need = need;
58}
59
Gilles Peskine449bd832023-01-11 14:50:10 +010060void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020061{
Gilles Peskine449bd832023-01-11 14:50:10 +010062 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020063}
64
Gilles Peskine449bd832023-01-11 14:50:10 +010065int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020066{
Gilles Peskine449bd832023-01-11 14:50:10 +010067 return (chk_buf_ptr_fail_args.cur != args->cur) ||
68 (chk_buf_ptr_fail_args.end != args->end) ||
69 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020070}
71#endif /* MBEDTLS_TEST_HOOKS */
72
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020073#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010074
Hanno Beckera0e20d02019-05-15 14:03:01 +010075#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010076/* Top-level Connection ID API */
77
Gilles Peskine449bd832023-01-11 14:50:10 +010078int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
79 size_t len,
80 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010081{
Gilles Peskine449bd832023-01-11 14:50:10 +010082 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
83 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
84 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010085
Gilles Peskine449bd832023-01-11 14:50:10 +010086 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
87 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
88 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010089 }
90
91 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010092 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010093 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010094}
95
Gilles Peskine449bd832023-01-11 14:50:10 +010096int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
97 int enable,
98 unsigned char const *own_cid,
99 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100100{
Gilles Peskine449bd832023-01-11 14:50:10 +0100101 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
102 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
103 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100104
Hanno Beckerca092242019-04-25 16:01:49 +0100105 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100106 if (enable == MBEDTLS_SSL_CID_DISABLED) {
107 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
108 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100109 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
111 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100112
Gilles Peskine449bd832023-01-11 14:50:10 +0100113 if (own_cid_len != ssl->conf->cid_len) {
114 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
115 (unsigned) own_cid_len,
116 (unsigned) ssl->conf->cid_len));
117 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100118 }
119
Gilles Peskine449bd832023-01-11 14:50:10 +0100120 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100121 /* Truncation is not an issue here because
122 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
123 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100124
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100126}
127
Gilles Peskine449bd832023-01-11 14:50:10 +0100128int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
129 int *enabled,
Sam Berry3504c882024-06-11 14:34:17 +0100130 unsigned char own_cid[MBEDTLS_SSL_CID_IN_LEN_MAX],
Gilles Peskine449bd832023-01-11 14:50:10 +0100131 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000132{
133 *enabled = MBEDTLS_SSL_CID_DISABLED;
134
Gilles Peskine449bd832023-01-11 14:50:10 +0100135 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
136 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
137 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000138
139 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
140 * zero as this is indistinguishable from not requesting to use
141 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100142 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
143 return 0;
144 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000145
Gilles Peskine449bd832023-01-11 14:50:10 +0100146 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000147 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100148 if (own_cid != NULL) {
149 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
150 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000151 }
152
153 *enabled = MBEDTLS_SSL_CID_ENABLED;
154
Gilles Peskine449bd832023-01-11 14:50:10 +0100155 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000156}
157
Gilles Peskine449bd832023-01-11 14:50:10 +0100158int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
159 int *enabled,
160 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
161 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100162{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100163 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100164
Gilles Peskine449bd832023-01-11 14:50:10 +0100165 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
166 mbedtls_ssl_is_handshake_over(ssl) == 0) {
167 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100168 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100169
Hanno Beckerc5f24222019-05-03 12:54:52 +0100170 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
171 * were used, but client and server requested the empty CID.
172 * This is indistinguishable from not using the CID extension
173 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100174 if (ssl->transform_in->in_cid_len == 0 &&
175 ssl->transform_in->out_cid_len == 0) {
176 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100177 }
178
Gilles Peskine449bd832023-01-11 14:50:10 +0100179 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100180 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100181 if (peer_cid != NULL) {
182 memcpy(peer_cid, ssl->transform_in->out_cid,
183 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100184 }
185 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100186
187 *enabled = MBEDTLS_SSL_CID_ENABLED;
188
Gilles Peskine449bd832023-01-11 14:50:10 +0100189 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100190}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100191#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100192
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200193#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200194
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200195#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200196/*
197 * Convert max_fragment_length codes to length.
198 * RFC 6066 says:
199 * enum{
200 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
201 * } MaxFragmentLength;
202 * and we add 0 -> extension unused
203 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100204static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200205{
Gilles Peskine449bd832023-01-11 14:50:10 +0100206 switch (mfl) {
207 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
208 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
209 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
210 return 512;
211 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
212 return 1024;
213 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
214 return 2048;
215 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
216 return 4096;
217 default:
218 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000219 }
220}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200221#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200222
Gilles Peskine449bd832023-01-11 14:50:10 +0100223int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
224 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200225{
Gilles Peskine449bd832023-01-11 14:50:10 +0100226 mbedtls_ssl_session_free(dst);
227 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800228#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
229 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000230#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
231 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000232 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800233#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000234#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800235
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000236#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
237 defined(MBEDTLS_SSL_EARLY_DATA)
238 dst->ticket_alpn = NULL;
239#endif
240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000242
243#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000245 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200246
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
248 if (dst->peer_cert == NULL) {
249 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
250 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200251
Gilles Peskine449bd832023-01-11 14:50:10 +0100252 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200253
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
255 src->peer_cert->raw.len)) != 0) {
256 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200257 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200259 }
260 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000261#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100262 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000263 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100264 mbedtls_calloc(1, src->peer_cert_digest_len);
265 if (dst->peer_cert_digest == NULL) {
266 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
267 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000268
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
270 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000271 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000272 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000273 }
274#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200276#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200277
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000278#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
279 defined(MBEDTLS_SSL_EARLY_DATA)
280 {
281 int ret = mbedtls_ssl_session_set_ticket_alpn(dst, src->ticket_alpn);
282 if (ret != 0) {
283 return ret;
284 }
285 }
286#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_ALPN && MBEDTLS_SSL_EARLY_DATA */
287
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200288#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 if (src->ticket != NULL) {
290 dst->ticket = mbedtls_calloc(1, src->ticket_len);
291 if (dst->ticket == NULL) {
292 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
293 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200294
Gilles Peskine449bd832023-01-11 14:50:10 +0100295 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200296 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000297
298#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
299 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000301 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100302 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
303 if (ret != 0) {
304 return ret;
305 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000306 }
307#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
308 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200309#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200310
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200312}
313
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500314#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200315MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100316static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500317{
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
319 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800320 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100321 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500322
323 /* We want to copy len_new bytes when downsizing the buffer, and
324 * len_old bytes when upsizing, so we choose the smaller of two sizes,
325 * to fit one buffer into another. Size checks, ensuring that no data is
326 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100327 memcpy(resized_buffer, *buffer,
328 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100329 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500330
331 *buffer = resized_buffer;
332 *len_old = len_new;
333
334 return 0;
335}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200336
Gilles Peskine449bd832023-01-11 14:50:10 +0100337static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
338 size_t in_buf_new_len,
339 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200340{
341 int modified = 0;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000342 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0, hdr_in = 0;
Andrzej Kurek4a063792020-10-21 15:08:44 +0200343 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100344 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345 written_in = ssl->in_msg - ssl->in_buf;
346 iv_offset_in = ssl->in_iv - ssl->in_buf;
347 len_offset_in = ssl->in_len - ssl->in_buf;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000348 hdr_in = ssl->in_hdr - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200350 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 ssl->in_buf_len < in_buf_new_len) {
352 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
353 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
354 } else {
355 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
356 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200357 modified = 1;
358 }
359 }
360 }
361
Gilles Peskine449bd832023-01-11 14:50:10 +0100362 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200363 written_out = ssl->out_msg - ssl->out_buf;
364 iv_offset_out = ssl->out_iv - ssl->out_buf;
365 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200367 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 ssl->out_buf_len < out_buf_new_len) {
369 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
370 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
371 } else {
372 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
373 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200374 modified = 1;
375 }
376 }
377 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100378 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200379 /* Update pointers here to avoid doing it twice. */
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000380 ssl->in_hdr = ssl->in_buf + hdr_in;
381 mbedtls_ssl_update_in_pointers(ssl);
382 mbedtls_ssl_reset_out_pointers(ssl);
383
Andrzej Kurek4a063792020-10-21 15:08:44 +0200384 /* Fields below might not be properly updated with record
385 * splitting or with CID, so they are manually updated here. */
386 ssl->out_msg = ssl->out_buf + written_out;
387 ssl->out_len = ssl->out_buf + len_offset_out;
388 ssl->out_iv = ssl->out_buf + iv_offset_out;
389
390 ssl->in_msg = ssl->in_buf + written_in;
391 ssl->in_len = ssl->in_buf + len_offset_in;
392 ssl->in_iv = ssl->in_buf + iv_offset_in;
393 }
394}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500395#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
396
Jerry Yudb8c48a2022-01-27 14:54:54 +0800397#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800398
399#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100400typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
401 const char *label,
402 const unsigned char *random, size_t rlen,
403 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800404
Gilles Peskine449bd832023-01-11 14:50:10 +0100405static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800406
407#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
408
409/* Type for the TLS PRF */
410typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
411 const unsigned char *, size_t,
412 unsigned char *, size_t);
413
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200414MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100415static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
416 int ciphersuite,
417 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200418#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100419 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200420#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100421 ssl_tls_prf_t tls_prf,
422 const unsigned char randbytes[64],
423 mbedtls_ssl_protocol_version tls_version,
424 unsigned endpoint,
425 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800426
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100427#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200428MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100429static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300430 const char *label,
431 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100432 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100433static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
434static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100435
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100436#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100437
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100438#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100439MBEDTLS_CHECK_RETURN_CRITICAL
440static int tls_prf_sha384(const unsigned char *secret, size_t slen,
441 const char *label,
442 const unsigned char *random, size_t rlen,
443 unsigned char *dstbuf, size_t dlen);
444
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100445static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
446static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100447#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100448
Gilles Peskine449bd832023-01-11 14:50:10 +0100449MBEDTLS_CHECK_RETURN_CRITICAL
450static int ssl_tls12_session_load(mbedtls_ssl_session *session,
451 const unsigned char *buf,
452 size_t len);
453#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
454
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100455static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100456
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100457#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100458static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100459#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100460
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100461#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100462static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100463#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100464
465int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
466 const unsigned char *secret, size_t slen,
467 const char *label,
468 const unsigned char *random, size_t rlen,
469 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300470{
471 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
472
Gilles Peskine449bd832023-01-11 14:50:10 +0100473 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300474#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100475#if defined(PSA_WANT_ALG_SHA_384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300476 case MBEDTLS_SSL_TLS_PRF_SHA384:
477 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100478 break;
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100479#endif /* PSA_WANT_ALG_SHA_384*/
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100480#if defined(PSA_WANT_ALG_SHA_256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300481 case MBEDTLS_SSL_TLS_PRF_SHA256:
482 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 break;
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100484#endif /* PSA_WANT_ALG_SHA_256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300485#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100486 default:
487 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300488 }
489
Gilles Peskine449bd832023-01-11 14:50:10 +0100490 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300491}
492
Jerry Yuc73c6182022-02-08 20:29:25 +0800493#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100494static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800495{
496#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100497 if (session->peer_cert != NULL) {
498 mbedtls_x509_crt_free(session->peer_cert);
499 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800500 session->peer_cert = NULL;
501 }
502#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100503 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800504 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100505 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800506 session->peer_cert_digest = NULL;
507 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
508 session->peer_cert_digest_len = 0;
509 }
510#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
511}
512#endif /* MBEDTLS_X509_CRT_PARSE_C */
513
Gilles Peskine449bd832023-01-11 14:50:10 +0100514uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800515{
Gilles Peskine449bd832023-01-11 14:50:10 +0100516 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800517 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100518 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800519
520 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100521 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800522
523 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100524 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800525
526 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100527 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800528
529 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100530 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800531
532 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100533 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800534
535 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100536 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800537
538 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100539 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800540
541 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100542 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800543
544 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100545 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800546
547 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100548 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800549
550 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100551 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800552
553 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100554 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800555
556 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100557 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800558
559 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100560 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800561
562 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100563 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800564
565 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100566 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800567
568 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100569 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800570
571 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100572 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800573
574 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100575 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800576
577 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100578 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800579
580 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100581 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800582
583 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100584 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800585
586 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100587 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800588
589 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100590 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800591
592 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100593 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800594
Jan Bruckner151f6422023-02-10 12:45:19 +0100595 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
596 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
597
Jerry Yu7a485c12022-10-31 13:08:18 +0800598 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100599 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800600
601 }
602
Gilles Peskine449bd832023-01-11 14:50:10 +0100603 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800604}
605
Gilles Peskine449bd832023-01-11 14:50:10 +0100606uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800607{
Gilles Peskine449bd832023-01-11 14:50:10 +0100608 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800609}
610
Jerry Yud25cab02022-10-31 12:48:30 +0800611#if defined(MBEDTLS_DEBUG_C)
612static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800613 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800614 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
615 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
616 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
617 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
618 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
619 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
620 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
621 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
622 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
623 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
624 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
625 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
626 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
627 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
628 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
629 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
630 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
631 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
632 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
633 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
634 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
635 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
636 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
637 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
638 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
639 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100640 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
641 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800642};
643
Chien Wong4e9683e2023-12-28 17:07:43 +0800644static const unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800645 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
646 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
647 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
648 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
649 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
650 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
651 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
652 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
653 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
654 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
655 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
656 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
657 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
658 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
659 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
660 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
661 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
662 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
663 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
664 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
665 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
666 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
667 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
668 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
669 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
670 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
671 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100672 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
673 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800674};
675
Gilles Peskine449bd832023-01-11 14:50:10 +0100676const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800677{
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 return extension_name_table[
679 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800680}
681
Gilles Peskine449bd832023-01-11 14:50:10 +0100682static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800683{
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800685 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800687 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100688 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800689 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100690 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800691 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800693 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100694 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800695 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800697 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100698 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800699 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100700 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800701}
702
Gilles Peskine449bd832023-01-11 14:50:10 +0100703void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
704 int level, const char *file, int line,
705 int hs_msg_type, unsigned int extension_type,
706 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800707{
708 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100709 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800710 mbedtls_debug_print_msg(
711 ssl, level, file, line,
712 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 ssl_tls13_get_hs_msg_name(hs_msg_type),
714 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800715 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100716 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800717 return;
718 }
719
720 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100721 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800722 mbedtls_debug_print_msg(
723 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100724 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
725 mbedtls_ssl_get_extension_name(extension_type), extension_type,
726 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800727 return;
728 }
729
730 mbedtls_debug_print_msg(
731 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100732 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
733 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800734}
735
Gilles Peskine449bd832023-01-11 14:50:10 +0100736void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
737 int level, const char *file, int line,
738 int hs_msg_type, uint32_t extensions_mask,
739 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800740{
741
Gilles Peskine449bd832023-01-11 14:50:10 +0100742 for (unsigned i = 0;
743 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
744 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800745 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800746 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100747 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800748 }
749}
750
Pengyu Lvee455c02023-01-12 14:37:24 +0800751#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800752static const char *ticket_flag_name_table[] =
753{
754 [0] = "ALLOW_PSK_RESUMPTION",
755 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
756 [3] = "ALLOW_EARLY_DATA",
757};
758
Pengyu Lv4938a562023-01-16 11:28:49 +0800759void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
760 int level, const char *file, int line,
761 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800762{
763 size_t i;
764
765 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800766 "print ticket_flags (0x%02x)", flags);
767
768 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800769
770 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800771 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800772 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
773 ticket_flag_name_table[i]);
774 }
775 }
776}
777#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
778
Jerry Yud25cab02022-10-31 12:48:30 +0800779#endif /* MBEDTLS_DEBUG_C */
780
Gilles Peskine449bd832023-01-11 14:50:10 +0100781void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
782 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800783{
784 ((void) ciphersuite_info);
785
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100786#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800788 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100789 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800790#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100791#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100792 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800793 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100794 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800795#endif
796 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100797 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800798 return;
799 }
800}
801
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100802int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100803 unsigned hs_type,
804 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100805{
806 unsigned char hs_hdr[4];
807
808 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100809 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
810 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
811 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
812 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100813
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100814 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100815}
816
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100817int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100818 unsigned hs_type,
819 unsigned char const *msg,
820 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100821{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100822 int ret;
823 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100824 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100825 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100826 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100827 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100828}
829
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100830int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800831{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100832#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100833 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100834 psa_status_t status;
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100835#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800836 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100837#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100838#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100839 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
840 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200841 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100842 }
843 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
844 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200845 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100846 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800847#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100848#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100849 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
850 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200851 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100852 }
853 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
854 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200855 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100856 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800857#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100858 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800859}
860
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100861static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100862 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800863{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100864#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100865 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100866 psa_status_t status;
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100867#else /* SHA-256 or SHA-384 */
868 ((void) ssl);
869 (void) buf;
870 (void) len;
871#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100872#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100873 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
874 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200875 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100876 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800877#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100878#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100879 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
880 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200881 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100882 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800883#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100884 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800885}
886
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100887#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100888static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100889 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800890{
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200891 return mbedtls_md_error_from_psa(psa_hash_update(
892 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800893}
894#endif
895
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100896#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100897static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100898 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800899{
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200900 return mbedtls_md_error_from_psa(psa_hash_update(
901 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800902}
903#endif
904
Gilles Peskine449bd832023-01-11 14:50:10 +0100905static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200906{
Gilles Peskine449bd832023-01-11 14:50:10 +0100907 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200908
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100909#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500910 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500911#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100912#if defined(PSA_WANT_ALG_SHA_384)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500913 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500914#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200915
916 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100917
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200918#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200919 handshake->psa_pake_ctx = psa_pake_operation_init();
920 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200921#if defined(MBEDTLS_SSL_CLI_C)
922 handshake->ecjpake_cache = NULL;
923 handshake->ecjpake_cache_len = 0;
924#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200925#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200926
Gilles Peskineeccd8882020-03-10 12:19:08 +0100927#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100928 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200929#endif
930
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200931#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
932 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
933#endif
Hanno Becker75173122019-02-06 16:18:31 +0000934
935#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
936 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100937 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +0000938#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200939}
940
Gilles Peskine449bd832023-01-11 14:50:10 +0100941void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200942{
Gilles Peskine449bd832023-01-11 14:50:10 +0100943 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +0200944
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100945 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
946 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +0100947
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000948#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100949 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
950 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100951#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200952}
953
Gilles Peskine449bd832023-01-11 14:50:10 +0100954void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200955{
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200957}
958
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200959MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100960static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +0000961{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100962 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
963
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200964 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +0800965#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +0100966 if (ssl->transform_negotiate) {
967 mbedtls_ssl_transform_free(ssl->transform_negotiate);
968 }
Jerry Yu2e199812022-12-01 18:57:19 +0800969#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100970 if (ssl->session_negotiate) {
971 mbedtls_ssl_session_free(ssl->session_negotiate);
972 }
973 if (ssl->handshake) {
974 mbedtls_ssl_handshake_free(ssl);
975 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200976
Jerry Yu2e199812022-12-01 18:57:19 +0800977#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200978 /*
979 * Either the pointers are now NULL or cleared properly and can be freed.
980 * Now allocate missing structures.
981 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100982 if (ssl->transform_negotiate == NULL) {
983 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200984 }
Jerry Yu2e199812022-12-01 18:57:19 +0800985#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000986
Gilles Peskine449bd832023-01-11 14:50:10 +0100987 if (ssl->session_negotiate == NULL) {
988 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200989 }
Paul Bakker48916f92012-09-16 19:57:18 +0000990
Gilles Peskine449bd832023-01-11 14:50:10 +0100991 if (ssl->handshake == NULL) {
992 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +0200993 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500994#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
995 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -0400996
Gilles Peskine449bd832023-01-11 14:50:10 +0100997 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
998 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500999#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001000
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001001 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001002 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001003#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001004 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001005#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001006 ssl->session_negotiate == NULL) {
1007 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001008
Gilles Peskine449bd832023-01-11 14:50:10 +01001009 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001010 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001011
1012#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001014 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001015#endif
1016
Gilles Peskine449bd832023-01-11 14:50:10 +01001017 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001018 ssl->session_negotiate = NULL;
1019
Gilles Peskine449bd832023-01-11 14:50:10 +01001020 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001021 }
1022
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001023#if defined(MBEDTLS_SSL_EARLY_DATA)
1024#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001025 ssl->early_data_state = MBEDTLS_SSL_EARLY_DATA_STATE_IDLE;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001026#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001027#if defined(MBEDTLS_SSL_SRV_C)
1028 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1029#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001030 ssl->total_early_data_size = 0;
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001031#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001032
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001033 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001034 mbedtls_ssl_session_init(ssl->session_negotiate);
1035 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001036
Jerry Yu2e199812022-12-01 18:57:19 +08001037#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001038 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001039#endif
1040
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001041 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001042 ret = mbedtls_ssl_reset_checksum(ssl);
1043 if (ret != 0) {
1044 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1045 return ret;
1046 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001047
Jerry Yud0766ec2022-09-22 10:46:57 +08001048#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1049 defined(MBEDTLS_SSL_SRV_C) && \
1050 defined(MBEDTLS_SSL_SESSION_TICKETS)
1051 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001052 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001053#endif
1054
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001055#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001056 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001057 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001058
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001060 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001062 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001063 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001064
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001066 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001067#endif
1068
Ronald Crone68ab4f2022-10-05 12:46:29 +02001069#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001070#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001071#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001072 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1073 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1075 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001076 const int *md;
1077 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001078 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001079 uint16_t *p;
1080
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001081 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1082 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1083 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001084
Gilles Peskine449bd832023-01-11 14:50:10 +01001085 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1086 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001087 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001088 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001089#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001091#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001092
Jerry Yub476a442022-01-21 18:14:45 +08001093#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001095#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1097 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1098 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001099 }
1100
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1102 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1103 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001104
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1106 sizeof(uint16_t));
1107 if (ssl->handshake->sig_algs == NULL) {
1108 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1109 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001110
Gilles Peskine449bd832023-01-11 14:50:10 +01001111 p = (uint16_t *) ssl->handshake->sig_algs;
1112 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1113 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1114 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001115 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001116 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001117#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001118 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001119 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001120#endif
1121#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001122 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001123 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001124#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001125 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001126 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001127 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001129#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001130 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001131 ssl->handshake->sig_algs_heap_allocated = 0;
1132 }
Jerry Yucc539102022-06-27 16:27:35 +08001133#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001134#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001136}
1137
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001138#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001139/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001140MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001141static int ssl_cookie_write_dummy(void *ctx,
1142 unsigned char **p, unsigned char *end,
1143 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001144{
1145 ((void) ctx);
1146 ((void) p);
1147 ((void) end);
1148 ((void) cli_id);
1149 ((void) cli_id_len);
1150
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001152}
1153
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001154MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001155static int ssl_cookie_check_dummy(void *ctx,
1156 const unsigned char *cookie, size_t cookie_len,
1157 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001158{
1159 ((void) ctx);
1160 ((void) cookie);
1161 ((void) cookie_len);
1162 ((void) cli_id);
1163 ((void) cli_id_len);
1164
Gilles Peskine449bd832023-01-11 14:50:10 +01001165 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001166}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001167#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001168
Paul Bakker5121ce52009-01-03 21:22:43 +00001169/*
1170 * Initialize an SSL context
1171 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001172void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001173{
Gilles Peskine449bd832023-01-11 14:50:10 +01001174 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001175}
1176
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001177MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001178static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001179{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001180 const mbedtls_ssl_config *conf = ssl->conf;
1181
Ronald Cron6f135e12021-12-08 16:57:54 +01001182#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001183 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1184 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1185 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1186 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001187 }
1188
Gilles Peskine449bd832023-01-11 14:50:10 +01001189 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1190 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001191 }
1192#endif
1193
1194#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001195 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1196 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1197 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001198 }
1199#endif
1200
Ronald Cron6f135e12021-12-08 16:57:54 +01001201#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001202 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1203 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1204 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1205 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001206 }
1207
Gilles Peskine449bd832023-01-11 14:50:10 +01001208 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1209 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001210 }
1211#endif
1212
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1214 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001215}
1216
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001217MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001218static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1219{
1220 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 ret = ssl_conf_version_check(ssl);
1222 if (ret != 0) {
1223 return ret;
1224 }
Jerry Yu60835a82021-08-04 10:13:52 +08001225
1226 /* Space for further checks */
1227
Gilles Peskine449bd832023-01-11 14:50:10 +01001228 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001229}
1230
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001231/*
1232 * Setup an SSL context
1233 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001234
Gilles Peskine449bd832023-01-11 14:50:10 +01001235int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1236 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001237{
Janos Follath865b3eb2019-12-16 11:46:15 +00001238 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001239 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1240 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001241
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001242 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001243
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 if ((ret = ssl_conf_check(ssl)) != 0) {
1245 return ret;
1246 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001247 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001248
Paul Bakker62f2dee2012-09-28 07:31:51 +00001249 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001250 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001251 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001252
1253 /* Set to NULL in case of an error condition */
1254 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001255
Darryl Greenb33cc762019-11-28 14:29:44 +00001256#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1257 ssl->in_buf_len = in_buf_len;
1258#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001259 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1260 if (ssl->in_buf == NULL) {
1261 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001262 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001263 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001264 }
1265
Darryl Greenb33cc762019-11-28 14:29:44 +00001266#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1267 ssl->out_buf_len = out_buf_len;
1268#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001269 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1270 if (ssl->out_buf == NULL) {
1271 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001272 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001273 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001274 }
1275
Deomid rojer Ryabkov3dfe75e2025-01-26 10:43:42 +02001276 mbedtls_ssl_reset_in_pointers(ssl);
1277 mbedtls_ssl_reset_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001278
Johan Pascalb62bb512015-12-03 21:56:45 +01001279#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001280 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001281#endif
1282
Gilles Peskine449bd832023-01-11 14:50:10 +01001283 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001284 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001285 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001286
Gilles Peskine449bd832023-01-11 14:50:10 +01001287 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001288
1289error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 mbedtls_free(ssl->in_buf);
1291 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001292
1293 ssl->conf = NULL;
1294
Darryl Greenb33cc762019-11-28 14:29:44 +00001295#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1296 ssl->in_buf_len = 0;
1297 ssl->out_buf_len = 0;
1298#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001299 ssl->in_buf = NULL;
1300 ssl->out_buf = NULL;
1301
1302 ssl->in_hdr = NULL;
1303 ssl->in_ctr = NULL;
1304 ssl->in_len = NULL;
1305 ssl->in_iv = NULL;
1306 ssl->in_msg = NULL;
1307
1308 ssl->out_hdr = NULL;
1309 ssl->out_ctr = NULL;
1310 ssl->out_len = NULL;
1311 ssl->out_iv = NULL;
1312 ssl->out_msg = NULL;
1313
Gilles Peskine449bd832023-01-11 14:50:10 +01001314 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001315}
1316
1317/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001318 * Reset an initialized and used SSL context for re-use while retaining
1319 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001320 *
1321 * If partial is non-zero, keep data in the input buffer and client ID.
1322 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001323 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001324void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1325 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001326{
Darryl Greenb33cc762019-11-28 14:29:44 +00001327#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1328 size_t in_buf_len = ssl->in_buf_len;
1329 size_t out_buf_len = ssl->out_buf_len;
1330#else
1331 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1332 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1333#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001334
Hanno Beckerb0302c42021-08-03 09:39:42 +01001335#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1336 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001337#endif
1338
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001339 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001340 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001341
Deomid rojer Ryabkov3dfe75e2025-01-26 10:43:42 +02001342 mbedtls_ssl_reset_in_pointers(ssl);
1343 mbedtls_ssl_reset_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001344
1345 /* Reset incoming message parsing */
1346 ssl->in_offt = NULL;
1347 ssl->nb_zero = 0;
1348 ssl->in_msgtype = 0;
1349 ssl->in_msglen = 0;
1350 ssl->in_hslen = 0;
Deomid rojer Ryabkovdd14c0a2025-02-13 13:41:51 +03001351 ssl->in_hsfraglen = 0;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001352 ssl->keep_current_message = 0;
1353 ssl->transform_in = NULL;
1354
1355#if defined(MBEDTLS_SSL_PROTO_DTLS)
1356 ssl->next_record_offset = 0;
1357 ssl->in_epoch = 0;
1358#endif
1359
1360 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001361 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001362 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001363 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001364 }
1365
Ronald Cronad8c17b2022-06-10 17:18:09 +02001366 ssl->send_alert = 0;
1367
Hanno Beckerb0302c42021-08-03 09:39:42 +01001368 /* Reset outgoing message writing */
1369 ssl->out_msgtype = 0;
1370 ssl->out_msglen = 0;
1371 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 memset(ssl->out_buf, 0, out_buf_len);
1373 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001374 ssl->transform_out = NULL;
1375
1376#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001377 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001378#endif
1379
XiaokangQian2b01dc32022-01-21 02:53:13 +00001380#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001381 if (ssl->transform) {
1382 mbedtls_ssl_transform_free(ssl->transform);
1383 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001384 ssl->transform = NULL;
1385 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001386#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1387
XiaokangQian2b01dc32022-01-21 02:53:13 +00001388#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001389 mbedtls_ssl_transform_free(ssl->transform_application);
1390 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001391 ssl->transform_application = NULL;
1392
Gilles Peskine449bd832023-01-11 14:50:10 +01001393 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001394#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001395 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1396 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001397 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001398#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001399
Gilles Peskine449bd832023-01-11 14:50:10 +01001400 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1401 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001402 ssl->handshake->transform_handshake = NULL;
1403 }
1404
XiaokangQian2b01dc32022-01-21 02:53:13 +00001405#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001406}
1407
Gilles Peskine449bd832023-01-11 14:50:10 +01001408int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001409{
1410 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1411
Gilles Peskinef670ba52025-03-07 15:09:32 +01001412 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_REQUEST);
Gilles Peskinefd89acc2025-02-24 18:45:49 +01001413 ssl->flags &= MBEDTLS_SSL_CONTEXT_FLAGS_KEEP_AT_SESSION;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001414 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001415
Gilles Peskine449bd832023-01-11 14:50:10 +01001416 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001417
1418 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001419#if defined(MBEDTLS_SSL_RENEGOTIATION)
1420 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001421 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001422
1423 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1425 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001426#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001427 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001428
Hanno Beckerb0302c42021-08-03 09:39:42 +01001429 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001430 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001431 if (ssl->session) {
1432 mbedtls_ssl_session_free(ssl->session);
1433 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001434 ssl->session = NULL;
1435 }
1436
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001437#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001438 ssl->alpn_chosen = NULL;
1439#endif
1440
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001441#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001442 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001443#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001444 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001445#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001446 if (free_cli_id) {
1447 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001448 ssl->cli_id = NULL;
1449 ssl->cli_id_len = 0;
1450 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001451#endif
1452
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 if ((ret = ssl_handshake_init(ssl)) != 0) {
1454 return ret;
1455 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001456
Gilles Peskine449bd832023-01-11 14:50:10 +01001457 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001458}
1459
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001460/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001461 * Reset an initialized and used SSL context for re-use while retaining
1462 * all application-set variables, function pointers and data.
1463 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001464int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001465{
Gilles Peskine449bd832023-01-11 14:50:10 +01001466 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001467}
1468
1469/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001470 * SSL set accessors
1471 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001472void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001473{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001474 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001475}
1476
Gilles Peskine449bd832023-01-11 14:50:10 +01001477void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001478{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001479 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001480}
1481
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001482#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001483void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001484{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001485 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001486}
1487#endif
1488
Gilles Peskine449bd832023-01-11 14:50:10 +01001489void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001490{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001491 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001492}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001493
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001494#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001495
Gilles Peskine449bd832023-01-11 14:50:10 +01001496void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1497 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001498{
1499 ssl->disable_datagram_packing = !allow_packing;
1500}
1501
Gilles Peskine449bd832023-01-11 14:50:10 +01001502void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1503 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001504{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001505 conf->hs_timeout_min = min;
1506 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001507}
1508#endif
1509
Gilles Peskine449bd832023-01-11 14:50:10 +01001510void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001511{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001512 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001513}
1514
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001515#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001516void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1517 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1518 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001519{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001520 conf->f_vrfy = f_vrfy;
1521 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001522}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001523#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001524
Gilles Peskine449bd832023-01-11 14:50:10 +01001525void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1526 void (*f_dbg)(void *, int, const char *, int, const char *),
1527 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001528{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001529 conf->f_dbg = f_dbg;
1530 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001531}
1532
Gilles Peskine449bd832023-01-11 14:50:10 +01001533void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1534 void *p_bio,
1535 mbedtls_ssl_send_t *f_send,
1536 mbedtls_ssl_recv_t *f_recv,
1537 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001538{
1539 ssl->p_bio = p_bio;
1540 ssl->f_send = f_send;
1541 ssl->f_recv = f_recv;
1542 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001543}
1544
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001545#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001546void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001547{
1548 ssl->mtu = mtu;
1549}
1550#endif
1551
Gilles Peskine449bd832023-01-11 14:50:10 +01001552void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001553{
1554 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001555}
1556
Gilles Peskine449bd832023-01-11 14:50:10 +01001557void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1558 void *p_timer,
1559 mbedtls_ssl_set_timer_t *f_set_timer,
1560 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001561{
1562 ssl->p_timer = p_timer;
1563 ssl->f_set_timer = f_set_timer;
1564 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001565
1566 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001567 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001568}
1569
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001570#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001571void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1572 void *p_cache,
1573 mbedtls_ssl_cache_get_t *f_get_cache,
1574 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001575{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001576 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001577 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001578 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001579}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001580#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001581
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001582#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001583int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001584{
Janos Follath865b3eb2019-12-16 11:46:15 +00001585 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001586
Gilles Peskine449bd832023-01-11 14:50:10 +01001587 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001588 session == NULL ||
1589 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001590 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1591 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001592 }
1593
Gilles Peskine449bd832023-01-11 14:50:10 +01001594 if (ssl->handshake->resume == 1) {
1595 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1596 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001597
Jerry Yu21092062022-10-10 21:21:31 +08001598#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001599 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron233fcaa2024-04-04 14:05:21 +02001600#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001601 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001602 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001603
Gilles Peskine449bd832023-01-11 14:50:10 +01001604 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001605 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001606 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1607 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1608 session->ciphersuite));
1609 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001610 }
Ronald Cron233fcaa2024-04-04 14:05:21 +02001611#else
1612 /*
1613 * If session tickets are not enabled, it is not possible to resume a
1614 * TLS 1.3 session, thus do not make any change to the SSL context in
1615 * the first place.
1616 */
1617 return 0;
1618#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001619 }
Jerry Yu21092062022-10-10 21:21:31 +08001620#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001621
Gilles Peskine449bd832023-01-11 14:50:10 +01001622 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1623 session)) != 0) {
1624 return ret;
1625 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001626
Paul Bakker0a597072012-09-25 21:55:46 +00001627 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001628
Gilles Peskine449bd832023-01-11 14:50:10 +01001629 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001630}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001631#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001632
Gilles Peskine449bd832023-01-11 14:50:10 +01001633void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1634 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001635{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001636 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001637}
1638
Ronald Cron6f135e12021-12-08 16:57:54 +01001639#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001640void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1641 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001642{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001643 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001644}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001645
1646#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001647void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1648 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001649{
1650 conf->early_data_enabled = early_data_enabled;
1651}
Jerry Yucc4e0072022-11-22 17:22:22 +08001652
1653#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001654void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001655 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001656{
Jerry Yu39da9852022-12-06 16:58:36 +08001657 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001658}
1659#endif /* MBEDTLS_SSL_SRV_C */
1660
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001661#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001662#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001663
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001664#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001665void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1666 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001667{
1668 conf->cert_profile = profile;
1669}
1670
Gilles Peskine449bd832023-01-11 14:50:10 +01001671static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001672{
1673 mbedtls_ssl_key_cert *cur = key_cert, *next;
1674
Gilles Peskine449bd832023-01-11 14:50:10 +01001675 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001676 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001677 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001678 cur = next;
1679 }
1680}
1681
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001682/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001683MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001684static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1685 mbedtls_x509_crt *cert,
1686 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001687{
niisato8ee24222018-06-25 19:05:48 +09001688 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001689
Gilles Peskine449bd832023-01-11 14:50:10 +01001690 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001691 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001692 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001693 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001694 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001695 }
1696
Gilles Peskine449bd832023-01-11 14:50:10 +01001697 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1698 if (new_cert == NULL) {
1699 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1700 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001701
niisato8ee24222018-06-25 19:05:48 +09001702 new_cert->cert = cert;
1703 new_cert->key = key;
1704 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001705
Glenn Strauss36872db2022-01-22 05:06:31 -05001706 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001707 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001708 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001709 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001710 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001711 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001712 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001713 }
niisato8ee24222018-06-25 19:05:48 +09001714 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001715 }
1716
Gilles Peskine449bd832023-01-11 14:50:10 +01001717 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001718}
1719
Gilles Peskine449bd832023-01-11 14:50:10 +01001720int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001721 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001722 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001723{
Gilles Peskine449bd832023-01-11 14:50:10 +01001724 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001725}
1726
Gilles Peskine449bd832023-01-11 14:50:10 +01001727void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001728 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001730{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001731 conf->ca_chain = ca_chain;
1732 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001733
1734#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1735 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1736 * cannot be used together. */
1737 conf->f_ca_cb = NULL;
1738 conf->p_ca_cb = NULL;
1739#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001740}
Hanno Becker5adaad92019-03-27 16:54:37 +00001741
1742#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001743void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1744 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1745 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001746{
1747 conf->f_ca_cb = f_ca_cb;
1748 conf->p_ca_cb = p_ca_cb;
1749
1750 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1751 * cannot be used together. */
1752 conf->ca_chain = NULL;
1753 conf->ca_crl = NULL;
1754}
1755#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001756#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001757
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001758#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001759const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1760 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001761{
1762 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001763 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001764}
1765
Gilles Peskine449bd832023-01-11 14:50:10 +01001766int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1767 mbedtls_x509_crt *own_cert,
1768 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001769{
Gilles Peskine449bd832023-01-11 14:50:10 +01001770 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1771 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001772}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001773
Gilles Peskine449bd832023-01-11 14:50:10 +01001774void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1775 mbedtls_x509_crt *ca_chain,
1776 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001777{
1778 ssl->handshake->sni_ca_chain = ca_chain;
1779 ssl->handshake->sni_ca_crl = ca_crl;
1780}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001781
Glenn Strauss999ef702022-03-11 01:37:23 -05001782#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001783void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1784 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001785{
1786 ssl->handshake->dn_hints = crt;
1787}
1788#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1789
Gilles Peskine449bd832023-01-11 14:50:10 +01001790void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1791 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001792{
1793 ssl->handshake->sni_authmode = authmode;
1794}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001795#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1796
Hanno Becker8927c832019-04-03 12:52:50 +01001797#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001798void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1799 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1800 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001801{
1802 ssl->f_vrfy = f_vrfy;
1803 ssl->p_vrfy = p_vrfy;
1804}
1805#endif
1806
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001807#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001808
Przemek Stekielfde11282023-03-13 16:06:09 +01001809static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1810static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1811
Valerio Setti016f6822022-12-09 14:17:50 +01001812static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 mbedtls_ssl_context *ssl,
1814 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001815{
1816 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001817 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001818 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001819 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001820 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001821 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001822 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1823 psa_pake_cs_set_primitive(&cipher_suite,
1824 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1825 PSA_ECC_FAMILY_SECP_R1,
1826 256));
1827 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001828
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1830 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001831 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001832 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001833
Gilles Peskine449bd832023-01-11 14:50:10 +01001834 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001835 user = jpake_server_id;
1836 user_len = sizeof(jpake_server_id);
1837 peer = jpake_client_id;
1838 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001839 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001840 user = jpake_client_id;
1841 user_len = sizeof(jpake_client_id);
1842 peer = jpake_server_id;
1843 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001844 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001845
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001846 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1847 if (status != PSA_SUCCESS) {
1848 return status;
1849 }
1850
1851 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001852 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001853 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001854 }
Valerio Setti016f6822022-12-09 14:17:50 +01001855
Gilles Peskine449bd832023-01-11 14:50:10 +01001856 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1857 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001858 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 }
Valerio Setti016f6822022-12-09 14:17:50 +01001860
1861 ssl->handshake->psa_pake_ctx_is_ok = 1;
1862
Gilles Peskine449bd832023-01-11 14:50:10 +01001863 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01001864}
1865
Gilles Peskine449bd832023-01-11 14:50:10 +01001866int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
1867 const unsigned char *pw,
1868 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01001869{
1870 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
1871 psa_status_t status;
1872
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 if (ssl->handshake == NULL || ssl->conf == NULL) {
1874 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001875 }
1876
Gilles Peskine449bd832023-01-11 14:50:10 +01001877 /* Empty password is not valid */
1878 if ((pw == NULL) || (pw_len == 0)) {
1879 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1880 }
1881
1882 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
1883 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
1884 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
1885
1886 status = psa_import_key(&attributes, pw, pw_len,
1887 &ssl->handshake->psa_pake_password);
1888 if (status != PSA_SUCCESS) {
1889 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1890 }
1891
1892 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
1893 ssl->handshake->psa_pake_password);
1894 if (status != PSA_SUCCESS) {
1895 psa_destroy_key(ssl->handshake->psa_pake_password);
1896 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1897 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1898 }
1899
1900 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001901}
Valerio Settia9a97dc2022-11-28 18:26:16 +01001902
Gilles Peskine449bd832023-01-11 14:50:10 +01001903int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
1904 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01001905{
Valerio Settia9a97dc2022-11-28 18:26:16 +01001906 psa_status_t status;
1907
Gilles Peskine449bd832023-01-11 14:50:10 +01001908 if (ssl->handshake == NULL || ssl->conf == NULL) {
1909 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02001910 }
1911
Gilles Peskine449bd832023-01-11 14:50:10 +01001912 if (mbedtls_svc_key_id_is_null(pwd)) {
1913 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
1914 }
1915
1916 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
1917 if (status != PSA_SUCCESS) {
1918 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
1919 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
1920 }
1921
1922 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01001923}
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001924#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001925
Ronald Cron73fe8df2022-10-05 14:31:43 +02001926#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001927int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001928{
Gilles Peskine449bd832023-01-11 14:50:10 +01001929 if (conf->psk_identity == NULL ||
1930 conf->psk_identity_len == 0) {
1931 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02001932 }
1933
Gilles Peskine449bd832023-01-11 14:50:10 +01001934 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
1935 return 1;
1936 }
Ronald Crond29e13e2022-10-19 10:33:48 +02001937
Gilles Peskine449bd832023-01-11 14:50:10 +01001938 if (conf->psk != NULL && conf->psk_len != 0) {
1939 return 1;
1940 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001941
Gilles Peskine449bd832023-01-11 14:50:10 +01001942 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01001943}
1944
Gilles Peskine449bd832023-01-11 14:50:10 +01001945static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001946{
1947 /* Remove reference to existing PSK, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001948 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001949 /* The maintenance of the PSK key slot is the
1950 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02001951 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001952 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001953 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01001954 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001955 conf->psk = NULL;
1956 conf->psk_len = 0;
1957 }
1958
1959 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001960 if (conf->psk_identity != NULL) {
1961 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01001962 conf->psk_identity = NULL;
1963 conf->psk_identity_len = 0;
1964 }
1965}
1966
Hanno Becker7390c712018-11-15 13:33:04 +00001967/* This function assumes that PSK identity in the SSL config is unset.
1968 * It checks that the provided identity is well-formed and attempts
1969 * to make a copy of it in the SSL config.
1970 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001971MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001972static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
1973 unsigned char const *psk_identity,
1974 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001975{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001976 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02001978 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 (psk_identity_len >> 16) != 0 ||
1980 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
1981 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02001982 }
1983
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
1985 if (conf->psk_identity == NULL) {
1986 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1987 }
Paul Bakker6db455e2013-09-18 17:29:31 +02001988
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001989 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001990 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02001991
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02001993}
1994
Gilles Peskine449bd832023-01-11 14:50:10 +01001995int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
1996 const unsigned char *psk, size_t psk_len,
1997 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00001998{
Janos Follath865b3eb2019-12-16 11:46:15 +00001999 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002000
2001 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2003 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2004 }
Hanno Becker7390c712018-11-15 13:33:04 +00002005
2006 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002007 if (psk == NULL) {
2008 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2009 }
2010 if (psk_len == 0) {
2011 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2012 }
2013 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2014 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2015 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002016
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2018 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2019 }
Hanno Becker7390c712018-11-15 13:33:04 +00002020 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002021 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002022
2023 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002024 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2025 if (ret != 0) {
2026 ssl_conf_remove_psk(conf);
2027 }
Hanno Becker7390c712018-11-15 13:33:04 +00002028
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002030}
2031
Gilles Peskine449bd832023-01-11 14:50:10 +01002032static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002033{
Gilles Peskine449bd832023-01-11 14:50:10 +01002034 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002035 /* The maintenance of the external PSK key slot is the
2036 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 if (ssl->handshake->psk_opaque_is_internal) {
2038 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002039 ssl->handshake->psk_opaque_is_internal = 0;
2040 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002041 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002042 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002043}
2044
Gilles Peskine449bd832023-01-11 14:50:10 +01002045int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2046 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002047{
Neil Armstrong501c9322022-05-03 09:35:09 +02002048 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002049 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002050 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002051 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002052
Gilles Peskine449bd832023-01-11 14:50:10 +01002053 if (psk == NULL || ssl->handshake == NULL) {
2054 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2055 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002056
Gilles Peskine449bd832023-01-11 14:50:10 +01002057 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2058 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2059 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002060
Gilles Peskine449bd832023-01-11 14:50:10 +01002061 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002062
Jerry Yuccc68a42022-07-26 16:39:20 +08002063#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002064 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2065 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2066 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2067 } else {
2068 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2069 }
2070 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002071 }
2072#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002073
Jerry Yu568ec252022-07-22 21:27:34 +08002074#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002075 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2076 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2077 psa_set_key_usage_flags(&key_attributes,
2078 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002079 }
2080#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2081
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 psa_set_key_algorithm(&key_attributes, alg);
2083 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002084
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2086 if (status != PSA_SUCCESS) {
2087 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2088 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002089
2090 /* Allow calling psa_destroy_key() on psk remove */
2091 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002092 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002093}
2094
Gilles Peskine449bd832023-01-11 14:50:10 +01002095int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2096 mbedtls_svc_key_id_t psk,
2097 const unsigned char *psk_identity,
2098 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002099{
Janos Follath865b3eb2019-12-16 11:46:15 +00002100 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002101
2102 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2104 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2105 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002106
Hanno Becker7390c712018-11-15 13:33:04 +00002107 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 if (mbedtls_svc_key_id_is_null(psk)) {
2109 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2110 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002111 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002112
2113 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002114 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2115 psk_identity_len);
2116 if (ret != 0) {
2117 ssl_conf_remove_psk(conf);
2118 }
Hanno Becker7390c712018-11-15 13:33:04 +00002119
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002121}
2122
Gilles Peskine449bd832023-01-11 14:50:10 +01002123int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2124 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002125{
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 if ((mbedtls_svc_key_id_is_null(psk)) ||
2127 (ssl->handshake == NULL)) {
2128 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2129 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002130
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002132 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002134}
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002135
Jerry Yu8897c072022-08-12 13:56:53 +08002136#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002137void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2138 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2139 size_t),
2140 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002141{
2142 conf->f_psk = f_psk;
2143 conf->p_psk = p_psk;
2144}
Jerry Yu8897c072022-08-12 13:56:53 +08002145#endif /* MBEDTLS_SSL_SRV_C */
2146
Ronald Cron73fe8df2022-10-05 14:31:43 +02002147#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002148
Gilles Peskine301711e2022-04-26 16:57:05 +02002149static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002151{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002152#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 if (alg == PSA_ALG_CBC_NO_PADDING) {
2154 return MBEDTLS_SSL_MODE_CBC;
2155 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002156#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 if (PSA_ALG_IS_AEAD(alg)) {
2158 return MBEDTLS_SSL_MODE_AEAD;
2159 }
2160 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002161}
2162
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002163
Gilles Peskinee108d982022-04-26 16:50:40 +02002164static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2165 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002167{
2168#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002169 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2170 base_mode == MBEDTLS_SSL_MODE_CBC) {
2171 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002172 }
2173#else
2174 (void) encrypt_then_mac;
2175#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002177}
2178
Neil Armstrongab555e02022-04-04 11:07:59 +02002179mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002180 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002181{
Gilles Peskinee108d982022-04-26 16:50:40 +02002182 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002183 transform->psa_alg
Gilles Peskinee108d982022-04-26 16:50:40 +02002184 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002185
Gilles Peskinee108d982022-04-26 16:50:40 +02002186 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002187#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002188 encrypt_then_mac = transform->encrypt_then_mac;
2189#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002190 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002191}
2192
Neil Armstrongab555e02022-04-04 11:07:59 +02002193mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002194#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002196#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002197 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002198{
Gilles Peskinee108d982022-04-26 16:50:40 +02002199 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2200
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002201 psa_status_t status;
2202 psa_algorithm_t alg;
2203 psa_key_type_t type;
2204 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002205 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2206 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 if (status == PSA_SUCCESS) {
2208 base_mode = mbedtls_ssl_get_base_mode(alg);
2209 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002210
Gilles Peskinee108d982022-04-26 16:50:40 +02002211#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2212 int encrypt_then_mac = 0;
2213#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002215}
2216
Jerry Yu251a12e2022-07-13 15:15:48 +08002217
Ronald Cron8b592d22024-11-12 18:08:25 +01002218const mbedtls_error_pair_t psa_to_ssl_errors[] =
2219{
2220 { PSA_SUCCESS, 0 },
2221 { PSA_ERROR_INSUFFICIENT_MEMORY, MBEDTLS_ERR_SSL_ALLOC_FAILED },
2222 { PSA_ERROR_NOT_SUPPORTED, MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE },
2223 { PSA_ERROR_INVALID_SIGNATURE, MBEDTLS_ERR_SSL_INVALID_MAC },
2224 { PSA_ERROR_INVALID_ARGUMENT, MBEDTLS_ERR_SSL_BAD_INPUT_DATA },
2225 { PSA_ERROR_BAD_STATE, MBEDTLS_ERR_SSL_INTERNAL_ERROR },
2226 { PSA_ERROR_BUFFER_TOO_SMALL, MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL }
2227};
2228
Gilles Peskine449bd832023-01-11 14:50:10 +01002229psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2230 size_t taglen,
2231 psa_algorithm_t *alg,
2232 psa_key_type_t *key_type,
2233 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002234{
Elena Uziunaitec2561722024-07-05 11:37:33 +01002235#if !defined(PSA_WANT_ALG_CCM)
Yanray Wang19e4dc82023-11-16 18:02:05 +08002236 (void) taglen;
2237#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 switch (mbedtls_cipher_type) {
Elena Uziunaite74342c72024-07-05 11:31:29 +01002239#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002240 case MBEDTLS_CIPHER_AES_128_CBC:
2241 *alg = PSA_ALG_CBC_NO_PADDING;
2242 *key_type = PSA_KEY_TYPE_AES;
2243 *key_size = 128;
2244 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002245#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002246#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002247 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002248 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002249 *key_type = PSA_KEY_TYPE_AES;
2250 *key_size = 128;
2251 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002252#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002253#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002254 case MBEDTLS_CIPHER_AES_128_GCM:
2255 *alg = PSA_ALG_GCM;
2256 *key_type = PSA_KEY_TYPE_AES;
2257 *key_size = 128;
2258 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002259#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002260#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002261 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002263 *key_type = PSA_KEY_TYPE_AES;
2264 *key_size = 192;
2265 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002266#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002267#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002268 case MBEDTLS_CIPHER_AES_192_GCM:
2269 *alg = PSA_ALG_GCM;
2270 *key_type = PSA_KEY_TYPE_AES;
2271 *key_size = 192;
2272 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002273#endif
Elena Uziunaite74342c72024-07-05 11:31:29 +01002274#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002275 case MBEDTLS_CIPHER_AES_256_CBC:
2276 *alg = PSA_ALG_CBC_NO_PADDING;
2277 *key_type = PSA_KEY_TYPE_AES;
2278 *key_size = 256;
2279 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002280#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002281#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002282 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002283 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002284 *key_type = PSA_KEY_TYPE_AES;
2285 *key_size = 256;
2286 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002287#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002288#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002289 case MBEDTLS_CIPHER_AES_256_GCM:
2290 *alg = PSA_ALG_GCM;
2291 *key_type = PSA_KEY_TYPE_AES;
2292 *key_size = 256;
2293 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002294#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002295#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002296 case MBEDTLS_CIPHER_ARIA_128_CBC:
2297 *alg = PSA_ALG_CBC_NO_PADDING;
2298 *key_type = PSA_KEY_TYPE_ARIA;
2299 *key_size = 128;
2300 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002301#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002302#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002303 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002304 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002305 *key_type = PSA_KEY_TYPE_ARIA;
2306 *key_size = 128;
2307 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002308#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002309#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002310 case MBEDTLS_CIPHER_ARIA_128_GCM:
2311 *alg = PSA_ALG_GCM;
2312 *key_type = PSA_KEY_TYPE_ARIA;
2313 *key_size = 128;
2314 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002315#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002316#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002317 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002318 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002319 *key_type = PSA_KEY_TYPE_ARIA;
2320 *key_size = 192;
2321 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002322#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002323#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002324 case MBEDTLS_CIPHER_ARIA_192_GCM:
2325 *alg = PSA_ALG_GCM;
2326 *key_type = PSA_KEY_TYPE_ARIA;
2327 *key_size = 192;
2328 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002329#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002330#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002331 case MBEDTLS_CIPHER_ARIA_256_CBC:
2332 *alg = PSA_ALG_CBC_NO_PADDING;
2333 *key_type = PSA_KEY_TYPE_ARIA;
2334 *key_size = 256;
2335 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002336#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002337#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002338 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002339 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002340 *key_type = PSA_KEY_TYPE_ARIA;
2341 *key_size = 256;
2342 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002343#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002344#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002345 case MBEDTLS_CIPHER_ARIA_256_GCM:
2346 *alg = PSA_ALG_GCM;
2347 *key_type = PSA_KEY_TYPE_ARIA;
2348 *key_size = 256;
2349 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002350#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002351#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002352 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2353 *alg = PSA_ALG_CBC_NO_PADDING;
2354 *key_type = PSA_KEY_TYPE_CAMELLIA;
2355 *key_size = 128;
2356 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002357#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002358#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002359 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002361 *key_type = PSA_KEY_TYPE_CAMELLIA;
2362 *key_size = 128;
2363 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002364#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002365#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002366 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2367 *alg = PSA_ALG_GCM;
2368 *key_type = PSA_KEY_TYPE_CAMELLIA;
2369 *key_size = 128;
2370 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002371#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002372#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002373 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002375 *key_type = PSA_KEY_TYPE_CAMELLIA;
2376 *key_size = 192;
2377 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002378#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002379#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002380 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2381 *alg = PSA_ALG_GCM;
2382 *key_type = PSA_KEY_TYPE_CAMELLIA;
2383 *key_size = 192;
2384 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002385#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002386#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002387 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2388 *alg = PSA_ALG_CBC_NO_PADDING;
2389 *key_type = PSA_KEY_TYPE_CAMELLIA;
2390 *key_size = 256;
2391 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002392#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002393#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002394 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002395 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002396 *key_type = PSA_KEY_TYPE_CAMELLIA;
2397 *key_size = 256;
2398 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002399#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002400#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002401 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2402 *alg = PSA_ALG_GCM;
2403 *key_type = PSA_KEY_TYPE_CAMELLIA;
2404 *key_size = 256;
2405 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002406#endif
Elena Uziunaite5c70c302024-07-05 11:44:44 +01002407#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002408 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2409 *alg = PSA_ALG_CHACHA20_POLY1305;
2410 *key_type = PSA_KEY_TYPE_CHACHA20;
2411 *key_size = 256;
2412 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002413#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002414 case MBEDTLS_CIPHER_NULL:
2415 *alg = MBEDTLS_SSL_NULL_CIPHER;
2416 *key_type = 0;
2417 *key_size = 0;
2418 break;
2419 default:
2420 return PSA_ERROR_NOT_SUPPORTED;
2421 }
2422
2423 return PSA_SUCCESS;
2424}
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002425
Ronald Crone68ab4f2022-10-05 12:46:29 +02002426#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002427#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002428/*
2429 * Set allowed/preferred hashes for handshake signatures
2430 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002431void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2432 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002433{
2434 conf->sig_hashes = hashes;
2435}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002436#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002437
Jerry Yuf017ee42022-01-12 15:49:48 +08002438/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002439void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2440 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002441{
Jerry Yuf017ee42022-01-12 15:49:48 +08002442#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2443 conf->sig_hashes = NULL;
2444#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2445 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002446}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002447#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002448
Brett Warrene0edc842021-08-17 09:53:13 +01002449/*
2450 * Set the allowed groups
2451 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002452void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2453 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002454{
Brett Warrene0edc842021-08-17 09:53:13 +01002455 conf->group_list = group_list;
2456}
2457
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002458#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine4ac40082025-02-20 18:13:58 +01002459
2460#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
2461/** Whether mbedtls_ssl_set_hostname() has been called.
2462 *
2463 * \param[in] ssl SSL context
2464 *
2465 * \return \c 1 if mbedtls_ssl_set_hostname() has been called on \p ssl
2466 * (including `mbedtls_ssl_set_hostname(ssl, NULL)`),
2467 * otherwise \c 0.
2468 */
2469static int mbedtls_ssl_has_set_hostname_been_called(
2470 const mbedtls_ssl_context *ssl)
2471{
Gilles Peskine434016e2025-02-20 18:49:59 +01002472 return (ssl->flags & MBEDTLS_SSL_CONTEXT_FLAG_HOSTNAME_SET) != 0;
Gilles Peskine4ac40082025-02-20 18:13:58 +01002473}
2474#endif
2475
2476static void mbedtls_ssl_free_hostname(mbedtls_ssl_context *ssl)
2477{
2478 if (ssl->hostname != NULL) {
2479 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
2480 }
2481 ssl->hostname = NULL;
2482}
2483
Gilles Peskine449bd832023-01-11 14:50:10 +01002484int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002485{
Hanno Becker947194e2017-04-07 13:25:49 +01002486 /* Initialize to suppress unnecessary compiler warning */
2487 size_t hostname_len = 0;
2488
2489 /* Check if new hostname is valid before
2490 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002491 if (hostname != NULL) {
2492 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002493
Gilles Peskine449bd832023-01-11 14:50:10 +01002494 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2495 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2496 }
Hanno Becker947194e2017-04-07 13:25:49 +01002497 }
2498
2499 /* Now it's clear that we will overwrite the old hostname,
2500 * so we can free it safely */
Gilles Peskine4ac40082025-02-20 18:13:58 +01002501 mbedtls_ssl_free_hostname(ssl);
Hanno Becker947194e2017-04-07 13:25:49 +01002502
2503 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002504
Gilles Peskine449bd832023-01-11 14:50:10 +01002505 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002506 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002507 } else {
2508 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2509 if (ssl->hostname == NULL) {
2510 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2511 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002512
Gilles Peskine449bd832023-01-11 14:50:10 +01002513 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002514
Hanno Becker947194e2017-04-07 13:25:49 +01002515 ssl->hostname[hostname_len] = '\0';
2516 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002517
Gilles Peskine434016e2025-02-20 18:49:59 +01002518 ssl->flags |= MBEDTLS_SSL_CONTEXT_FLAG_HOSTNAME_SET;
2519
Gilles Peskine449bd832023-01-11 14:50:10 +01002520 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002521}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002522#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002523
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002524#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002525void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2526 int (*f_sni)(void *, mbedtls_ssl_context *,
2527 const unsigned char *, size_t),
2528 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002529{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002530 conf->f_sni = f_sni;
2531 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002532}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002533#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002534
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002535#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002536int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002537{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002538 size_t cur_len, tot_len;
2539 const char **p;
2540
2541 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002542 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2543 * MUST NOT be truncated."
2544 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002545 */
2546 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002547 for (p = protos; *p != NULL; p++) {
2548 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002549 tot_len += cur_len;
2550
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 if ((cur_len == 0) ||
2552 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2553 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2554 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2555 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002556 }
2557
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002558 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002559
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002561}
2562
Gilles Peskine449bd832023-01-11 14:50:10 +01002563const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002564{
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002566}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002567#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002568
Johan Pascalb62bb512015-12-03 21:56:45 +01002569#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002570void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2571 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002572{
2573 conf->dtls_srtp_mki_support = support_mki_value;
2574}
2575
Gilles Peskine449bd832023-01-11 14:50:10 +01002576int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2577 unsigned char *mki_value,
2578 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002579{
Gilles Peskine449bd832023-01-11 14:50:10 +01002580 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2581 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002582 }
Ron Eldor591f1622018-01-22 12:30:04 +02002583
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2585 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002586 }
Ron Eldor591f1622018-01-22 12:30:04 +02002587
Gilles Peskine449bd832023-01-11 14:50:10 +01002588 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002589 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002590 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002591}
2592
Gilles Peskine449bd832023-01-11 14:50:10 +01002593int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2594 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002595{
Johan Pascal253d0262020-09-22 13:04:45 +02002596 const mbedtls_ssl_srtp_profile *p;
2597 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002598
Johan Pascal253d0262020-09-22 13:04:45 +02002599 /* check the profiles list: all entry must be valid,
2600 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2602 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2603 p++) {
2604 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002605 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002606 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002607 /* unsupported value, stop parsing and set the size to an error value */
2608 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002609 }
2610 }
2611
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2613 conf->dtls_srtp_profile_list = NULL;
2614 conf->dtls_srtp_profile_list_len = 0;
2615 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002616 }
2617
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002618 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002619 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002620
Gilles Peskine449bd832023-01-11 14:50:10 +01002621 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002622}
2623
Gilles Peskine449bd832023-01-11 14:50:10 +01002624void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2625 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002626{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002627 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2628 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002629 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002630 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002631 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002632 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002633 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2634 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002635 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002636}
Johan Pascalb62bb512015-12-03 21:56:45 +01002637#endif /* MBEDTLS_SSL_DTLS_SRTP */
2638
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302639#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002640void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002641{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002642 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002643}
2644
Gilles Peskine449bd832023-01-11 14:50:10 +01002645void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002646{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002647 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002648}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302649#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002650
Janos Follath088ce432017-04-10 12:42:31 +01002651#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002652void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2653 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002654{
2655 conf->cert_req_ca_list = cert_req_ca_list;
2656}
2657#endif
2658
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002659#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002660void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002661{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002662 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002663}
2664#endif
2665
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002666#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002667void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002668{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002669 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002670}
2671#endif
2672
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002673#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002674int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002675{
Gilles Peskine449bd832023-01-11 14:50:10 +01002676 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2677 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2678 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002679 }
2680
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002681 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002682
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002684}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002685#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002686
Gilles Peskine449bd832023-01-11 14:50:10 +01002687void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002688{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002689 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002690}
2691
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002692#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002693void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002694{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002695 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002696}
2697
Gilles Peskine449bd832023-01-11 14:50:10 +01002698void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002699{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002700 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002701}
2702
Gilles Peskine449bd832023-01-11 14:50:10 +01002703void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2704 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002705{
Gilles Peskine449bd832023-01-11 14:50:10 +01002706 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002707}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002708#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002709
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002710#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002711#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002712void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002713{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002714 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002715}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002716#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002717
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002718#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002719
Jerry Yud0766ec2022-09-22 10:46:57 +08002720#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002721void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2722 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002723{
Jerry Yud0766ec2022-09-22 10:46:57 +08002724 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002725}
2726#endif
2727
Gilles Peskine449bd832023-01-11 14:50:10 +01002728void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2729 mbedtls_ssl_ticket_write_t *f_ticket_write,
2730 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2731 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02002732{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002733 conf->f_ticket_write = f_ticket_write;
2734 conf->f_ticket_parse = f_ticket_parse;
2735 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02002736}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002737#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002738#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002739
Gilles Peskine449bd832023-01-11 14:50:10 +01002740void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
2741 mbedtls_ssl_export_keys_t *f_export_keys,
2742 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002743{
Hanno Becker7e6c1782021-06-08 09:24:55 +01002744 ssl->f_export_keys = f_export_keys;
2745 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002746}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002747
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002748#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002749void mbedtls_ssl_conf_async_private_cb(
2750 mbedtls_ssl_config *conf,
2751 mbedtls_ssl_async_sign_t *f_async_sign,
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002752 mbedtls_ssl_async_resume_t *f_async_resume,
2753 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01002754 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002755{
2756 conf->f_async_sign_start = f_async_sign;
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002757 conf->f_async_resume = f_async_resume;
2758 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002759 conf->p_async_config_data = async_config_data;
2760}
2761
Gilles Peskine449bd832023-01-11 14:50:10 +01002762void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02002763{
Gilles Peskine449bd832023-01-11 14:50:10 +01002764 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02002765}
2766
Gilles Peskine449bd832023-01-11 14:50:10 +01002767void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002768{
Gilles Peskine449bd832023-01-11 14:50:10 +01002769 if (ssl->handshake == NULL) {
2770 return NULL;
2771 } else {
2772 return ssl->handshake->user_async_ctx;
2773 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002774}
2775
Gilles Peskine449bd832023-01-11 14:50:10 +01002776void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2777 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002778{
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002780 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01002781 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002782}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002783#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002784
Paul Bakker5121ce52009-01-03 21:22:43 +00002785/*
2786 * SSL get accessors
2787 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002788uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00002789{
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 if (ssl->session != NULL) {
2791 return ssl->session->verify_result;
2792 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002793
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 if (ssl->session_negotiate != NULL) {
2795 return ssl->session_negotiate->verify_result;
2796 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002797
Gilles Peskine449bd832023-01-11 14:50:10 +01002798 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00002799}
2800
Gilles Peskine449bd832023-01-11 14:50:10 +01002801int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05002802{
Gilles Peskine449bd832023-01-11 14:50:10 +01002803 if (ssl == NULL || ssl->session == NULL) {
2804 return 0;
2805 }
Glenn Strauss8f526902022-01-13 00:04:49 -05002806
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05002808}
2809
Gilles Peskine449bd832023-01-11 14:50:10 +01002810const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00002811{
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 if (ssl == NULL || ssl->session == NULL) {
2813 return NULL;
2814 }
Paul Bakker926c8e42013-03-06 10:23:34 +01002815
Gilles Peskine449bd832023-01-11 14:50:10 +01002816 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00002817}
2818
Gilles Peskine449bd832023-01-11 14:50:10 +01002819const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00002820{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002821#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002822 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
2823 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002824 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002825 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002826 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002828 }
2829 }
2830#endif
2831
Gilles Peskine449bd832023-01-11 14:50:10 +01002832 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04002833 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01002834 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04002835 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01002836 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002837 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00002839 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00002840}
2841
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002842#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2843
2844size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
2845{
2846 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2847 size_t record_size_limit = max_len;
2848
2849 if (ssl->session != NULL &&
2850 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2851 ssl->session->record_size_limit < max_len) {
2852 record_size_limit = ssl->session->record_size_limit;
2853 }
2854
2855 // TODO: this is currently untested
2856 /* During a handshake, use the value being negotiated */
2857 if (ssl->session_negotiate != NULL &&
2858 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
2859 ssl->session_negotiate->record_size_limit < max_len) {
2860 record_size_limit = ssl->session_negotiate->record_size_limit;
2861 }
2862
2863 return record_size_limit;
2864}
2865#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2866
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002867#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002868size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002869{
David Horstmann95d516f2021-05-04 18:36:56 +01002870 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002871 size_t read_mfl;
2872
Jerry Yuddda0502022-12-01 19:43:12 +08002873#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002874 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2876 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
2877 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002878 }
Jerry Yuddda0502022-12-01 19:43:12 +08002879#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002880
2881 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002882 if (ssl->session_out != NULL) {
2883 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
2884 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002885 max_len = read_mfl;
2886 }
2887 }
2888
Jerry Yuddda0502022-12-01 19:43:12 +08002889 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002890 if (ssl->session_negotiate != NULL) {
2891 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
2892 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002893 max_len = read_mfl;
2894 }
2895 }
2896
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04002898}
2899
Gilles Peskine449bd832023-01-11 14:50:10 +01002900size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002901{
2902 size_t max_len;
2903
2904 /*
2905 * Assume mfl_code is correct since it was checked when set
2906 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002907 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002908
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002909 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002910 if (ssl->session_out != NULL &&
2911 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
2912 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002913 }
2914
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002915 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01002916 if (ssl->session_negotiate != NULL &&
2917 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
2918 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02002919 }
2920
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002922}
2923#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2924
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002925#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002926size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002927{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002928 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002929 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
2930 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
2931 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
2932 return 0;
2933 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04002934
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
2936 return ssl->mtu;
2937 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002938
Gilles Peskine449bd832023-01-11 14:50:10 +01002939 if (ssl->mtu == 0) {
2940 return ssl->handshake->mtu;
2941 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002942
Gilles Peskine449bd832023-01-11 14:50:10 +01002943 return ssl->mtu < ssl->handshake->mtu ?
2944 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02002945}
2946#endif /* MBEDTLS_SSL_PROTO_DTLS */
2947
Gilles Peskine449bd832023-01-11 14:50:10 +01002948int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002949{
2950 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
2951
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002952#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002953 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02002954 !defined(MBEDTLS_SSL_PROTO_DTLS)
2955 (void) ssl;
2956#endif
2957
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002958#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002959 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002960
Gilles Peskine449bd832023-01-11 14:50:10 +01002961 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002962 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01002963 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002964#endif
2965
Jan Brucknerf482dcc2023-03-15 09:09:06 +01002966#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
2967 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
2968
2969 if (max_len > record_size_limit) {
2970 max_len = record_size_limit;
2971 }
2972#endif
2973
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002974 if (ssl->transform_out != NULL &&
2975 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00002976 /*
2977 * In TLS 1.3 case, when records are protected, `max_len` as computed
2978 * above is the maximum length of the TLSInnerPlaintext structure that
2979 * along the plaintext payload contains the inner content type (one byte)
2980 * and some zero padding. Given the algorithm used for padding
2981 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
2982 * the plaintext payload. Round down to a multiple of
2983 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
2984 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00002985 */
2986 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
2987 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
2988 }
2989
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002990#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002991 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
2992 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
2993 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002994 const size_t overhead = (size_t) ret;
2995
Gilles Peskine449bd832023-01-11 14:50:10 +01002996 if (ret < 0) {
2997 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002998 }
2999
Gilles Peskine449bd832023-01-11 14:50:10 +01003000 if (mtu <= overhead) {
3001 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3002 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3003 }
3004
3005 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003006 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003007 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003008 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003009#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003010
Hanno Becker0defedb2018-08-10 12:35:02 +01003011#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003012 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3013 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003014 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003015#endif
3016
Gilles Peskine449bd832023-01-11 14:50:10 +01003017 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003018}
3019
Gilles Peskine449bd832023-01-11 14:50:10 +01003020int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003021{
3022 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3023
3024#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3025 (void) ssl;
3026#endif
3027
3028#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003029 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003030
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003032 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003033 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003034#endif
3035
Gilles Peskine449bd832023-01-11 14:50:10 +01003036 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003037}
3038
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003039#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003040const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003041{
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 if (ssl == NULL || ssl->session == NULL) {
3043 return NULL;
3044 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003045
Hanno Beckere6824572019-02-07 13:18:46 +00003046#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003047 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003048#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003049 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003050#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003051}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003052#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003053
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003054#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003055int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3056 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003057{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003058 int ret;
3059
Gilles Peskine449bd832023-01-11 14:50:10 +01003060 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003061 dst == NULL ||
3062 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003063 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3064 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003065 }
3066
Hanno Beckere810bbc2021-05-14 16:01:05 +01003067 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3068 * idempotent: Each session can only be exported once.
3069 *
3070 * (This is in preparation for TLS 1.3 support where we will
3071 * need the ability to export multiple sessions (aka tickets),
3072 * which will be achieved by calling mbedtls_ssl_get_session()
3073 * multiple times until it fails.)
3074 *
3075 * Check whether we have already exported the current session,
3076 * and fail if so.
3077 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003078 if (ssl->session->exported == 1) {
3079 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3080 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003081
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3083 if (ret != 0) {
3084 return ret;
3085 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003086
3087 /* Remember that we've exported the session. */
3088 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003089 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003090}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003091#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003092
David Horstmanncb01b362024-02-29 17:31:46 +00003093#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3094
3095/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003096 *
David Horstmanncb01b362024-02-29 17:31:46 +00003097 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003098 */
3099static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3100 unsigned char *buf,
3101 size_t buf_len)
3102{
3103 unsigned char *p = buf;
3104 size_t used = 0;
3105
3106#if defined(MBEDTLS_HAVE_TIME)
3107 uint64_t start;
3108#endif
3109#if defined(MBEDTLS_X509_CRT_PARSE_C)
3110#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3111 size_t cert_len;
3112#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3113#endif /* MBEDTLS_X509_CRT_PARSE_C */
3114
3115 /*
3116 * Time
3117 */
3118#if defined(MBEDTLS_HAVE_TIME)
3119 used += 8;
3120
3121 if (used <= buf_len) {
3122 start = (uint64_t) session->start;
3123
3124 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3125 p += 8;
3126 }
3127#endif /* MBEDTLS_HAVE_TIME */
3128
3129 /*
3130 * Basic mandatory fields
3131 */
3132 used += 1 /* id_len */
3133 + sizeof(session->id)
3134 + sizeof(session->master)
3135 + 4; /* verify_result */
3136
3137 if (used <= buf_len) {
3138 *p++ = MBEDTLS_BYTE_0(session->id_len);
3139 memcpy(p, session->id, 32);
3140 p += 32;
3141
3142 memcpy(p, session->master, 48);
3143 p += 48;
3144
3145 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3146 p += 4;
3147 }
3148
3149 /*
3150 * Peer's end-entity certificate
3151 */
3152#if defined(MBEDTLS_X509_CRT_PARSE_C)
3153#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3154 if (session->peer_cert == NULL) {
3155 cert_len = 0;
3156 } else {
3157 cert_len = session->peer_cert->raw.len;
3158 }
3159
3160 used += 3 + cert_len;
3161
3162 if (used <= buf_len) {
3163 *p++ = MBEDTLS_BYTE_2(cert_len);
3164 *p++ = MBEDTLS_BYTE_1(cert_len);
3165 *p++ = MBEDTLS_BYTE_0(cert_len);
3166
3167 if (session->peer_cert != NULL) {
3168 memcpy(p, session->peer_cert->raw.p, cert_len);
3169 p += cert_len;
3170 }
3171 }
3172#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3173 if (session->peer_cert_digest != NULL) {
3174 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3175 if (used <= buf_len) {
3176 *p++ = (unsigned char) session->peer_cert_digest_type;
3177 *p++ = (unsigned char) session->peer_cert_digest_len;
3178 memcpy(p, session->peer_cert_digest,
3179 session->peer_cert_digest_len);
3180 p += session->peer_cert_digest_len;
3181 }
3182 } else {
3183 used += 2;
3184 if (used <= buf_len) {
3185 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3186 *p++ = 0;
3187 }
3188 }
3189#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3190#endif /* MBEDTLS_X509_CRT_PARSE_C */
3191
3192 /*
3193 * Session ticket if any, plus associated data
3194 */
3195#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3196#if defined(MBEDTLS_SSL_CLI_C)
3197 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3198 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3199
3200 if (used <= buf_len) {
3201 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3202 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3203 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3204
3205 if (session->ticket != NULL) {
3206 memcpy(p, session->ticket, session->ticket_len);
3207 p += session->ticket_len;
3208 }
3209
3210 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3211 p += 4;
3212 }
3213 }
3214#endif /* MBEDTLS_SSL_CLI_C */
3215#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3216 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3217 used += 8;
3218
3219 if (used <= buf_len) {
3220 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3221 p += 8;
3222 }
3223 }
3224#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3225#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3226
3227 /*
3228 * Misc extension-related info
3229 */
3230#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3231 used += 1;
3232
3233 if (used <= buf_len) {
3234 *p++ = session->mfl_code;
3235 }
3236#endif
3237
3238#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3239 used += 1;
3240
3241 if (used <= buf_len) {
3242 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3243 }
3244#endif
3245
3246 return used;
3247}
3248
3249MBEDTLS_CHECK_RETURN_CRITICAL
3250static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3251 const unsigned char *buf,
3252 size_t len)
3253{
3254#if defined(MBEDTLS_HAVE_TIME)
3255 uint64_t start;
3256#endif
3257#if defined(MBEDTLS_X509_CRT_PARSE_C)
3258#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3259 size_t cert_len;
3260#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3261#endif /* MBEDTLS_X509_CRT_PARSE_C */
3262
3263 const unsigned char *p = buf;
3264 const unsigned char * const end = buf + len;
3265
3266 /*
3267 * Time
3268 */
3269#if defined(MBEDTLS_HAVE_TIME)
3270 if (8 > (size_t) (end - p)) {
3271 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3272 }
3273
3274 start = MBEDTLS_GET_UINT64_BE(p, 0);
3275 p += 8;
3276
3277 session->start = (time_t) start;
3278#endif /* MBEDTLS_HAVE_TIME */
3279
3280 /*
3281 * Basic mandatory fields
3282 */
3283 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3284 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3285 }
3286
3287 session->id_len = *p++;
3288 memcpy(session->id, p, 32);
3289 p += 32;
3290
3291 memcpy(session->master, p, 48);
3292 p += 48;
3293
3294 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3295 p += 4;
3296
3297 /* Immediately clear invalid pointer values that have been read, in case
3298 * we exit early before we replaced them with valid ones. */
3299#if defined(MBEDTLS_X509_CRT_PARSE_C)
3300#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3301 session->peer_cert = NULL;
3302#else
3303 session->peer_cert_digest = NULL;
3304#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3305#endif /* MBEDTLS_X509_CRT_PARSE_C */
3306#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3307 session->ticket = NULL;
3308#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3309
3310 /*
3311 * Peer certificate
3312 */
3313#if defined(MBEDTLS_X509_CRT_PARSE_C)
3314#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3315 /* Deserialize CRT from the end of the ticket. */
3316 if (3 > (size_t) (end - p)) {
3317 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3318 }
3319
3320 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3321 p += 3;
3322
3323 if (cert_len != 0) {
3324 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3325
3326 if (cert_len > (size_t) (end - p)) {
3327 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3328 }
3329
3330 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3331
3332 if (session->peer_cert == NULL) {
3333 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3334 }
3335
3336 mbedtls_x509_crt_init(session->peer_cert);
3337
3338 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3339 p, cert_len)) != 0) {
3340 mbedtls_x509_crt_free(session->peer_cert);
3341 mbedtls_free(session->peer_cert);
3342 session->peer_cert = NULL;
3343 return ret;
3344 }
3345
3346 p += cert_len;
3347 }
3348#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3349 /* Deserialize CRT digest from the end of the ticket. */
3350 if (2 > (size_t) (end - p)) {
3351 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3352 }
3353
3354 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3355 session->peer_cert_digest_len = (size_t) *p++;
3356
3357 if (session->peer_cert_digest_len != 0) {
3358 const mbedtls_md_info_t *md_info =
3359 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3360 if (md_info == NULL) {
3361 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3362 }
3363 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3364 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3365 }
3366
3367 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3368 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3369 }
3370
3371 session->peer_cert_digest =
3372 mbedtls_calloc(1, session->peer_cert_digest_len);
3373 if (session->peer_cert_digest == NULL) {
3374 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3375 }
3376
3377 memcpy(session->peer_cert_digest, p,
3378 session->peer_cert_digest_len);
3379 p += session->peer_cert_digest_len;
3380 }
3381#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3382#endif /* MBEDTLS_X509_CRT_PARSE_C */
3383
3384 /*
3385 * Session ticket and associated data
3386 */
3387#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3388#if defined(MBEDTLS_SSL_CLI_C)
3389 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3390 if (3 > (size_t) (end - p)) {
3391 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3392 }
3393
3394 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3395 p += 3;
3396
3397 if (session->ticket_len != 0) {
3398 if (session->ticket_len > (size_t) (end - p)) {
3399 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3400 }
3401
3402 session->ticket = mbedtls_calloc(1, session->ticket_len);
3403 if (session->ticket == NULL) {
3404 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3405 }
3406
3407 memcpy(session->ticket, p, session->ticket_len);
3408 p += session->ticket_len;
3409 }
3410
3411 if (4 > (size_t) (end - p)) {
3412 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3413 }
3414
3415 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3416 p += 4;
3417 }
3418#endif /* MBEDTLS_SSL_CLI_C */
3419#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3420 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3421 if (8 > (size_t) (end - p)) {
3422 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3423 }
3424 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3425 p += 8;
3426 }
3427#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3428#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3429
3430 /*
3431 * Misc extension-related info
3432 */
3433#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3434 if (1 > (size_t) (end - p)) {
3435 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3436 }
3437
3438 session->mfl_code = *p++;
3439#endif
3440
3441#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3442 if (1 > (size_t) (end - p)) {
3443 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3444 }
3445
3446 session->encrypt_then_mac = *p++;
3447#endif
3448
3449 /* Done, should have consumed entire buffer */
3450 if (p != end) {
3451 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3452 }
3453
3454 return 0;
3455}
3456
3457#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3458
3459#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3460/* Serialization of TLS 1.3 sessions:
3461 *
David Horstmanncb01b362024-02-29 17:31:46 +00003462 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003463 */
3464#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3465MBEDTLS_CHECK_RETURN_CRITICAL
3466static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3467 unsigned char *buf,
3468 size_t buf_len,
3469 size_t *olen)
3470{
3471 unsigned char *p = buf;
3472#if defined(MBEDTLS_SSL_CLI_C) && \
3473 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3474 size_t hostname_len = (session->hostname == NULL) ?
3475 0 : strlen(session->hostname) + 1;
3476#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003477
3478#if defined(MBEDTLS_SSL_SRV_C) && \
3479 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003480 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003481 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003482#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003483 size_t needed = 4 /* ticket_age_add */
3484 + 1 /* ticket_flags */
3485 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003486
David Horstmanne59f9702024-02-29 16:08:57 +00003487 *olen = 0;
3488
3489 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3490 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3491 }
3492 needed += session->resumption_key_len; /* resumption_key */
3493
3494#if defined(MBEDTLS_SSL_EARLY_DATA)
3495 needed += 4; /* max_early_data_size */
3496#endif
3497#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3498 needed += 2; /* record_size_limit */
3499#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3500
3501#if defined(MBEDTLS_HAVE_TIME)
3502 needed += 8; /* ticket_creation_time or ticket_reception_time */
3503#endif
3504
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003505#if defined(MBEDTLS_SSL_SRV_C)
3506 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3507#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003508 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003509 + alpn_len; /* alpn */
3510#endif
3511 }
3512#endif /* MBEDTLS_SSL_SRV_C */
3513
David Horstmanne59f9702024-02-29 16:08:57 +00003514#if defined(MBEDTLS_SSL_CLI_C)
3515 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3516#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3517 needed += 2 /* hostname_len */
3518 + hostname_len; /* hostname */
3519#endif
3520
3521 needed += 4 /* ticket_lifetime */
3522 + 2; /* ticket_len */
3523
3524 /* Check size_t overflow */
3525 if (session->ticket_len > SIZE_MAX - needed) {
3526 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3527 }
3528
3529 needed += session->ticket_len; /* ticket */
3530 }
3531#endif /* MBEDTLS_SSL_CLI_C */
3532
3533 *olen = needed;
3534 if (needed > buf_len) {
3535 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3536 }
3537
3538 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3539 p[4] = session->ticket_flags;
3540
3541 /* save resumption_key */
3542 p[5] = session->resumption_key_len;
3543 p += 6;
3544 memcpy(p, session->resumption_key, session->resumption_key_len);
3545 p += session->resumption_key_len;
3546
3547#if defined(MBEDTLS_SSL_EARLY_DATA)
3548 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3549 p += 4;
3550#endif
3551#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3552 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3553 p += 2;
3554#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3555
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003556#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003557 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003558#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003559 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3560 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003561#endif /* MBEDTLS_HAVE_TIME */
3562
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003563#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003564 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3565 p += 2;
3566
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003567 if (alpn_len > 0) {
3568 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003569 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003570 p += alpn_len;
3571 }
3572#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3573 }
3574#endif /* MBEDTLS_SSL_SRV_C */
3575
David Horstmanne59f9702024-02-29 16:08:57 +00003576#if defined(MBEDTLS_SSL_CLI_C)
3577 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3578#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3579 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3580 p += 2;
3581 if (hostname_len > 0) {
3582 /* save host name */
3583 memcpy(p, session->hostname, hostname_len);
3584 p += hostname_len;
3585 }
3586#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3587
3588#if defined(MBEDTLS_HAVE_TIME)
3589 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3590 p += 8;
3591#endif
3592 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3593 p += 4;
3594
3595 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3596 p += 2;
3597
3598 if (session->ticket != NULL && session->ticket_len > 0) {
3599 memcpy(p, session->ticket, session->ticket_len);
3600 p += session->ticket_len;
3601 }
3602 }
3603#endif /* MBEDTLS_SSL_CLI_C */
3604 return 0;
3605}
3606
3607MBEDTLS_CHECK_RETURN_CRITICAL
3608static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3609 const unsigned char *buf,
3610 size_t len)
3611{
3612 const unsigned char *p = buf;
3613 const unsigned char *end = buf + len;
3614
3615 if (end - p < 6) {
3616 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3617 }
3618 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3619 session->ticket_flags = p[4];
3620
3621 /* load resumption_key */
3622 session->resumption_key_len = p[5];
3623 p += 6;
3624
3625 if (end - p < session->resumption_key_len) {
3626 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3627 }
3628
3629 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3630 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3631 }
3632 memcpy(session->resumption_key, p, session->resumption_key_len);
3633 p += session->resumption_key_len;
3634
3635#if defined(MBEDTLS_SSL_EARLY_DATA)
3636 if (end - p < 4) {
3637 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3638 }
3639 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3640 p += 4;
3641#endif
3642#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3643 if (end - p < 2) {
3644 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3645 }
3646 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3647 p += 2;
3648#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3649
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003650#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003651 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003652#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003653 if (end - p < 8) {
3654 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3655 }
3656 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3657 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003658#endif /* MBEDTLS_HAVE_TIME */
3659
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003660#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003661 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003662
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003663 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003664 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3665 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003666
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003667 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3668 p += 2;
3669
3670 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003671 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3672 }
3673
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003674 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003675 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3676 if (ret != 0) {
3677 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003678 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003679 p += alpn_len;
3680 }
3681#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3682 }
3683#endif /* MBEDTLS_SSL_SRV_C */
3684
David Horstmanne59f9702024-02-29 16:08:57 +00003685#if defined(MBEDTLS_SSL_CLI_C)
3686 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3687#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3688 size_t hostname_len;
3689 /* load host name */
3690 if (end - p < 2) {
3691 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3692 }
3693 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3694 p += 2;
3695
3696 if (end - p < (long int) hostname_len) {
3697 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3698 }
3699 if (hostname_len > 0) {
3700 session->hostname = mbedtls_calloc(1, hostname_len);
3701 if (session->hostname == NULL) {
3702 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3703 }
3704 memcpy(session->hostname, p, hostname_len);
3705 p += hostname_len;
3706 }
3707#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3708
3709#if defined(MBEDTLS_HAVE_TIME)
3710 if (end - p < 8) {
3711 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3712 }
3713 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3714 p += 8;
3715#endif
3716 if (end - p < 4) {
3717 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3718 }
3719 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3720 p += 4;
3721
3722 if (end - p < 2) {
3723 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3724 }
3725 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
3726 p += 2;
3727
3728 if (end - p < (long int) session->ticket_len) {
3729 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3730 }
3731 if (session->ticket_len > 0) {
3732 session->ticket = mbedtls_calloc(1, session->ticket_len);
3733 if (session->ticket == NULL) {
3734 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3735 }
3736 memcpy(session->ticket, p, session->ticket_len);
3737 p += session->ticket_len;
3738 }
3739 }
3740#endif /* MBEDTLS_SSL_CLI_C */
3741
3742 return 0;
3743
3744}
3745#else /* MBEDTLS_SSL_SESSION_TICKETS */
3746MBEDTLS_CHECK_RETURN_CRITICAL
3747static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3748 unsigned char *buf,
3749 size_t buf_len,
3750 size_t *olen)
3751{
3752 ((void) session);
3753 ((void) buf);
3754 ((void) buf_len);
3755 *olen = 0;
3756 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3757}
3758
3759static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01003760 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00003761 size_t buf_len)
3762{
3763 ((void) session);
3764 ((void) buf);
3765 ((void) buf_len);
3766 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3767}
3768#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
3769#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
3770
Paul Bakker5121ce52009-01-03 21:22:43 +00003771/*
Hanno Beckera835da52019-05-16 12:39:07 +01003772 * Define ticket header determining Mbed TLS version
3773 * and structure of the ticket.
3774 */
3775
Hanno Becker94ef3b32019-05-16 12:50:45 +01003776/*
Hanno Becker50b59662019-05-28 14:30:45 +01003777 * Define bitflag determining compile-time settings influencing
3778 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01003779 */
3780
Hanno Becker50b59662019-05-28 14:30:45 +01003781#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01003782#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01003783#else
Hanno Becker3e088662019-05-29 11:10:18 +01003784#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003785#endif /* MBEDTLS_HAVE_TIME */
3786
3787#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01003788#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003789#else
Hanno Becker3e088662019-05-29 11:10:18 +01003790#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003791#endif /* MBEDTLS_X509_CRT_PARSE_C */
3792
David Horstmann5c5a32f2024-02-13 17:53:35 +00003793#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00003794#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00003795#else
David Horstmannf686f1d2024-03-01 11:20:32 +00003796#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00003797#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3798
Hanno Becker94ef3b32019-05-16 12:50:45 +01003799#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01003800#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003801#else
Hanno Becker3e088662019-05-29 11:10:18 +01003802#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003803#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
3804
3805#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01003806#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003807#else
Hanno Becker3e088662019-05-29 11:10:18 +01003808#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003809#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3810
Hanno Becker94ef3b32019-05-16 12:50:45 +01003811#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01003812#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01003813#else
Hanno Becker3e088662019-05-29 11:10:18 +01003814#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01003815#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
3816
Hanno Becker94ef3b32019-05-16 12:50:45 +01003817#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3818#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
3819#else
3820#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
3821#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3822
David Horstmann92b258b2024-02-13 17:23:34 +00003823#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3824#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
3825#else
3826#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
3827#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3828
3829#if defined(MBEDTLS_SSL_EARLY_DATA)
3830#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
3831#else
3832#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
3833#endif /* MBEDTLS_SSL_EARLY_DATA */
3834
3835#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3836#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
3837#else
3838#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
3839#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3840
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003841#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
3842 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00003843#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
3844#else
3845#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
3846#endif /* MBEDTLS_SSL_ALPN */
3847
Hanno Becker3e088662019-05-29 11:10:18 +01003848#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
3849#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
3850#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
3851#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01003852#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
3853#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00003854#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00003855#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
3856#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
3857#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00003858#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01003859
Hanno Becker50b59662019-05-28 14:30:45 +01003860#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01003861 ((uint16_t) ( \
3862 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
3863 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
3864 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
3865 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
3866 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
3867 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00003868 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00003869 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
3870 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00003871 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
3872 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
3873 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
3874 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003875 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00003876 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00003877 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01003878
Chien Wong4e9683e2023-12-28 17:07:43 +08003879static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01003880 MBEDTLS_VERSION_MAJOR,
3881 MBEDTLS_VERSION_MINOR,
3882 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01003883 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
3884 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01003885};
Hanno Beckera835da52019-05-16 12:39:07 +01003886
3887/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003888 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02003889 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003890 *
David Horstmanncb01b362024-02-29 17:31:46 +00003891 * TLS 1.2 session:
3892 *
3893 * struct {
3894 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
3895 * opaque ticket<0..2^24-1>; // length 0 means no ticket
3896 * uint32 ticket_lifetime;
3897 * #endif
3898 * } ClientOnlyData;
3899 *
3900 * struct {
3901 * #if defined(MBEDTLS_HAVE_TIME)
3902 * uint64 start_time;
3903 * #endif
3904 * uint8 session_id_len; // at most 32
3905 * opaque session_id[32];
3906 * opaque master[48]; // fixed length in the standard
3907 * uint32 verify_result;
3908 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
3909 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
3910 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00003911 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00003912 * opaque peer_cert_digest<0..2^8-1>
3913 * #endif
3914 * select (endpoint) {
3915 * case client: ClientOnlyData;
3916 * case server: uint64 ticket_creation_time;
3917 * };
3918 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3919 * uint8 mfl_code; // up to 255 according to standard
3920 * #endif
3921 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3922 * uint8 encrypt_then_mac; // 0 or 1
3923 * #endif
3924 * } serialized_session_tls12;
3925 *
3926 *
3927 * TLS 1.3 Session:
3928 *
3929 * struct {
3930 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3931 * opaque hostname<0..2^16-1>;
3932 * #endif
3933 * #if defined(MBEDTLS_HAVE_TIME)
3934 * uint64 ticket_reception_time;
3935 * #endif
3936 * uint32 ticket_lifetime;
3937 * opaque ticket<1..2^16-1>;
3938 * } ClientOnlyData;
3939 *
3940 * struct {
3941 * uint32 ticket_age_add;
3942 * uint8 ticket_flags;
3943 * opaque resumption_key<0..255>;
3944 * #if defined(MBEDTLS_SSL_EARLY_DATA)
3945 * uint32 max_early_data_size;
3946 * #endif
3947 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3948 * uint16 record_size_limit;
3949 * #endif
3950 * select ( endpoint ) {
3951 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003952 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00003953 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003954 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00003955 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00003956 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003957 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00003958 * #endif
3959 * };
3960 * } serialized_session_tls13;
3961 *
3962 *
3963 * SSL session:
3964 *
3965 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003966 *
Hanno Beckerdce50972021-08-01 05:39:23 +01003967 * opaque mbedtls_version[3]; // library version: major, minor, patch
3968 * opaque session_format[2]; // library-version specific 16-bit field
3969 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003970 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01003971 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003972 * Note: When updating the format, remember to keep
3973 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003974 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003975 * // In this version, `session_format` determines
3976 * // the setting of those compile-time
3977 * // configuration options which influence
3978 * // the structure of mbedtls_ssl_session.
3979 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003980 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08003981 * // - TLS 1.2 (0x0303)
3982 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00003983 * uint8_t endpoint;
3984 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003985 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003986 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003987 *
Glenn Straussda7851c2022-03-14 13:29:48 -04003988 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003989 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08003990 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08003991 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003992 *
3993 * };
3994 *
3995 * } serialized_session;
3996 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02003997 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01003998
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02003999MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004000static int ssl_session_save(const mbedtls_ssl_session *session,
4001 unsigned char omit_header,
4002 unsigned char *buf,
4003 size_t buf_len,
4004 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004005{
4006 unsigned char *p = buf;
4007 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004008 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004009#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4010 size_t out_len;
4011 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4012#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004013 if (session == NULL) {
4014 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4015 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004016
Gilles Peskine449bd832023-01-11 14:50:10 +01004017 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004018 /*
4019 * Add Mbed TLS version identifier
4020 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004021 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004022
Gilles Peskine449bd832023-01-11 14:50:10 +01004023 if (used <= buf_len) {
4024 memcpy(p, ssl_serialized_session_header,
4025 sizeof(ssl_serialized_session_header));
4026 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004027 }
4028 }
4029
4030 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004031 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004032 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004033 used += 1 /* TLS version */
4034 + 1 /* endpoint */
4035 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004036 if (used <= buf_len) {
4037 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004038 *p++ = session->endpoint;
4039 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4040 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004041 }
4042
4043 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004044 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004045 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004046#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004047 case MBEDTLS_SSL_VERSION_TLS1_2:
4048 used += ssl_tls12_session_save(session, p, remaining_len);
4049 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004050#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4051
Jerry Yu251a12e2022-07-13 15:15:48 +08004052#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004053 case MBEDTLS_SSL_VERSION_TLS1_3:
4054 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4055 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4056 return ret;
4057 }
4058 used += out_len;
4059 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004060#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4061
Gilles Peskine449bd832023-01-11 14:50:10 +01004062 default:
4063 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004064 }
4065
4066 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004067 if (used > buf_len) {
4068 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4069 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004070
Gilles Peskine449bd832023-01-11 14:50:10 +01004071 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004072}
4073
4074/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004075 * Public wrapper for ssl_session_save()
4076 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004077int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4078 unsigned char *buf,
4079 size_t buf_len,
4080 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004081{
Gilles Peskine449bd832023-01-11 14:50:10 +01004082 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004083}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004084
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004085/*
4086 * Deserialize session, see mbedtls_ssl_session_save() for format.
4087 *
4088 * This internal version is wrapped by a public function that cleans up in
4089 * case of error, and has an extra option omit_header.
4090 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004091MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004092static int ssl_session_load(mbedtls_ssl_session *session,
4093 unsigned char omit_header,
4094 const unsigned char *buf,
4095 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004096{
4097 const unsigned char *p = buf;
4098 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004099 size_t remaining_len;
4100
4101
Gilles Peskine449bd832023-01-11 14:50:10 +01004102 if (session == NULL) {
4103 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4104 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004105
Gilles Peskine449bd832023-01-11 14:50:10 +01004106 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004107 /*
4108 * Check Mbed TLS version identifier
4109 */
4110
Gilles Peskine449bd832023-01-11 14:50:10 +01004111 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4112 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004113 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004114
4115 if (memcmp(p, ssl_serialized_session_header,
4116 sizeof(ssl_serialized_session_header)) != 0) {
4117 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4118 }
4119 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004120 }
4121
4122 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004123 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004124 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004125 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004126 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4127 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004128 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004129 session->endpoint = *p++;
4130 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4131 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004132
4133 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004134 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004135 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004136#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004137 case MBEDTLS_SSL_VERSION_TLS1_2:
4138 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004139#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4140
Jerry Yu438ddd82022-07-07 06:55:50 +00004141#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004142 case MBEDTLS_SSL_VERSION_TLS1_3:
4143 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004144#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4145
Gilles Peskine449bd832023-01-11 14:50:10 +01004146 default:
4147 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004148 }
4149}
4150
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004151/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004152 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004153 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004154int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4155 const unsigned char *buf,
4156 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004157{
Gilles Peskine449bd832023-01-11 14:50:10 +01004158 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004159
Gilles Peskine449bd832023-01-11 14:50:10 +01004160 if (ret != 0) {
4161 mbedtls_ssl_session_free(session);
4162 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004163
Gilles Peskine449bd832023-01-11 14:50:10 +01004164 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004165}
4166
4167/*
Paul Bakker1961b702013-01-25 14:49:24 +01004168 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004169 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004170MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004171static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004172{
4173 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4174
Ronald Cron66dbf912022-02-02 15:33:46 +01004175 /*
4176 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004177 * that were written into the output buffer by the previous handshake step,
4178 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004179 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4180 * We proceed to the next handshake step only when all data from the
4181 * previous one have been sent to the peer, thus we make sure that this is
4182 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4183 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4184 * we have to wait before to go ahead.
4185 * In the case of TLS 1.3, handshake step handlers do not send data to the
4186 * peer. Data are only sent here and through
4187 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004188 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004189 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004190 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4191 return ret;
4192 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004193
4194#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004195 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4196 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4197 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4198 return ret;
4199 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004200 }
4201#endif /* MBEDTLS_SSL_PROTO_DTLS */
4202
Gilles Peskine449bd832023-01-11 14:50:10 +01004203 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004204}
4205
Gilles Peskine449bd832023-01-11 14:50:10 +01004206int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004207{
Hanno Becker41934dd2021-08-07 19:13:43 +01004208 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004209
Gilles Peskine449bd832023-01-11 14:50:10 +01004210 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004211 ssl->conf == NULL ||
4212 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004213 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4214 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004215 }
4216
Gilles Peskine449bd832023-01-11 14:50:10 +01004217 ret = ssl_prepare_handshake_step(ssl);
4218 if (ret != 0) {
4219 return ret;
4220 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004221
Gilles Peskine449bd832023-01-11 14:50:10 +01004222 ret = mbedtls_ssl_handle_pending_alert(ssl);
4223 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004224 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004225 }
Jerry Yue7047812021-09-13 19:26:39 +08004226
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004227 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4228 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4229 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4230
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004231#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004232 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4233 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004234 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004235
Gilles Peskine449bd832023-01-11 14:50:10 +01004236 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004237 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskinef670ba52025-03-07 15:09:32 +01004238 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004239 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004240 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004241
Ronald Cron9f0fba32022-02-10 16:45:15 +01004242 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004243 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004244 break;
4245
4246 default:
4247#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004248 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4249 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4250 } else {
4251 ret = mbedtls_ssl_handshake_client_step(ssl);
4252 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004253#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004254 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004255#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004256 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004257#endif
4258 }
Jerry Yub9930e72021-08-06 17:11:51 +08004259 }
Ronald Cron6291b232023-03-08 15:51:25 +01004260#endif /* MBEDTLS_SSL_CLI_C */
4261
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004262#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004263 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004264#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4265 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004266 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004267 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004268 ret = mbedtls_ssl_handshake_server_step(ssl);
4269 }
Ronald Cron6291b232023-03-08 15:51:25 +01004270#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4271 ret = mbedtls_ssl_handshake_server_step(ssl);
4272#else
4273 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004274#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004275 }
4276#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004277
Gilles Peskine449bd832023-01-11 14:50:10 +01004278 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004279 /* handshake_step return error. And it is same
4280 * with alert_reason.
4281 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004282 if (ssl->send_alert) {
4283 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004284 goto cleanup;
4285 }
4286 }
4287
4288cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004289 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004290}
4291
4292/*
4293 * Perform the SSL handshake
4294 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004295int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004296{
4297 int ret = 0;
4298
Hanno Beckera817ea42020-10-20 15:20:23 +01004299 /* Sanity checks */
4300
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 if (ssl == NULL || ssl->conf == NULL) {
4302 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4303 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004304
Hanno Beckera817ea42020-10-20 15:20:23 +01004305#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004306 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4307 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4308 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4309 "mbedtls_ssl_set_timer_cb() for DTLS"));
4310 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004311 }
4312#endif /* MBEDTLS_SSL_PROTO_DTLS */
4313
Gilles Peskine449bd832023-01-11 14:50:10 +01004314 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004315
Hanno Beckera817ea42020-10-20 15:20:23 +01004316 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004317 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4318 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004319
Gilles Peskine449bd832023-01-11 14:50:10 +01004320 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004321 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004322 }
Paul Bakker1961b702013-01-25 14:49:24 +01004323 }
4324
Gilles Peskine449bd832023-01-11 14:50:10 +01004325 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004326
Gilles Peskine449bd832023-01-11 14:50:10 +01004327 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004328}
4329
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004330#if defined(MBEDTLS_SSL_RENEGOTIATION)
4331#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004332/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004333 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004334 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004335MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004336static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004337{
Janos Follath865b3eb2019-12-16 11:46:15 +00004338 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004339
Gilles Peskine449bd832023-01-11 14:50:10 +01004340 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004341
4342 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004343 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4344 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004345
Gilles Peskine449bd832023-01-11 14:50:10 +01004346 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4347 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4348 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004349 }
4350
Gilles Peskine449bd832023-01-11 14:50:10 +01004351 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004352
Gilles Peskine449bd832023-01-11 14:50:10 +01004353 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004354}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004355#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004356
4357/*
4358 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004359 * - any side: calling mbedtls_ssl_renegotiate(),
4360 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4361 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004362 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004363 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004364 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004365 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004366int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004367{
Janos Follath865b3eb2019-12-16 11:46:15 +00004368 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004369
Gilles Peskine449bd832023-01-11 14:50:10 +01004370 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004371
Gilles Peskine449bd832023-01-11 14:50:10 +01004372 if ((ret = ssl_handshake_init(ssl)) != 0) {
4373 return ret;
4374 }
Paul Bakker48916f92012-09-16 19:57:18 +00004375
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004376 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4377 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004378#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004379 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4380 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4381 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004382 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004384 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004386 }
4387#endif
4388
Gilles Peskinef670ba52025-03-07 15:09:32 +01004389 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_REQUEST);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004390 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004391
Gilles Peskine449bd832023-01-11 14:50:10 +01004392 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4393 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4394 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004395 }
4396
Gilles Peskine449bd832023-01-11 14:50:10 +01004397 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004398
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004400}
4401
4402/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004403 * Renegotiate current connection on client,
4404 * or request renegotiation on server
4405 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004406int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004407{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004408 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004409
Gilles Peskine449bd832023-01-11 14:50:10 +01004410 if (ssl == NULL || ssl->conf == NULL) {
4411 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4412 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004413
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004414#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004415 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004416 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4417 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4418 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4419 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004420
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004421 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004422
4423 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004424 if (ssl->out_left != 0) {
4425 return mbedtls_ssl_flush_output(ssl);
4426 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004427
Gilles Peskine449bd832023-01-11 14:50:10 +01004428 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004429 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004430#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004431
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004432#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004433 /*
4434 * On client, either start the renegotiation process or,
4435 * if already in progress, continue the handshake
4436 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4438 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4439 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004440 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004441
4442 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4443 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4444 return ret;
4445 }
4446 } else {
4447 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4448 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4449 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004450 }
4451 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004452#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004453
Gilles Peskine449bd832023-01-11 14:50:10 +01004454 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004455}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004456#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004457
Gilles Peskine449bd832023-01-11 14:50:10 +01004458void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004459{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004460 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4461
Gilles Peskine449bd832023-01-11 14:50:10 +01004462 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004463 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004464 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004465
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004466#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Brett Warrene0edc842021-08-17 09:53:13 +01004467#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 if (ssl->handshake->group_list_heap_allocated) {
4469 mbedtls_free((void *) handshake->group_list);
4470 }
Brett Warrene0edc842021-08-17 09:53:13 +01004471 handshake->group_list = NULL;
4472#endif /* MBEDTLS_DEPRECATED_REMOVED */
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004473#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Brett Warrene0edc842021-08-17 09:53:13 +01004474
Ronald Crone68ab4f2022-10-05 12:46:29 +02004475#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004476#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004477 if (ssl->handshake->sig_algs_heap_allocated) {
4478 mbedtls_free((void *) handshake->sig_algs);
4479 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004480 handshake->sig_algs = NULL;
4481#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004482#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004483 if (ssl->handshake->certificate_request_context) {
4484 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004485 }
4486#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004487#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004488
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004489#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Ben Taylorcd2660f2025-03-21 13:13:29 +00004490 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
Ben Taylorc12152e2025-03-21 11:03:04 +00004491 ssl->conf->f_async_cancel(ssl);
4492 handshake->async_in_progress = 0;
Ben Taylor1cd1e012025-03-18 11:50:39 +00004493 }
Ben Taylor6ff2da12025-03-17 09:26:20 +00004494
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004495#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4496
Elena Uziunaite0916cd72024-05-23 17:01:07 +01004497#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004499#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01004500#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004502#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004503
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004504#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004506 /*
4507 * Opaque keys are not stored in the handshake's data and it's the user
4508 * responsibility to destroy them. Clear ones, instead, are created by
4509 * the TLS library and should be destroyed at the same level
4510 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004511 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4512 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004513 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004514 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004515#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004516 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004517 handshake->ecjpake_cache = NULL;
4518 handshake->ecjpake_cache_len = 0;
4519#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004520#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004521
Valerio Setti7aeec542023-07-05 18:57:21 +02004522#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004523 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004524 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004525 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004526 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004527#endif
4528
Ronald Cron73fe8df2022-10-05 14:31:43 +02004529#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004530 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004531 /* The maintenance of the external PSK key slot is the
4532 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004533 if (ssl->handshake->psk_opaque_is_internal) {
4534 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004535 ssl->handshake->psk_opaque_is_internal = 0;
4536 }
4537 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4538 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02004539#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004540
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004541#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4542 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004543 /*
4544 * Free only the linked list wrapper, not the keys themselves
4545 * since the belong to the SNI callback
4546 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004548#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004549
Gilles Peskineeccd8882020-03-10 12:19:08 +01004550#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4552 if (handshake->ecrs_peer_cert != NULL) {
4553 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4554 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004555 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004556#endif
4557
Hanno Becker75173122019-02-06 16:18:31 +00004558#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4559 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004560 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004561#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4562
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004563#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004564 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4565 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004566#endif /* MBEDTLS_SSL_CLI_C &&
4567 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004568
4569#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 mbedtls_ssl_flight_free(handshake->flight);
4571 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004572#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004573
Valerio Settiea59c432023-07-25 11:14:03 +02004574#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004575 if (handshake->xxdh_psa_privkey_is_external == 0) {
4576 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004577 }
Valerio Settiea59c432023-07-25 11:14:03 +02004578#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004579
Ronald Cron6f135e12021-12-08 16:57:54 +01004580#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 mbedtls_ssl_transform_free(handshake->transform_handshake);
4582 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004583#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4585 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004586#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004587#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004588
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004589
4590#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4591 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4592 * processes datagrams and the fact that a datagram is allowed to have
4593 * several records in it, it is possible that the I/O buffers are not
4594 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4596 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004597#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004598
Jerry Yuba9c7272021-10-30 11:54:10 +08004599 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004600 mbedtls_platform_zeroize(handshake,
4601 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004602}
4603
Gilles Peskine449bd832023-01-11 14:50:10 +01004604void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004605{
Gilles Peskine449bd832023-01-11 14:50:10 +01004606 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004607 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004608 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004609
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004610#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004611 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004612#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004613
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004614#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004615#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4616 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004617 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004618#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004619 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004620#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004621
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004622#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4623 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004624 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004625#endif
4626
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004628}
4629
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004630#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004631
4632#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4633#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4634#else
4635#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4636#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4637
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004638#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004639
4640#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4641#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4642#else
4643#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4644#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4645
4646#if defined(MBEDTLS_SSL_ALPN)
4647#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4648#else
4649#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4650#endif /* MBEDTLS_SSL_ALPN */
4651
4652#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4653#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4654#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4655#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4656
4657#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004658 ((uint32_t) ( \
4659 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4660 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4661 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4662 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4663 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4664 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4665 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4666 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004667
Chien Wong4e9683e2023-12-28 17:07:43 +08004668static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004669 MBEDTLS_VERSION_MAJOR,
4670 MBEDTLS_VERSION_MINOR,
4671 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004672 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4673 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4674 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4675 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4676 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004677};
4678
Paul Bakker5121ce52009-01-03 21:22:43 +00004679/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004680 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004681 *
4682 * The format of the serialized data is:
4683 * (in the presentation language of TLS, RFC 8446 section 3)
4684 *
4685 * // header
4686 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004687 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004688 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004689 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004690 * Note: When updating the format, remember to keep these
4691 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004692 *
4693 * // session sub-structure
4694 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4695 * // transform sub-structure
4696 * uint8 random[64]; // ServerHello.random+ClientHello.random
4697 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
4698 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
4699 * // fields from ssl_context
4700 * uint32 badmac_seen; // DTLS: number of records with failing MAC
4701 * uint64 in_window_top; // DTLS: last validated record seq_num
4702 * uint64 in_window; // DTLS: bitmask for replay protection
4703 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
4704 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
4705 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
4706 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
4707 *
4708 * Note that many fields of the ssl_context or sub-structures are not
4709 * serialized, as they fall in one of the following categories:
4710 *
4711 * 1. forced value (eg in_left must be 0)
4712 * 2. pointer to dynamically-allocated memory (eg session, transform)
4713 * 3. value can be re-derived from other data (eg session keys from MS)
4714 * 4. value was temporary (eg content of input buffer)
4715 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004716 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004717int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4718 unsigned char *buf,
4719 size_t buf_len,
4720 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004721{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004722 unsigned char *p = buf;
4723 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004724 size_t session_len;
4725 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004726
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004727 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004728 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
4729 * this function's documentation.
4730 *
4731 * These are due to assumptions/limitations in the implementation. Some of
4732 * them are likely to stay (no handshake in progress) some might go away
4733 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004734 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004735 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4737 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
4738 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004739 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004740 if (ssl->handshake != NULL) {
4741 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
4742 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004743 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004744 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01004745 if (ssl->transform == NULL || ssl->session == NULL) {
4746 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
4747 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004748 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004749 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01004750 if (mbedtls_ssl_check_pending(ssl) != 0) {
4751 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
4752 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004753 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004754 if (ssl->out_left != 0) {
4755 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
4756 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004757 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00004758 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01004759 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
4760 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
4761 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004762 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004763 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
4765 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
4766 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004767 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004768 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
4770 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
4771 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004772 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004773 /* Renegotiation must not be enabled */
4774#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004775 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
4776 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
4777 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03004778 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02004779#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004780
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004781 /*
4782 * Version and format identifier
4783 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004784 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004785
Gilles Peskine449bd832023-01-11 14:50:10 +01004786 if (used <= buf_len) {
4787 memcpy(p, ssl_serialized_context_header,
4788 sizeof(ssl_serialized_context_header));
4789 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004790 }
4791
4792 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004793 * Session (length + data)
4794 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004795 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
4796 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4797 return ret;
4798 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004799
4800 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004801 if (used <= buf_len) {
4802 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004803 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004804
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 ret = ssl_session_save(ssl->session, 1,
4806 p, session_len, &session_len);
4807 if (ret != 0) {
4808 return ret;
4809 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004810
4811 p += session_len;
4812 }
4813
4814 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004815 * Transform
4816 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 used += sizeof(ssl->transform->randbytes);
4818 if (used <= buf_len) {
4819 memcpy(p, ssl->transform->randbytes,
4820 sizeof(ssl->transform->randbytes));
4821 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004822 }
4823
4824#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00004825 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004827 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004828 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004829 p += ssl->transform->in_cid_len;
4830
4831 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004832 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02004833 p += ssl->transform->out_cid_len;
4834 }
4835#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4836
4837 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004838 * Saved fields from top-level ssl_context structure
4839 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004840 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01004841 if (used <= buf_len) {
4842 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004843 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004844 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004845
4846#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4847 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01004848 if (used <= buf_len) {
4849 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004850 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004851
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004853 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004854 }
4855#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4856
4857#if defined(MBEDTLS_SSL_PROTO_DTLS)
4858 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004859 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004860 *p++ = ssl->disable_datagram_packing;
4861 }
4862#endif /* MBEDTLS_SSL_PROTO_DTLS */
4863
Jerry Yuae0b2e22021-10-08 15:21:19 +08004864 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01004865 if (used <= buf_len) {
4866 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08004867 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004868 }
4869
4870#if defined(MBEDTLS_SSL_PROTO_DTLS)
4871 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01004872 if (used <= buf_len) {
4873 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01004874 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004875 }
4876#endif /* MBEDTLS_SSL_PROTO_DTLS */
4877
4878#if defined(MBEDTLS_SSL_ALPN)
4879 {
4880 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01004881 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004882 : 0;
4883
4884 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004886 *p++ = alpn_len;
4887
Gilles Peskine449bd832023-01-11 14:50:10 +01004888 if (ssl->alpn_chosen != NULL) {
4889 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02004890 p += alpn_len;
4891 }
4892 }
4893 }
4894#endif /* MBEDTLS_SSL_ALPN */
4895
4896 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004897 * Done
4898 */
4899 *olen = used;
4900
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 if (used > buf_len) {
4902 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4903 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004904
Gilles Peskine449bd832023-01-11 14:50:10 +01004905 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004906
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004908}
4909
4910/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004911 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004912 *
4913 * This internal version is wrapped by a public function that cleans up in
4914 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004915 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004916MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004917static int ssl_context_load(mbedtls_ssl_context *ssl,
4918 const unsigned char *buf,
4919 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004920{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004921 const unsigned char *p = buf;
4922 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004923 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00004924 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004925#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04004926 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04004927#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004928
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004929 /*
4930 * The context should have been freshly setup or reset.
4931 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02004932 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004933 * renegotiating, or if the user mistakenly loaded a session first.)
4934 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
4936 ssl->session != NULL) {
4937 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004938 }
4939
4940 /*
4941 * We can't check that the config matches the initial one, but we can at
4942 * least check it matches the requirements for serializing.
4943 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004944 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004945#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02004946 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004947#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01004948 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
4949 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
4950 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
4951 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004952 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02004953 }
4954
Gilles Peskine449bd832023-01-11 14:50:10 +01004955 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004956
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004957 /*
4958 * Check version identifier
4959 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004960 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
4961 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004962 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004963
4964 if (memcmp(p, ssl_serialized_context_header,
4965 sizeof(ssl_serialized_context_header)) != 0) {
4966 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4967 }
4968 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004969
4970 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004971 * Session
4972 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004973 if ((size_t) (end - p) < 4) {
4974 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4975 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004976
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01004977 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004978 p += 4;
4979
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004980 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00004981 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004982 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004983 ssl->session_in = ssl->session;
4984 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02004985 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004986
Gilles Peskine449bd832023-01-11 14:50:10 +01004987 if ((size_t) (end - p) < session_len) {
4988 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4989 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004990
Gilles Peskine449bd832023-01-11 14:50:10 +01004991 ret = ssl_session_load(ssl->session, 1, p, session_len);
4992 if (ret != 0) {
4993 mbedtls_ssl_session_free(ssl->session);
4994 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004995 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004996
4997 p += session_len;
4998
4999 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005000 * Transform
5001 */
5002
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005003 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005004 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005005#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005006 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005007 ssl->transform_in = ssl->transform;
5008 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005009 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005010#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005011
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005012#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005013 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5014 if (prf_func == NULL) {
5015 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5016 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005017
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005018 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005019 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5020 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5021 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005022
Gilles Peskine449bd832023-01-11 14:50:10 +01005023 ret = ssl_tls12_populate_transform(ssl->transform,
5024 ssl->session->ciphersuite,
5025 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005026#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005027 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005028#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005029 prf_func,
5030 p, /* currently pointing to randbytes */
5031 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5032 ssl->conf->endpoint,
5033 ssl);
5034 if (ret != 0) {
5035 return ret;
5036 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005037#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005039
5040#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5041 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 if ((size_t) (end - p) < 1) {
5043 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5044 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005045
5046 ssl->transform->in_cid_len = *p++;
5047
Gilles Peskine449bd832023-01-11 14:50:10 +01005048 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5049 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5050 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005051
Gilles Peskine449bd832023-01-11 14:50:10 +01005052 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005053 p += ssl->transform->in_cid_len;
5054
5055 ssl->transform->out_cid_len = *p++;
5056
Gilles Peskine449bd832023-01-11 14:50:10 +01005057 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5058 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5059 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005060
Gilles Peskine449bd832023-01-11 14:50:10 +01005061 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005062 p += ssl->transform->out_cid_len;
5063#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5064
5065 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005066 * Saved fields from top-level ssl_context structure
5067 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005068 if ((size_t) (end - p) < 4) {
5069 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5070 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005071
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005072 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005073 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005074
5075#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005076 if ((size_t) (end - p) < 16) {
5077 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5078 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005079
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005080 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005081 p += 8;
5082
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005083 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005084 p += 8;
5085#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5086
5087#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005088 if ((size_t) (end - p) < 1) {
5089 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5090 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005091
5092 ssl->disable_datagram_packing = *p++;
5093#endif /* MBEDTLS_SSL_PROTO_DTLS */
5094
Gilles Peskine449bd832023-01-11 14:50:10 +01005095 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5096 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5097 }
5098 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5099 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005100
5101#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 if ((size_t) (end - p) < 2) {
5103 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5104 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005105
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005106 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005107 p += 2;
5108#endif /* MBEDTLS_SSL_PROTO_DTLS */
5109
5110#if defined(MBEDTLS_SSL_ALPN)
5111 {
5112 uint8_t alpn_len;
5113 const char **cur;
5114
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 if ((size_t) (end - p) < 1) {
5116 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5117 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005118
5119 alpn_len = *p++;
5120
Gilles Peskine449bd832023-01-11 14:50:10 +01005121 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005122 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005123 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5124 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005125 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005126 ssl->alpn_chosen = *cur;
5127 break;
5128 }
5129 }
5130 }
5131
5132 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005133 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5134 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5135 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005136
5137 p += alpn_len;
5138 }
5139#endif /* MBEDTLS_SSL_ALPN */
5140
5141 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005142 * Forced fields from top-level ssl_context structure
5143 *
5144 * Most of them already set to the correct value by mbedtls_ssl_init() and
5145 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5146 */
Gilles Peskinef670ba52025-03-07 15:09:32 +01005147 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Glenn Strauss60bfe602022-03-14 19:04:24 -04005148 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005149
Hanno Becker361b10d2019-08-30 10:42:49 +01005150 /* Adjust pointers for header fields of outgoing records to
5151 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005152 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005153
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005154#if defined(MBEDTLS_SSL_PROTO_DTLS)
5155 ssl->in_epoch = 1;
5156#endif
5157
5158 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5159 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005160 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5161 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 if (ssl->handshake != NULL) {
5163 mbedtls_ssl_handshake_free(ssl);
5164 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005165 ssl->handshake = NULL;
5166 }
5167
5168 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005169 * Done - should have consumed entire buffer
5170 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005171 if (p != end) {
5172 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5173 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005174
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005176}
5177
5178/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005179 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005180 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005181int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5182 const unsigned char *buf,
5183 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005184{
Gilles Peskine449bd832023-01-11 14:50:10 +01005185 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005186
Gilles Peskine449bd832023-01-11 14:50:10 +01005187 if (ret != 0) {
5188 mbedtls_ssl_free(context);
5189 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005190
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005192}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005193#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005194
5195/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005196 * Free an SSL context
5197 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005198void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005199{
Gilles Peskine449bd832023-01-11 14:50:10 +01005200 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005201 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005202 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005203
Gilles Peskine449bd832023-01-11 14:50:10 +01005204 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005205
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005207#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5208 size_t out_buf_len = ssl->out_buf_len;
5209#else
5210 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5211#endif
5212
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005213 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005214 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005215 }
5216
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005218#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5219 size_t in_buf_len = ssl->in_buf_len;
5220#else
5221 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5222#endif
5223
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005224 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005225 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005226 }
5227
Gilles Peskine449bd832023-01-11 14:50:10 +01005228 if (ssl->transform) {
5229 mbedtls_ssl_transform_free(ssl->transform);
5230 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005231 }
5232
Gilles Peskine449bd832023-01-11 14:50:10 +01005233 if (ssl->handshake) {
5234 mbedtls_ssl_handshake_free(ssl);
5235 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005236
5237#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005238 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5239 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005240#endif
5241
Gilles Peskine449bd832023-01-11 14:50:10 +01005242 mbedtls_ssl_session_free(ssl->session_negotiate);
5243 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005244 }
5245
Ronald Cron6f135e12021-12-08 16:57:54 +01005246#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005247 mbedtls_ssl_transform_free(ssl->transform_application);
5248 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005249#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005250
Gilles Peskine449bd832023-01-11 14:50:10 +01005251 if (ssl->session) {
5252 mbedtls_ssl_session_free(ssl->session);
5253 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005254 }
5255
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005256#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine4ac40082025-02-20 18:13:58 +01005257 mbedtls_ssl_free_hostname(ssl);
Paul Bakker0be444a2013-08-27 21:55:01 +02005258#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005259
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005260#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005261 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005262#endif
5263
Gilles Peskine449bd832023-01-11 14:50:10 +01005264 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005265
Paul Bakker86f04f42013-02-14 11:20:09 +01005266 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005267 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005268}
5269
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005270/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005271 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005272 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005273void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005274{
Gilles Peskine449bd832023-01-11 14:50:10 +01005275 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005276}
5277
Gilles Peskineae270bf2021-06-02 00:05:29 +02005278/* The selection should be the same as mbedtls_x509_crt_profile_default in
5279 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005280 * curves with a lower resource usage come first.
Manuel Pégourié-Gonnard93d45912025-01-14 11:45:44 +01005281 * See the documentation of mbedtls_ssl_conf_groups() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005282 * about this list.
5283 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005284static const uint16_t ssl_preset_default_groups[] = {
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005285#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Brett Warrene0edc842021-08-17 09:53:13 +01005286 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005287#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005288#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005289 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005290#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005291#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005292 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005293#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005294#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Brett Warrene0edc842021-08-17 09:53:13 +01005295 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005296#endif
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005297#if defined(PSA_WANT_ECC_SECP_R1_521)
Brett Warrene0edc842021-08-17 09:53:13 +01005298 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005299#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005300#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005301 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005302#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005303#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005304 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005305#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005306#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Brett Warrene0edc842021-08-17 09:53:13 +01005307 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005308#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005309#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005310 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5311 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5312 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5313 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5314 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5315#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005316 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005317};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005318
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005319static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005320 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5321 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5322 0
5323};
5324
Ronald Crone68ab4f2022-10-05 12:46:29 +02005325#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005326
Jerry Yu909df7b2022-01-22 11:56:27 +08005327/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005328 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005329 * rules SHOULD be upheld.
5330 * - No duplicate entries.
5331 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005332 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005333 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005334 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005335static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005336
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005337#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005338 defined(PSA_WANT_ALG_SHA_256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005339 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005340 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005341 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5342#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005343
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005344#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005345 defined(PSA_WANT_ALG_SHA_384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005346 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005347 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005348 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5349#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005350
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005351#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Gabor Mezeic15ef932024-06-13 12:53:54 +02005352 defined(PSA_WANT_ALG_SHA_512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005353 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005354 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005355 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5356#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005357
Gabor Mezeic15ef932024-06-13 12:53:54 +02005358#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005359 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005360#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005361
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005362#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005363 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005364#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005365
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005366#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005367 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005368#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005369
Gabor Mezeic15ef932024-06-13 12:53:54 +02005370#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005371 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Gabor Mezeic15ef932024-06-13 12:53:54 +02005372#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005373
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005374#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005375 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005376#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005377
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005378#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005379 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005380#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005381
Gabor Mezei15b95a62022-05-09 16:37:58 +02005382 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005383};
5384
5385/* NOTICE: see above */
5386#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5387static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005388
Gabor Mezeic15ef932024-06-13 12:53:54 +02005389#if defined(PSA_WANT_ALG_SHA_512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005390#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005391 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005392#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005393#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5394 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005395#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005396#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005397 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005398#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005399#endif /* PSA_WANT_ALG_SHA_512 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005400
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005401#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005402#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005403 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005404#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005405#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5406 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005407#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005408#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005409 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005410#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005411#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005412
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005413#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005414#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005415 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005416#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005417#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5418 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005419#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005420#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005422#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005423#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005424
Gabor Mezei15b95a62022-05-09 16:37:58 +02005425 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005426};
5427#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005428
Jerry Yu909df7b2022-01-22 11:56:27 +08005429/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005430static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005431
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005432#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005433 defined(PSA_WANT_ALG_SHA_256) && \
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005434 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005435 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005436 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5437#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005438
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005439#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005440 defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005441 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu53037892022-01-25 11:02:06 +08005442 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005443 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5444#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005445
Gabor Mezei15b95a62022-05-09 16:37:58 +02005446 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005447};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005448
Jerry Yu909df7b2022-01-22 11:56:27 +08005449/* NOTICE: see above */
5450#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5451static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005452
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005453#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005454#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005455 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005456#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005457#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005458
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005459#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005460#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005461 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005462#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005463#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005464
Gabor Mezei15b95a62022-05-09 16:37:58 +02005465 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005466};
Jerry Yu909df7b2022-01-22 11:56:27 +08005467#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5468
Ronald Crone68ab4f2022-10-05 12:46:29 +02005469#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005470
Chien Wong4e9683e2023-12-28 17:07:43 +08005471static const uint16_t ssl_preset_suiteb_groups[] = {
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005472#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005473 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005474#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005475#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005476 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005477#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005478 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005479};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005480
Ronald Crone68ab4f2022-10-05 12:46:29 +02005481#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005482/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005483 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005484MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005485static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005486{
5487 size_t i, j;
5488 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005489
Gilles Peskine449bd832023-01-11 14:50:10 +01005490 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5491 for (j = 0; j < i; j++) {
5492 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005493 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005494 }
5495 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5496 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5497 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005498 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005499 }
5500 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005501 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005502}
5503
Ronald Crone68ab4f2022-10-05 12:46:29 +02005504#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005505
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005506/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005507 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005508 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005509int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5510 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005511{
Ronald Crone68ab4f2022-10-05 12:46:29 +02005512#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5514 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5515 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005516 }
5517
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5519 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5520 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005521 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005522
5523#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005524 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5525 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5526 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005527 }
5528
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5530 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5531 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005532 }
5533#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005534#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005535
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005536 /* Use the functions here so that they are covered in tests,
5537 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005538 mbedtls_ssl_conf_endpoint(conf, endpoint);
5539 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005540
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005541 /*
5542 * Things that are common to all presets
5543 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005544#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005545 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005546 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5547#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5548 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5549#endif
5550 }
5551#endif
5552
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005553#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5554 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5555#endif
5556
5557#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5558 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5559#endif
5560
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005561#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005562 conf->f_cookie_write = ssl_cookie_write_dummy;
5563 conf->f_cookie_check = ssl_cookie_check_dummy;
5564#endif
5565
5566#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5567 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5568#endif
5569
Janos Follath088ce432017-04-10 12:42:31 +01005570#if defined(MBEDTLS_SSL_SRV_C)
5571 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005572 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005573#endif
5574
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005575#if defined(MBEDTLS_SSL_PROTO_DTLS)
5576 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5577 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5578#endif
5579
5580#if defined(MBEDTLS_SSL_RENEGOTIATION)
5581 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005582 memset(conf->renego_period, 0x00, 2);
5583 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005584#endif
5585
Ronald Cron6f135e12021-12-08 16:57:54 +01005586#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005587
5588#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005589 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005590#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005591 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005592#endif
5593#endif /* MBEDTLS_SSL_EARLY_DATA */
5594
Jerry Yud0766ec2022-09-22 10:46:57 +08005595#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005596 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005597 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005598#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005599 /*
5600 * Allow all TLS 1.3 key exchange modes by default.
5601 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005602 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005603#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005604
Gilles Peskine449bd832023-01-11 14:50:10 +01005605 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005606#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005607 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005608 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005609#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005610 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005611#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005612 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005613#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005614 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5615 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005616#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5617 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5618 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5619#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5620 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5621 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5622#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005623 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005624#endif
5625 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005626
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005627 /*
5628 * Preset-specific defaults
5629 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005630 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005631 /*
5632 * NSA Suite B
5633 */
5634 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005635
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005636 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005637
5638#if defined(MBEDTLS_X509_CRT_PARSE_C)
5639 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005640#endif
5641
Ronald Crone68ab4f2022-10-05 12:46:29 +02005642#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005643#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005644 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005645 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005646 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005647#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005648 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005649#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005650
Brett Warrene0edc842021-08-17 09:53:13 +01005651 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005652 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005653
5654 /*
5655 * Default
5656 */
5657 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005658
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005659 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005660
5661#if defined(MBEDTLS_X509_CRT_PARSE_C)
5662 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5663#endif
5664
Ronald Crone68ab4f2022-10-05 12:46:29 +02005665#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005666#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005667 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005668 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005669 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005670#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005671 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005672#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005673
Brett Warrene0edc842021-08-17 09:53:13 +01005674 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005675 }
5676
Gilles Peskine449bd832023-01-11 14:50:10 +01005677 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005678}
5679
5680/*
5681 * Free mbedtls_ssl_config
5682 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005683void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005684{
Troy-Butlerda73abc2024-04-02 13:37:31 -04005685 if (conf == NULL) {
5686 return;
5687 }
5688
Ronald Cron73fe8df2022-10-05 14:31:43 +02005689#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005690 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02005691 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
5692 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005693 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005694 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005695 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005696 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09005697 }
5698
Gilles Peskine449bd832023-01-11 14:50:10 +01005699 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005700 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00005701 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005702 conf->psk_identity_len = 0;
5703 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02005704#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005705
5706#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005707 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005708#endif
5709
Gilles Peskine449bd832023-01-11 14:50:10 +01005710 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005711}
5712
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02005713#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02005714 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005715/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005716 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005717 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005718unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005719{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005720#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005721 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
5722 return MBEDTLS_SSL_SIG_RSA;
5723 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005724#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005725#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
5727 return MBEDTLS_SSL_SIG_ECDSA;
5728 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005729#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005730 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02005731}
5732
Gilles Peskine449bd832023-01-11 14:50:10 +01005733unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01005734{
Gilles Peskine449bd832023-01-11 14:50:10 +01005735 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01005736 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005738 case MBEDTLS_PK_ECDSA:
5739 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01005740 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005741 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005742 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01005743 }
5744}
5745
Gilles Peskine449bd832023-01-11 14:50:10 +01005746mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005747{
Gilles Peskine449bd832023-01-11 14:50:10 +01005748 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005749#if defined(MBEDTLS_RSA_C)
5750 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005751 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005752#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02005753#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005754 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01005755 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005756#endif
5757 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005758 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005759 }
5760}
Valerio Settie9646ec2023-08-02 20:02:28 +02005761#endif /* MBEDTLS_PK_C &&
5762 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005763
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005764/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005765 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02005766 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005767mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005768{
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 switch (hash) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005770#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005771 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005772 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005773#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005774#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005775 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005776 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005777#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005778#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005779 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005780 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005781#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005782#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005783 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005784 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005785#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005786#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005787 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005788 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005789#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005790#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005791 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005792 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005793#endif
5794 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005795 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02005796 }
5797}
5798
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005799/*
5800 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
5801 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005802unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005803{
Gilles Peskine449bd832023-01-11 14:50:10 +01005804 switch (md) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01005805#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005806 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01005807 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005808#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01005809#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005810 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01005811 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005812#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01005813#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005814 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01005815 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02005816#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005817#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005818 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005820#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005821#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005822 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01005823 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02005824#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005825#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005826 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01005827 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005828#endif
5829 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005830 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005831 }
5832}
5833
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005834/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02005835 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02005836 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005837 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005838int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005839{
Manuel Pégourié-Gonnard6402c352025-01-14 12:23:56 +01005840 const uint16_t *group_list = ssl->conf->group_list;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005841
Gilles Peskine449bd832023-01-11 14:50:10 +01005842 if (group_list == NULL) {
5843 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01005844 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005845
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 for (; *group_list != 0; group_list++) {
5847 if (*group_list == tls_id) {
5848 return 0;
5849 }
5850 }
5851
5852 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01005853}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005854
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005855#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005856/*
5857 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
5858 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005859int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005860{
Gilles Peskine449bd832023-01-11 14:50:10 +01005861 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005862
Gilles Peskine449bd832023-01-11 14:50:10 +01005863 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005864 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005865 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07005866
Gilles Peskine449bd832023-01-11 14:50:10 +01005867 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01005868}
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01005869#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Valerio Setti67419f02023-01-04 16:12:42 +01005870
Valerio Setti18c9fed2022-12-30 17:44:24 +01005871static const struct {
5872 uint16_t tls_id;
5873 mbedtls_ecp_group_id ecp_group_id;
5874 psa_ecc_family_t psa_family;
5875 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01005876} tls_id_match_table[] =
5877{
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005878#if defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02005879 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005880#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005881#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02005882 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005883#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005884#if defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005885 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005886#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005887#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02005888 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005889#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005890#if defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005891 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005892#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005893#if defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005894 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005895#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005896#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02005897 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005898#endif
Elena Uziunaiteeaa0cf02024-07-04 17:41:25 +01005899#if defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02005900 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005901#endif
Elena Uziunaitea3632862024-07-04 13:52:43 +01005902#if defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005903 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005904#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01005905#if defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02005906 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005907#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005908#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02005909 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005910#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005911#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02005912 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005913#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02005914 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01005915};
5916
Gilles Peskine449bd832023-01-11 14:50:10 +01005917int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02005918 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01005919 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005920{
Gilles Peskine449bd832023-01-11 14:50:10 +01005921 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5922 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02005923 if (type != NULL) {
5924 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01005925 }
5926 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005927 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01005928 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005929 return PSA_SUCCESS;
5930 }
5931 }
5932
5933 return PSA_ERROR_NOT_SUPPORTED;
5934}
5935
Gilles Peskine449bd832023-01-11 14:50:10 +01005936mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005937{
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
5939 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005940 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005941 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005942 }
5943
5944 return MBEDTLS_ECP_DP_NONE;
5945}
5946
Gilles Peskine449bd832023-01-11 14:50:10 +01005947uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005948{
Gilles Peskine449bd832023-01-11 14:50:10 +01005949 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
5950 i++) {
5951 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01005952 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01005953 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005954 }
5955
5956 return 0;
5957}
5958
Valerio Setti67419f02023-01-04 16:12:42 +01005959#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02005960static const struct {
5961 uint16_t tls_id;
5962 const char *name;
5963} tls_id_curve_name_table[] =
5964{
Valerio Setti54e23792023-07-07 10:49:27 +02005965 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
5966 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
5967 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
5968 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
5969 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
5970 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
5971 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
5972 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
5973 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
5974 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
5975 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
5976 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
5977 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02005978 { 0, NULL },
5979};
5980
Gilles Peskine449bd832023-01-11 14:50:10 +01005981const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01005982{
Valerio Settiacd32c02023-06-29 18:06:29 +02005983 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
5984 if (tls_id_curve_name_table[i].tls_id == tls_id) {
5985 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01005986 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01005987 }
5988
5989 return NULL;
5990}
Valerio Setti67419f02023-01-04 16:12:42 +01005991#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01005992
Gilles Peskine449bd832023-01-11 14:50:10 +01005993int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
5994 const mbedtls_md_type_t md,
5995 unsigned char *dst,
5996 size_t dst_len,
5997 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08005998{
Ronald Cronf6893e12022-01-07 22:09:01 +01005999 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6000 psa_hash_operation_t *hash_operation_to_clone;
6001 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6002
Jerry Yu148165c2021-09-24 23:20:59 +08006003 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006004
Gilles Peskine449bd832023-01-11 14:50:10 +01006005 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006006#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006007 case MBEDTLS_MD_SHA384:
6008 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6009 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006010#endif
6011
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006012#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006013 case MBEDTLS_MD_SHA256:
6014 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6015 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006016#endif
6017
Gilles Peskine449bd832023-01-11 14:50:10 +01006018 default:
6019 goto exit;
6020 }
6021
6022 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6023 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006024 goto exit;
6025 }
6026
Gilles Peskine449bd832023-01-11 14:50:10 +01006027 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6028 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006029 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006030 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006031
6032exit:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006033#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006034 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006035 (void) ssl;
6036#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006037 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006038}
Jerry Yu24c0ec32021-09-09 14:21:07 +08006039
Ronald Crone68ab4f2022-10-05 12:46:29 +02006040#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006041/* mbedtls_ssl_parse_sig_alg_ext()
6042 *
6043 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6044 * value (TLS 1.3 RFC8446):
6045 * enum {
6046 * ....
6047 * ecdsa_secp256r1_sha256( 0x0403 ),
6048 * ecdsa_secp384r1_sha384( 0x0503 ),
6049 * ecdsa_secp521r1_sha512( 0x0603 ),
6050 * ....
6051 * } SignatureScheme;
6052 *
6053 * struct {
6054 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6055 * } SignatureSchemeList;
6056 *
6057 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6058 * value (TLS 1.2 RFC5246):
6059 * enum {
6060 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6061 * sha512(6), (255)
6062 * } HashAlgorithm;
6063 *
6064 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6065 * SignatureAlgorithm;
6066 *
6067 * struct {
6068 * HashAlgorithm hash;
6069 * SignatureAlgorithm signature;
6070 * } SignatureAndHashAlgorithm;
6071 *
6072 * SignatureAndHashAlgorithm
6073 * supported_signature_algorithms<2..2^16-2>;
6074 *
6075 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6076 * generalization of the TLS 1.2 signature algorithm extension.
6077 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6078 * `SignatureScheme` field of TLS 1.3
6079 *
6080 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006081int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6082 const unsigned char *buf,
6083 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006084{
6085 const unsigned char *p = buf;
6086 size_t supported_sig_algs_len = 0;
6087 const unsigned char *supported_sig_algs_end;
6088 uint16_t sig_alg;
6089 uint32_t common_idx = 0;
6090
Gilles Peskine449bd832023-01-11 14:50:10 +01006091 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6092 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006093 p += 2;
6094
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 memset(ssl->handshake->received_sig_algs, 0,
6096 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006097
Gilles Peskine449bd832023-01-11 14:50:10 +01006098 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006099 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006100 while (p < supported_sig_algs_end) {
6101 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6102 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006103 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006104 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6105 sig_alg,
6106 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006107#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006108 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6109 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6110 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006111 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006112 }
6113#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006114
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6116 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006117
Gilles Peskine449bd832023-01-11 14:50:10 +01006118 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006119 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6120 common_idx += 1;
6121 }
6122 }
6123 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006124 if (p != end) {
6125 MBEDTLS_SSL_DEBUG_MSG(1,
6126 ("Signature algorithms extension length misaligned"));
6127 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6128 MBEDTLS_ERR_SSL_DECODE_ERROR);
6129 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006130 }
6131
Gilles Peskine449bd832023-01-11 14:50:10 +01006132 if (common_idx == 0) {
6133 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6134 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6135 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6136 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006137 }
6138
Gabor Mezei15b95a62022-05-09 16:37:58 +02006139 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006140 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006141}
6142
Ronald Crone68ab4f2022-10-05 12:46:29 +02006143#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006144
Jerry Yudc7bd172022-02-17 13:44:15 +08006145#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6146
Jerry Yudc7bd172022-02-17 13:44:15 +08006147
Gilles Peskine449bd832023-01-11 14:50:10 +01006148static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6149 mbedtls_svc_key_id_t key,
6150 psa_algorithm_t alg,
6151 const unsigned char *raw_psk, size_t raw_psk_length,
6152 const unsigned char *seed, size_t seed_length,
6153 const unsigned char *label, size_t label_length,
6154 const unsigned char *other_secret,
6155 size_t other_secret_length,
6156 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006157{
6158 psa_status_t status;
6159
Gilles Peskine449bd832023-01-11 14:50:10 +01006160 status = psa_key_derivation_setup(derivation, alg);
6161 if (status != PSA_SUCCESS) {
6162 return status;
6163 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006164
Gilles Peskine449bd832023-01-11 14:50:10 +01006165 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6166 status = psa_key_derivation_input_bytes(derivation,
6167 PSA_KEY_DERIVATION_INPUT_SEED,
6168 seed, seed_length);
6169 if (status != PSA_SUCCESS) {
6170 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006171 }
6172
Gilles Peskine449bd832023-01-11 14:50:10 +01006173 if (other_secret != NULL) {
6174 status = psa_key_derivation_input_bytes(derivation,
6175 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6176 other_secret, other_secret_length);
6177 if (status != PSA_SUCCESS) {
6178 return status;
6179 }
6180 }
6181
6182 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006183 status = psa_key_derivation_input_bytes(
6184 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006185 raw_psk, raw_psk_length);
6186 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006187 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006188 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006189 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 if (status != PSA_SUCCESS) {
6191 return status;
6192 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006193
Gilles Peskine449bd832023-01-11 14:50:10 +01006194 status = psa_key_derivation_input_bytes(derivation,
6195 PSA_KEY_DERIVATION_INPUT_LABEL,
6196 label, label_length);
6197 if (status != PSA_SUCCESS) {
6198 return status;
6199 }
6200 } else {
6201 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006202 }
6203
Gilles Peskine449bd832023-01-11 14:50:10 +01006204 status = psa_key_derivation_set_capacity(derivation, capacity);
6205 if (status != PSA_SUCCESS) {
6206 return status;
6207 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006208
Gilles Peskine449bd832023-01-11 14:50:10 +01006209 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006210}
6211
Andrzej Kurek57d10632022-10-24 10:32:01 -04006212#if defined(PSA_WANT_ALG_SHA_384) || \
6213 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006214MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006215static int tls_prf_generic(mbedtls_md_type_t md_type,
6216 const unsigned char *secret, size_t slen,
6217 const char *label,
6218 const unsigned char *random, size_t rlen,
6219 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006220{
6221 psa_status_t status;
6222 psa_algorithm_t alg;
6223 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6224 psa_key_derivation_operation_t derivation =
6225 PSA_KEY_DERIVATION_OPERATION_INIT;
6226
Gilles Peskine449bd832023-01-11 14:50:10 +01006227 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006228 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006229 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006230 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006231 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006232
6233 /* Normally a "secret" should be long enough to be impossible to
6234 * find by brute force, and in particular should not be empty. But
6235 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6236 * and for this use case it makes sense to have a 0-length "secret".
6237 * Since the key API doesn't allow importing a key of length 0,
6238 * keep master_key=0, which setup_psa_key_derivation() understands
6239 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006240 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006241 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6243 psa_set_key_algorithm(&key_attributes, alg);
6244 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006245
Gilles Peskine449bd832023-01-11 14:50:10 +01006246 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6247 if (status != PSA_SUCCESS) {
6248 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6249 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006250 }
6251
Gilles Peskine449bd832023-01-11 14:50:10 +01006252 status = setup_psa_key_derivation(&derivation,
6253 master_key, alg,
6254 NULL, 0,
6255 random, rlen,
6256 (unsigned char const *) label,
6257 (size_t) strlen(label),
6258 NULL, 0,
6259 dlen);
6260 if (status != PSA_SUCCESS) {
6261 psa_key_derivation_abort(&derivation);
6262 psa_destroy_key(master_key);
6263 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006264 }
6265
Gilles Peskine449bd832023-01-11 14:50:10 +01006266 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6267 if (status != PSA_SUCCESS) {
6268 psa_key_derivation_abort(&derivation);
6269 psa_destroy_key(master_key);
6270 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006271 }
6272
Gilles Peskine449bd832023-01-11 14:50:10 +01006273 status = psa_key_derivation_abort(&derivation);
6274 if (status != PSA_SUCCESS) {
6275 psa_destroy_key(master_key);
6276 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006277 }
6278
Gilles Peskine449bd832023-01-11 14:50:10 +01006279 if (!mbedtls_svc_key_id_is_null(master_key)) {
6280 status = psa_destroy_key(master_key);
6281 }
6282 if (status != PSA_SUCCESS) {
6283 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6284 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006285
Gilles Peskine449bd832023-01-11 14:50:10 +01006286 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006287}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006288#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006289
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006290#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006291MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006292static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6293 const char *label,
6294 const unsigned char *random, size_t rlen,
6295 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006296{
Gilles Peskine449bd832023-01-11 14:50:10 +01006297 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6298 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006299}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006300#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006301
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006302#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006303MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006304static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6305 const char *label,
6306 const unsigned char *random, size_t rlen,
6307 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006308{
Gilles Peskine449bd832023-01-11 14:50:10 +01006309 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6310 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006311}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006312#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006313
Jerry Yuf009d862022-02-17 14:01:37 +08006314/*
6315 * Set appropriate PRF function and other SSL / TLS1.2 functions
6316 *
6317 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006318 * - hash associated with the ciphersuite (only used by TLS 1.2)
6319 *
6320 * Outputs:
6321 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6322 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006323MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006324static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6325 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006326{
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006327#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006328 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006329 handshake->tls_prf = tls_prf_sha384;
6330 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6331 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006332 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006333#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006334#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuf009d862022-02-17 14:01:37 +08006335 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006336 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006337 handshake->tls_prf = tls_prf_sha256;
6338 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6339 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6340 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006341#else
Jerry Yuf009d862022-02-17 14:01:37 +08006342 {
Jerry Yuf009d862022-02-17 14:01:37 +08006343 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006344 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006345 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006346 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006347#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006348
Gilles Peskine449bd832023-01-11 14:50:10 +01006349 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006350}
Jerry Yud6ab2352022-02-17 14:03:43 +08006351
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006352/*
6353 * Compute master secret if needed
6354 *
6355 * Parameters:
6356 * [in/out] handshake
6357 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6358 * (PSA-PSK) ciphersuite_info, psk_opaque
6359 * [out] premaster (cleared)
6360 * [out] master
6361 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6362 * debug: conf->f_dbg, conf->p_dbg
6363 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006364 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006365 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006366MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006367static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6368 unsigned char *master,
6369 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006370{
6371 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6372
6373 /* cf. RFC 5246, Section 8.1:
6374 * "The master secret is always exactly 48 bytes in length." */
6375 size_t const master_secret_len = 48;
6376
6377#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6378 unsigned char session_hash[48];
6379#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6380
6381 /* The label for the KDF used for key expansion.
6382 * This is either "master secret" or "extended master secret"
6383 * depending on whether the Extended Master Secret extension
6384 * is used. */
6385 char const *lbl = "master secret";
6386
Przemek Stekielae4ed302022-04-05 17:15:55 +02006387 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006388 * - If the Extended Master Secret extension is not used,
6389 * this is ClientHello.Random + ServerHello.Random
6390 * (see Sect. 8.1 in RFC 5246).
6391 * - If the Extended Master Secret extension is used,
6392 * this is the transcript of the handshake so far.
6393 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006394 unsigned char const *seed = handshake->randbytes;
6395 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006396
6397#if !defined(MBEDTLS_DEBUG_C) && \
6398 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006399 !defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006400 ssl = NULL; /* make sure we don't use it except for those cases */
6401 (void) ssl;
6402#endif
6403
Gilles Peskine449bd832023-01-11 14:50:10 +01006404 if (handshake->resume != 0) {
6405 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6406 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006407 }
6408
6409#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006410 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006411 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006412 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006413 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6414 if (ret != 0) {
6415 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6416 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006417
Gilles Peskine449bd832023-01-11 14:50:10 +01006418 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6419 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006420 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006421#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006422
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006423#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006424 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006425 /* Perform PSK-to-MS expansion in a single step. */
6426 psa_status_t status;
6427 psa_algorithm_t alg;
6428 mbedtls_svc_key_id_t psk;
6429 psa_key_derivation_operation_t derivation =
6430 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006431 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006432
Gilles Peskine449bd832023-01-11 14:50:10 +01006433 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006434
Gilles Peskine449bd832023-01-11 14:50:10 +01006435 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006436
Gilles Peskine449bd832023-01-11 14:50:10 +01006437 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006438 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006439 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006440 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006441 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006442
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006443 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006444 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02006445
Gilles Peskine449bd832023-01-11 14:50:10 +01006446 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006447 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02006448 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006449 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02006450 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02006451 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
6452 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
6453 other_secret = handshake->premaster + 2;
6454 break;
6455 default:
6456 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02006457 }
6458
Gilles Peskine449bd832023-01-11 14:50:10 +01006459 status = setup_psa_key_derivation(&derivation, psk, alg,
6460 ssl->conf->psk, ssl->conf->psk_len,
6461 seed, seed_len,
6462 (unsigned char const *) lbl,
6463 (size_t) strlen(lbl),
6464 other_secret, other_secret_len,
6465 master_secret_len);
6466 if (status != PSA_SUCCESS) {
6467 psa_key_derivation_abort(&derivation);
6468 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006469 }
6470
Gilles Peskine449bd832023-01-11 14:50:10 +01006471 status = psa_key_derivation_output_bytes(&derivation,
6472 master,
6473 master_secret_len);
6474 if (status != PSA_SUCCESS) {
6475 psa_key_derivation_abort(&derivation);
6476 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006477 }
6478
Gilles Peskine449bd832023-01-11 14:50:10 +01006479 status = psa_key_derivation_abort(&derivation);
6480 if (status != PSA_SUCCESS) {
6481 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6482 }
6483 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006484#endif
6485 {
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01006486#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006487 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02006488 psa_status_t status;
6489 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
6490 psa_key_derivation_operation_t derivation =
6491 PSA_KEY_DERIVATION_OPERATION_INIT;
6492
Gilles Peskine449bd832023-01-11 14:50:10 +01006493 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02006494
6495 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
6496
Gilles Peskine449bd832023-01-11 14:50:10 +01006497 status = psa_key_derivation_setup(&derivation, alg);
6498 if (status != PSA_SUCCESS) {
6499 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006500 }
6501
Gilles Peskine449bd832023-01-11 14:50:10 +01006502 status = psa_key_derivation_set_capacity(&derivation,
6503 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
6504 if (status != PSA_SUCCESS) {
6505 psa_key_derivation_abort(&derivation);
6506 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006507 }
6508
Gilles Peskine449bd832023-01-11 14:50:10 +01006509 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
6510 &derivation);
6511 if (status != PSA_SUCCESS) {
6512 psa_key_derivation_abort(&derivation);
6513 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006514 }
6515
Gilles Peskine449bd832023-01-11 14:50:10 +01006516 status = psa_key_derivation_output_bytes(&derivation,
6517 handshake->premaster,
6518 handshake->pmslen);
6519 if (status != PSA_SUCCESS) {
6520 psa_key_derivation_abort(&derivation);
6521 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6522 }
6523
6524 status = psa_key_derivation_abort(&derivation);
6525 if (status != PSA_SUCCESS) {
6526 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02006527 }
6528 }
6529#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006530 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
6531 lbl, seed, seed_len,
6532 master,
6533 master_secret_len);
6534 if (ret != 0) {
6535 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
6536 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006537 }
6538
Gilles Peskine449bd832023-01-11 14:50:10 +01006539 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
6540 handshake->premaster,
6541 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006542
Gilles Peskine449bd832023-01-11 14:50:10 +01006543 mbedtls_platform_zeroize(handshake->premaster,
6544 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006545 }
6546
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006548}
6549
Gilles Peskine449bd832023-01-11 14:50:10 +01006550int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08006551{
6552 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6553 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
6554 ssl->handshake->ciphersuite_info;
6555
Gilles Peskine449bd832023-01-11 14:50:10 +01006556 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006557
6558 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01006559 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01006560 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01006561 if (ret != 0) {
6562 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
6563 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006564 }
6565
6566 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01006567 ret = ssl_compute_master(ssl->handshake,
6568 ssl->session_negotiate->master,
6569 ssl);
6570 if (ret != 0) {
6571 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
6572 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006573 }
6574
6575 /* Swap the client and server random values:
6576 * - MS derivation wanted client+server (RFC 5246 8.1)
6577 * - key derivation wants server+client (RFC 5246 6.3) */
6578 {
6579 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01006580 memcpy(tmp, ssl->handshake->randbytes, 64);
6581 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
6582 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
6583 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08006584 }
6585
6586 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01006587 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
6588 ssl->session_negotiate->ciphersuite,
6589 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006590#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01006591 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02006592#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01006593 ssl->handshake->tls_prf,
6594 ssl->handshake->randbytes,
6595 ssl->tls_version,
6596 ssl->conf->endpoint,
6597 ssl);
6598 if (ret != 0) {
6599 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
6600 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08006601 }
6602
6603 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01006604 mbedtls_platform_zeroize(ssl->handshake->randbytes,
6605 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08006606
Gilles Peskine449bd832023-01-11 14:50:10 +01006607 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08006608
Gilles Peskine449bd832023-01-11 14:50:10 +01006609 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08006610}
Jerry Yu8392e0d2022-02-17 14:10:24 +08006611
Gilles Peskine449bd832023-01-11 14:50:10 +01006612int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006613{
Gilles Peskine449bd832023-01-11 14:50:10 +01006614 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006615#if defined(PSA_WANT_ALG_SHA_384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006616 case MBEDTLS_SSL_HASH_SHA384:
6617 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
6618 break;
6619#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006620#if defined(PSA_WANT_ALG_SHA_256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01006621 case MBEDTLS_SSL_HASH_SHA256:
6622 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
6623 break;
6624#endif
6625 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006626 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006627 }
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006628#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006629 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006630 (void) ssl;
6631#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006632 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01006633}
6634
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006635static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
6636 const psa_hash_operation_t *hs_op,
6637 size_t buffer_size,
6638 unsigned char *hash,
6639 size_t *hlen)
6640{
6641 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006642 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006643
6644#if !defined(MBEDTLS_DEBUG_C)
6645 (void) ssl;
6646#endif
6647 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006648 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006649 if (status != PSA_SUCCESS) {
6650 goto exit;
6651 }
6652
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006653 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006654 if (status != PSA_SUCCESS) {
6655 goto exit;
6656 }
6657
6658 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
6659 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
6660
6661exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02006662 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006663 return mbedtls_md_error_from_psa(status);
6664}
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006665
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006666#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006667int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
6668 unsigned char *hash,
6669 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08006670{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006671 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
6672 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08006673}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006674#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08006675
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006676#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01006677int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
6678 unsigned char *hash,
6679 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08006680{
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02006681 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
6682 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08006683}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006684#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08006685
Jerry Yuc2c673d2022-02-17 14:20:39 +08006686#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006687MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006688static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006689
6690#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006691int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08006692{
6693 /* If renegotiation is not enforced, retransmit until we would reach max
6694 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01006695 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006696 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
6697 unsigned char doublings = 1;
6698
Gilles Peskine449bd832023-01-11 14:50:10 +01006699 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08006700 ++doublings;
6701 ratio >>= 1;
6702 }
6703
Gilles Peskine449bd832023-01-11 14:50:10 +01006704 if (++ssl->renego_records_seen > doublings) {
6705 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
6706 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08006707 }
6708 }
6709
Gilles Peskine449bd832023-01-11 14:50:10 +01006710 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08006711}
6712#endif
6713#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08006714
Jerry Yud9526692022-02-17 14:23:47 +08006715/*
6716 * Handshake functions
6717 */
6718#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
6719/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01006720int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006721{
6722 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6723 ssl->handshake->ciphersuite_info;
6724
Gilles Peskine449bd832023-01-11 14:50:10 +01006725 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006726
Gilles Peskine449bd832023-01-11 14:50:10 +01006727 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6728 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006729 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006730 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006731 }
6732
Gilles Peskine449bd832023-01-11 14:50:10 +01006733 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6734 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006735}
6736
Gilles Peskine449bd832023-01-11 14:50:10 +01006737int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006738{
6739 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6740 ssl->handshake->ciphersuite_info;
6741
Gilles Peskine449bd832023-01-11 14:50:10 +01006742 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006743
Gilles Peskine449bd832023-01-11 14:50:10 +01006744 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6745 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006746 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006747 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006748 }
6749
Gilles Peskine449bd832023-01-11 14:50:10 +01006750 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
6751 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006752}
6753
6754#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
6755/* Some certificate support -> implement write and parse */
6756
Gilles Peskine449bd832023-01-11 14:50:10 +01006757int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08006758{
6759 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
6760 size_t i, n;
6761 const mbedtls_x509_crt *crt;
6762 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
6763 ssl->handshake->ciphersuite_info;
6764
Gilles Peskine449bd832023-01-11 14:50:10 +01006765 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006766
Gilles Peskine449bd832023-01-11 14:50:10 +01006767 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
6768 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006769 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006770 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006771 }
6772
6773#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006774 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
6775 if (ssl->handshake->client_auth == 0) {
6776 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Gilles Peskinef670ba52025-03-07 15:09:32 +01006777 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01006778 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08006779 }
6780 }
6781#endif /* MBEDTLS_SSL_CLI_C */
6782#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006783 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
6784 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006785 /* Should never happen because we shouldn't have picked the
6786 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006787 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006788 }
6789 }
6790#endif
6791
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08006793
6794 /*
6795 * 0 . 0 handshake type
6796 * 1 . 3 handshake length
6797 * 4 . 6 length of all certs
6798 * 7 . 9 length of cert. 1
6799 * 10 . n-1 peer certificate
6800 * n . n+2 length of cert. 2
6801 * n+3 . ... upper level cert, etc.
6802 */
6803 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01006804 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006805
Gilles Peskine449bd832023-01-11 14:50:10 +01006806 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08006807 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006808 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
6809 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
6810 " > %" MBEDTLS_PRINTF_SIZET,
6811 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
6812 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08006813 }
6814
Gilles Peskine449bd832023-01-11 14:50:10 +01006815 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
6816 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
6817 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08006818
Gilles Peskine449bd832023-01-11 14:50:10 +01006819 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08006820 i += n; crt = crt->next;
6821 }
6822
Gilles Peskine449bd832023-01-11 14:50:10 +01006823 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
6824 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
6825 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08006826
6827 ssl->out_msglen = i;
6828 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
6829 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
6830
Gilles Peskinef670ba52025-03-07 15:09:32 +01006831 mbedtls_ssl_handshake_increment_state(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006832
Gilles Peskine449bd832023-01-11 14:50:10 +01006833 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
6834 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
6835 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006836 }
6837
Gilles Peskine449bd832023-01-11 14:50:10 +01006838 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08006839
Gilles Peskine449bd832023-01-11 14:50:10 +01006840 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08006841}
6842
6843#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
6844
6845#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006846MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006847static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6848 unsigned char *crt_buf,
6849 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006850{
6851 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
6852
Gilles Peskine449bd832023-01-11 14:50:10 +01006853 if (peer_crt == NULL) {
6854 return -1;
6855 }
Jerry Yud9526692022-02-17 14:23:47 +08006856
Gilles Peskine449bd832023-01-11 14:50:10 +01006857 if (peer_crt->raw.len != crt_buf_len) {
6858 return -1;
6859 }
Jerry Yud9526692022-02-17 14:23:47 +08006860
Gilles Peskine449bd832023-01-11 14:50:10 +01006861 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08006862}
6863#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006864MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006865static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
6866 unsigned char *crt_buf,
6867 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08006868{
6869 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6870 unsigned char const * const peer_cert_digest =
6871 ssl->session->peer_cert_digest;
6872 mbedtls_md_type_t const peer_cert_digest_type =
6873 ssl->session->peer_cert_digest_type;
6874 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01006875 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08006876 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
6877 size_t digest_len;
6878
Gilles Peskine449bd832023-01-11 14:50:10 +01006879 if (peer_cert_digest == NULL || digest_info == NULL) {
6880 return -1;
6881 }
Jerry Yud9526692022-02-17 14:23:47 +08006882
Gilles Peskine449bd832023-01-11 14:50:10 +01006883 digest_len = mbedtls_md_get_size(digest_info);
6884 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
6885 return -1;
6886 }
Jerry Yud9526692022-02-17 14:23:47 +08006887
Gilles Peskine449bd832023-01-11 14:50:10 +01006888 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
6889 if (ret != 0) {
6890 return -1;
6891 }
Jerry Yud9526692022-02-17 14:23:47 +08006892
Gilles Peskine449bd832023-01-11 14:50:10 +01006893 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08006894}
6895#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
6896#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
6897
6898/*
6899 * Once the certificate message is read, parse it into a cert chain and
6900 * perform basic checks, but leave actual verification to the caller
6901 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006902MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006903static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
6904 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08006905{
6906 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6907#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006908 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08006909#endif
6910 size_t i, n;
6911 uint8_t alert;
6912
Gilles Peskine449bd832023-01-11 14:50:10 +01006913 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
6914 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6915 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6916 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6917 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006918 }
6919
Gilles Peskine449bd832023-01-11 14:50:10 +01006920 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
6921 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6922 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
6923 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08006924 }
6925
Gilles Peskine449bd832023-01-11 14:50:10 +01006926 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
6927 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6928 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6929 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6930 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006931 }
6932
Gilles Peskine449bd832023-01-11 14:50:10 +01006933 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08006934
6935 /*
6936 * Same message structure as in mbedtls_ssl_write_certificate()
6937 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006938 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006939
Gilles Peskine449bd832023-01-11 14:50:10 +01006940 if (ssl->in_msg[i] != 0 ||
6941 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
6942 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6943 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6944 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6945 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006946 }
6947
6948 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
6949 i += 3;
6950
6951 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006952 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08006953 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006954 if (i + 3 > ssl->in_hslen) {
6955 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6956 mbedtls_ssl_send_alert_message(ssl,
6957 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6958 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6959 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006960 }
6961 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
6962 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006963 if (ssl->in_msg[i] != 0) {
6964 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6965 mbedtls_ssl_send_alert_message(ssl,
6966 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6967 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
6968 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08006969 }
6970
6971 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00006972 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08006973 i += 3;
6974
Gilles Peskine449bd832023-01-11 14:50:10 +01006975 if (n < 128 || i + n > ssl->in_hslen) {
6976 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
6977 mbedtls_ssl_send_alert_message(ssl,
6978 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6979 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
6980 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08006981 }
6982
6983 /* Check if we're handling the first CRT in the chain. */
6984#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006985 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08006986 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01006987 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08006988 /* During client-side renegotiation, check that the server's
6989 * end-CRTs hasn't changed compared to the initial handshake,
6990 * mitigating the triple handshake attack. On success, reuse
6991 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006992 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
6993 if (ssl_check_peer_crt_unchanged(ssl,
6994 &ssl->in_msg[i],
6995 n) != 0) {
6996 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
6997 mbedtls_ssl_send_alert_message(ssl,
6998 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
6999 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7000 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007001 }
7002
7003 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007004 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007005 }
7006#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7007
7008 /* Parse the next certificate in the chain. */
7009#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007010 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007011#else
7012 /* If we don't need to store the CRT chain permanently, parse
7013 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007014 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007015#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007016 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007017 case 0: /*ok*/
Gilles Peskinea7e14dc2024-09-16 13:10:11 +02007018 case MBEDTLS_ERR_OID_NOT_FOUND:
Jerry Yud9526692022-02-17 14:23:47 +08007019 /* Ignore certificate with an unknown algorithm: maybe a
7020 prior certificate was already trusted. */
7021 break;
7022
7023 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7024 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7025 goto crt_parse_der_failed;
7026
7027 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7028 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7029 goto crt_parse_der_failed;
7030
7031 default:
7032 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007033crt_parse_der_failed:
7034 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7035 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7036 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007037 }
7038
7039 i += n;
7040 }
7041
Gilles Peskine449bd832023-01-11 14:50:10 +01007042 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7043 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007044}
7045
7046#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007047MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007048static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007049{
Gilles Peskine449bd832023-01-11 14:50:10 +01007050 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7051 return -1;
7052 }
Jerry Yud9526692022-02-17 14:23:47 +08007053
Gilles Peskine449bd832023-01-11 14:50:10 +01007054 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007055 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7056 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007057 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7058 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7059 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007060 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007061 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007062}
7063#endif /* MBEDTLS_SSL_SRV_C */
7064
7065/* Check if a certificate message is expected.
7066 * Return either
7067 * - SSL_CERTIFICATE_EXPECTED, or
7068 * - SSL_CERTIFICATE_SKIP
7069 * indicating whether a Certificate message is expected or not.
7070 */
7071#define SSL_CERTIFICATE_EXPECTED 0
7072#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007073MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007074static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7075 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007076{
7077 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7078 ssl->handshake->ciphersuite_info;
7079
Gilles Peskine449bd832023-01-11 14:50:10 +01007080 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7081 return SSL_CERTIFICATE_SKIP;
7082 }
Jerry Yud9526692022-02-17 14:23:47 +08007083
7084#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007085 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007086 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007087 ssl->session_negotiate->verify_result =
7088 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007089 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007090 }
7091 }
7092#else
7093 ((void) authmode);
7094#endif /* MBEDTLS_SSL_SRV_C */
7095
Gilles Peskine449bd832023-01-11 14:50:10 +01007096 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007097}
7098
Jerry Yud9526692022-02-17 14:23:47 +08007099#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007100MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007101static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7102 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007103{
7104 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7105 /* Remember digest of the peer's end-CRT. */
7106 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007107 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7108 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7109 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7110 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7111 mbedtls_ssl_send_alert_message(ssl,
7112 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7113 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007114
Gilles Peskine449bd832023-01-11 14:50:10 +01007115 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007116 }
7117
Gilles Peskine449bd832023-01-11 14:50:10 +01007118 ret = mbedtls_md(mbedtls_md_info_from_type(
7119 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7120 start, len,
7121 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007122
7123 ssl->session_negotiate->peer_cert_digest_type =
7124 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7125 ssl->session_negotiate->peer_cert_digest_len =
7126 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7127
Gilles Peskine449bd832023-01-11 14:50:10 +01007128 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007129}
7130
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007131MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007132static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7133 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007134{
7135 unsigned char *end = start + len;
7136 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7137
7138 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007139 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7140 ret = mbedtls_pk_parse_subpubkey(&start, end,
7141 &ssl->handshake->peer_pubkey);
7142 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007143 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007144 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007145 }
7146
Gilles Peskine449bd832023-01-11 14:50:10 +01007147 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007148}
7149#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7150
Gilles Peskine449bd832023-01-11 14:50:10 +01007151int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007152{
7153 int ret = 0;
7154 int crt_expected;
Manuel Pégourié-Gonnard58ab9ba2024-08-14 09:47:38 +02007155 /* Authmode: precedence order is SNI if used else configuration */
Jerry Yud9526692022-02-17 14:23:47 +08007156#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7157 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7158 ? ssl->handshake->sni_authmode
7159 : ssl->conf->authmode;
7160#else
7161 const int authmode = ssl->conf->authmode;
7162#endif
7163 void *rs_ctx = NULL;
7164 mbedtls_x509_crt *chain = NULL;
7165
Gilles Peskine449bd832023-01-11 14:50:10 +01007166 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007167
Gilles Peskine449bd832023-01-11 14:50:10 +01007168 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7169 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7170 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007171 goto exit;
7172 }
7173
7174#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007175 if (ssl->handshake->ecrs_enabled &&
7176 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007177 chain = ssl->handshake->ecrs_peer_cert;
7178 ssl->handshake->ecrs_peer_cert = NULL;
7179 goto crt_verify;
7180 }
7181#endif
7182
Gilles Peskine449bd832023-01-11 14:50:10 +01007183 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007184 /* mbedtls_ssl_read_record may have sent an alert already. We
7185 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007186 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007187 goto exit;
7188 }
7189
7190#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007191 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007192 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7193
Gilles Peskine449bd832023-01-11 14:50:10 +01007194 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007195 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007196 }
Jerry Yud9526692022-02-17 14:23:47 +08007197
7198 goto exit;
7199 }
7200#endif /* MBEDTLS_SSL_SRV_C */
7201
7202 /* Clear existing peer CRT structure in case we tried to
7203 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007204 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007205
Gilles Peskine449bd832023-01-11 14:50:10 +01007206 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7207 if (chain == NULL) {
7208 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7209 sizeof(mbedtls_x509_crt)));
7210 mbedtls_ssl_send_alert_message(ssl,
7211 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7212 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007213
7214 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7215 goto exit;
7216 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007217 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007218
Gilles Peskine449bd832023-01-11 14:50:10 +01007219 ret = ssl_parse_certificate_chain(ssl, chain);
7220 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007221 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007222 }
Jerry Yud9526692022-02-17 14:23:47 +08007223
7224#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007225 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007226 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007227 }
Jerry Yud9526692022-02-17 14:23:47 +08007228
7229crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007230 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007231 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007232 }
Jerry Yud9526692022-02-17 14:23:47 +08007233#endif
7234
Manuel Pégourié-Gonnard19dd9f52024-08-16 11:03:42 +02007235 ret = mbedtls_ssl_verify_certificate(ssl, authmode, chain,
7236 ssl->handshake->ciphersuite_info,
7237 rs_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +01007238 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007239 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007240 }
Jerry Yud9526692022-02-17 14:23:47 +08007241
7242#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7243 {
7244 unsigned char *crt_start, *pk_start;
7245 size_t crt_len, pk_len;
7246
7247 /* We parse the CRT chain without copying, so
7248 * these pointers point into the input buffer,
7249 * and are hence still valid after freeing the
7250 * CRT chain. */
7251
7252 crt_start = chain->raw.p;
7253 crt_len = chain->raw.len;
7254
7255 pk_start = chain->pk_raw.p;
7256 pk_len = chain->pk_raw.len;
7257
7258 /* Free the CRT structures before computing
7259 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007260 mbedtls_x509_crt_free(chain);
7261 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007262 chain = NULL;
7263
Gilles Peskine449bd832023-01-11 14:50:10 +01007264 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
7265 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007266 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007267 }
Jerry Yud9526692022-02-17 14:23:47 +08007268
Gilles Peskine449bd832023-01-11 14:50:10 +01007269 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
7270 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007271 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007272 }
Jerry Yud9526692022-02-17 14:23:47 +08007273 }
7274#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7275 /* Pass ownership to session structure. */
7276 ssl->session_negotiate->peer_cert = chain;
7277 chain = NULL;
7278#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7279
Gilles Peskine449bd832023-01-11 14:50:10 +01007280 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007281
7282exit:
7283
Gilles Peskine449bd832023-01-11 14:50:10 +01007284 if (ret == 0) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007285 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007286 }
Jerry Yud9526692022-02-17 14:23:47 +08007287
7288#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007289 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007290 ssl->handshake->ecrs_peer_cert = chain;
7291 chain = NULL;
7292 }
7293#endif
7294
Gilles Peskine449bd832023-01-11 14:50:10 +01007295 if (chain != NULL) {
7296 mbedtls_x509_crt_free(chain);
7297 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007298 }
7299
Gilles Peskine449bd832023-01-11 14:50:10 +01007300 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007301}
7302#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7303
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007304static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
7305 unsigned char *padbuf, size_t hlen,
7306 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007307{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007308 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007309 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007310 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007311 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007312 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007313 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007314
7315 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01007316 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08007317 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01007318 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08007319
Gilles Peskine449bd832023-01-11 14:50:10 +01007320 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08007321 ? "client finished"
7322 : "server finished";
7323
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007324 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08007325
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007326 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01007327 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007328 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007329 }
7330
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007331 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007332 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007333 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08007334 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007335 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007336
7337 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
7338
Jerry Yu615bd6f2022-02-17 14:25:15 +08007339 /*
7340 * TLSv1.2:
7341 * hash = PRF( master, finished_label,
7342 * Hash( handshake ) )[0.11]
7343 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007344 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007345 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007346
Gilles Peskine449bd832023-01-11 14:50:10 +01007347 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007348
Paul Elliottecb95be2023-08-11 16:41:04 +01007349 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007350
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007351 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01007352
7353exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007354 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02007355 return mbedtls_md_error_from_psa(status);
Jerry Yu615bd6f2022-02-17 14:25:15 +08007356}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007357
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007358#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007359static int ssl_calc_finished_tls_sha256(
7360 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
7361{
7362 unsigned char padbuf[32];
7363 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007364 &ssl->handshake->fin_sha256_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007365 padbuf, sizeof(padbuf),
7366 buf, from);
7367}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007368#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08007369
Jerry Yub7ba49e2022-02-17 14:25:53 +08007370
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007371#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007372static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01007373 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08007374{
Jerry Yub7ba49e2022-02-17 14:25:53 +08007375 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007376 return ssl_calc_finished_tls_generic(ssl,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007377 &ssl->handshake->fin_sha384_psa,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02007378 padbuf, sizeof(padbuf),
7379 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08007380}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007381#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08007382
Gilles Peskine449bd832023-01-11 14:50:10 +01007383void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08007384{
Gilles Peskine449bd832023-01-11 14:50:10 +01007385 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007386
7387 /*
7388 * Free our handshake params
7389 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007390 mbedtls_ssl_handshake_free(ssl);
7391 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08007392 ssl->handshake = NULL;
7393
7394 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08007395 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08007396 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007397 if (ssl->transform) {
7398 mbedtls_ssl_transform_free(ssl->transform);
7399 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08007400 }
7401 ssl->transform = ssl->transform_negotiate;
7402 ssl->transform_negotiate = NULL;
7403
Gilles Peskine449bd832023-01-11 14:50:10 +01007404 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08007405}
7406
Gilles Peskine449bd832023-01-11 14:50:10 +01007407void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08007408{
7409 int resume = ssl->handshake->resume;
7410
Gilles Peskine449bd832023-01-11 14:50:10 +01007411 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007412
7413#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007414 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007415 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
7416 ssl->renego_records_seen = 0;
7417 }
7418#endif
7419
7420 /*
7421 * Free the previous session and switch in the current one
7422 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007423 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007424#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
7425 /* RFC 7366 3.1: keep the EtM state */
7426 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01007427 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08007428#endif
7429
Gilles Peskine449bd832023-01-11 14:50:10 +01007430 mbedtls_ssl_session_free(ssl->session);
7431 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007432 }
7433 ssl->session = ssl->session_negotiate;
7434 ssl->session_negotiate = NULL;
7435
7436 /*
7437 * Add cache entry
7438 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007439 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08007440 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007441 resume == 0) {
7442 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
7443 ssl->session->id,
7444 ssl->session->id_len,
7445 ssl->session) != 0) {
7446 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
7447 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08007448 }
7449
7450#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007451 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7452 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08007453 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01007454 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007455
7456 /* Keep last flight around in case we need to resend it:
7457 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01007458 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
7459 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08007460#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007461 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007462
Gilles Peskinef670ba52025-03-07 15:09:32 +01007463 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yu2a9fff52022-02-17 14:28:51 +08007464
Gilles Peskine449bd832023-01-11 14:50:10 +01007465 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08007466}
7467
Gilles Peskine449bd832023-01-11 14:50:10 +01007468int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007469{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00007470 int ret;
7471 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007472
Gilles Peskine449bd832023-01-11 14:50:10 +01007473 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007474
Gilles Peskine449bd832023-01-11 14:50:10 +01007475 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007476
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007477 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
7478 if (ret != 0) {
7479 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
David Horstmann816b7122025-03-07 17:20:59 +00007480 return ret;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007481 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007482
7483 /*
7484 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
7485 * may define some other value. Currently (early 2016), no defined
7486 * ciphersuite does this (and this is unlikely to change as activity has
7487 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
7488 */
7489 hash_len = 12;
7490
7491#if defined(MBEDTLS_SSL_RENEGOTIATION)
7492 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007493 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007494#endif
7495
7496 ssl->out_msglen = 4 + hash_len;
7497 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7498 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
7499
7500 /*
7501 * In case of session resuming, invert the client and server
7502 * ChangeCipherSpec messages order.
7503 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007505#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007506 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007507 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
Gilles Peskine449bd832023-01-11 14:50:10 +01007508 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007509#endif
7510#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007511 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007512 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC);
Gilles Peskine449bd832023-01-11 14:50:10 +01007513 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007514#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007515 } else {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007516 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007517 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007518
7519 /*
7520 * Switch to our negotiated transform and session parameters for outbound
7521 * data.
7522 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007523 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007524
7525#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007526 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007527 unsigned char i;
7528
7529 /* Remember current epoch settings for resending */
7530 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01007531 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
7532 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007533
7534 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007536
7537
7538 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01007539 for (i = 2; i > 0; i--) {
7540 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007541 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01007542 }
7543 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007544
7545 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01007546 if (i == 0) {
7547 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
7548 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007549 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007550 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007551#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01007552 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007553
7554 ssl->transform_out = ssl->transform_negotiate;
7555 ssl->session_out = ssl->session_negotiate;
7556
7557#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007558 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7559 mbedtls_ssl_send_flight_completed(ssl);
7560 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007561#endif
7562
Gilles Peskine449bd832023-01-11 14:50:10 +01007563 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7564 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7565 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007566 }
7567
7568#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007569 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
7570 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
7571 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
7572 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007573 }
7574#endif
7575
Gilles Peskine449bd832023-01-11 14:50:10 +01007576 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007577
Gilles Peskine449bd832023-01-11 14:50:10 +01007578 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08007579}
7580
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007581#define SSL_MAX_HASH_LEN 12
7582
Gilles Peskine449bd832023-01-11 14:50:10 +01007583int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007584{
7585 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7586 unsigned int hash_len = 12;
7587 unsigned char buf[SSL_MAX_HASH_LEN];
7588
Gilles Peskine449bd832023-01-11 14:50:10 +01007589 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007590
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007591 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
7592 if (ret != 0) {
7593 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
David Horstmann816b7122025-03-07 17:20:59 +00007594 return ret;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007595 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007596
Gilles Peskine449bd832023-01-11 14:50:10 +01007597 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
7598 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007599 goto exit;
7600 }
7601
Gilles Peskine449bd832023-01-11 14:50:10 +01007602 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7603 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7604 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7605 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007606 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7607 goto exit;
7608 }
7609
Gilles Peskine449bd832023-01-11 14:50:10 +01007610 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
7611 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7612 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007613 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
7614 goto exit;
7615 }
7616
Gilles Peskine449bd832023-01-11 14:50:10 +01007617 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
7618 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7619 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7620 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007621 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
7622 goto exit;
7623 }
7624
Gilles Peskine449bd832023-01-11 14:50:10 +01007625 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
7626 buf, hash_len) != 0) {
7627 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
7628 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7629 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007630 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
7631 goto exit;
7632 }
7633
7634#if defined(MBEDTLS_SSL_RENEGOTIATION)
7635 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007636 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007637#endif
7638
Gilles Peskine449bd832023-01-11 14:50:10 +01007639 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007640#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007641 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007642 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC);
Gilles Peskine449bd832023-01-11 14:50:10 +01007643 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007644#endif
7645#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007646 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007647 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
Gilles Peskine449bd832023-01-11 14:50:10 +01007648 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007649#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007650 } else {
Gilles Peskinef670ba52025-03-07 15:09:32 +01007651 mbedtls_ssl_handshake_increment_state(ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01007652 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007653
7654#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007655 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
7656 mbedtls_ssl_recv_flight_completed(ssl);
7657 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007658#endif
7659
Gilles Peskine449bd832023-01-11 14:50:10 +01007660 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007661
7662exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007663 mbedtls_platform_zeroize(buf, hash_len);
7664 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08007665}
7666
Jerry Yu392112c2022-02-17 14:34:10 +08007667#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
7668/*
7669 * Helper to get TLS 1.2 PRF from ciphersuite
7670 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
7671 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007672static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08007673{
Jerry Yu392112c2022-02-17 14:34:10 +08007674 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007675 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007676#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007677 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
7678 return tls_prf_sha384;
7679 } else
Jerry Yu392112c2022-02-17 14:34:10 +08007680#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007681#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007682 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007683 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
7684 return tls_prf_sha256;
7685 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04007686 }
7687#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007688#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007689 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04007690 (void) ciphersuite_info;
7691#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007692
Gilles Peskine449bd832023-01-11 14:50:10 +01007693 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08007694}
7695#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08007696
Gilles Peskine449bd832023-01-11 14:50:10 +01007697static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08007698{
7699 ((void) tls_prf);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007700#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01007701 if (tls_prf == tls_prf_sha384) {
7702 return MBEDTLS_SSL_TLS_PRF_SHA384;
7703 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007704#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007705#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01007706 if (tls_prf == tls_prf_sha256) {
7707 return MBEDTLS_SSL_TLS_PRF_SHA256;
7708 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08007709#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007710 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08007711}
7712
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007713/*
7714 * Populate a transform structure with session keys and all the other
7715 * necessary information.
7716 *
7717 * Parameters:
7718 * - [in/out]: transform: structure to populate
7719 * [in] must be just initialised with mbedtls_ssl_transform_init()
7720 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
7721 * - [in] ciphersuite
7722 * - [in] master
7723 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007724 * - [in] tls_prf: pointer to PRF to use for key derivation
7725 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04007726 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007727 * - [in] endpoint: client or server
7728 * - [in] ssl: used for:
7729 * - ssl->conf->{f,p}_export_keys
7730 * [in] optionally used for:
7731 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
7732 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007733MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007734static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
7735 int ciphersuite,
7736 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007737#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007738 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007739#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007740 ssl_tls_prf_t tls_prf,
7741 const unsigned char randbytes[64],
7742 mbedtls_ssl_protocol_version tls_version,
7743 unsigned endpoint,
7744 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007745{
7746 int ret = 0;
7747 unsigned char keyblk[256];
7748 unsigned char *key1;
7749 unsigned char *key2;
7750 unsigned char *mac_enc;
7751 unsigned char *mac_dec;
7752 size_t mac_key_len = 0;
7753 size_t iv_copy_len;
7754 size_t keylen;
7755 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007756 mbedtls_ssl_mode_t ssl_mode;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007757
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007758 psa_key_type_t key_type;
7759 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
7760 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01007761 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007762 size_t key_bits;
7763 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007764
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007765 /*
7766 * Some data just needs copying into the structure
7767 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007768#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007769 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007770#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04007771 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007772
7773#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007774 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007775#endif
7776
7777#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01007778 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007779 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
7780 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007781 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007782 }
7783#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
7784
7785 /*
7786 * Get various info structures
7787 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007788 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
7789 if (ciphersuite_info == NULL) {
7790 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
7791 ciphersuite));
7792 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007793 }
7794
Neil Armstrongab555e02022-04-04 11:07:59 +02007795 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007796#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007797 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007798#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007799 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007800
Gilles Peskine449bd832023-01-11 14:50:10 +01007801 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007802 transform->taglen =
7803 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01007804 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007805
Dave Rodgman2eab4622023-10-05 13:30:37 +01007806 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01007807 transform->taglen,
7808 &alg,
7809 &key_type,
7810 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05007811 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01007812 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007813 goto end;
7814 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007815
Dave Rodgman2eab4622023-10-05 13:30:37 +01007816 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007817 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02007818 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01007819 (unsigned) ciphersuite_info->mac));
7820 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01007821 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007822
7823#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
7824 /* Copy own and peer's CID if the use of the CID
7825 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007826 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
7827 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007828
7829 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007830 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
7831 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
7832 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007833
7834 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007835 memcpy(transform->out_cid, ssl->handshake->peer_cid,
7836 ssl->handshake->peer_cid_len);
7837 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
7838 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007839 }
7840#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
7841
7842 /*
7843 * Compute key block using the PRF
7844 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007845 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
7846 if (ret != 0) {
7847 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7848 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007849 }
7850
Gilles Peskine449bd832023-01-11 14:50:10 +01007851 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
7852 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
7853 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
7854 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
7855 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007856
7857 /*
7858 * Determine the appropriate key, IV and MAC length.
7859 */
7860
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007861 keylen = PSA_BITS_TO_BYTES(key_bits);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007862
Valerio Settie5707042023-10-11 11:54:42 +02007863#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01007864 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007865 size_t explicit_ivlen;
7866
7867 transform->maclen = 0;
7868 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007869
7870 /* All modes haves 96-bit IVs, but the length of the static parts vary
7871 * with mode and version:
7872 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
7873 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
7874 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
7875 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
7876 * sequence number).
7877 */
7878 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01007879
7880 int is_chachapoly = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007881 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
David Horstmann3b2276a2022-10-06 14:49:08 +01007882
Gilles Peskine449bd832023-01-11 14:50:10 +01007883 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007884 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01007885 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007886 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01007887 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007888
7889 /* Minimum length of encrypted record */
7890 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
7891 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007892 } else
Valerio Settie5707042023-10-11 11:54:42 +02007893#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007894#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007895 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02007896 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01007897 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007898 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02007899
Neil Armstronge4512952022-03-08 09:08:22 +01007900 /* Get MAC length */
7901 mac_key_len = PSA_HASH_LENGTH(mac_alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007902 transform->maclen = mac_key_len;
7903
7904 /* IV length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007905 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007906
7907 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01007908 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007909 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007910 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007911 /*
7912 * GenericBlockCipher:
7913 * 1. if EtM is in use: one block plus MAC
7914 * otherwise: * first multiple of blocklen greater than maclen
7915 * 2. IV
7916 */
7917#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01007918 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007919 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007920 + block_size;
7921 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007922#endif
7923 {
7924 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01007925 + block_size
7926 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007927 }
7928
Gilles Peskine449bd832023-01-11 14:50:10 +01007929 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007930 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01007931 } else {
7932 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007933 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7934 goto end;
7935 }
7936 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007937 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007938#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
7939 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007940 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7941 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007942 }
7943
Gilles Peskine449bd832023-01-11 14:50:10 +01007944 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
7945 (unsigned) keylen,
7946 (unsigned) transform->minlen,
7947 (unsigned) transform->ivlen,
7948 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007949
7950 /*
7951 * Finally setup the cipher contexts, IVs and MAC secrets.
7952 */
7953#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007954 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007955 key1 = keyblk + mac_key_len * 2;
7956 key2 = keyblk + mac_key_len * 2 + keylen;
7957
7958 mac_enc = keyblk;
7959 mac_dec = keyblk + mac_key_len;
7960
Gilles Peskine449bd832023-01-11 14:50:10 +01007961 iv_copy_len = (transform->fixed_ivlen) ?
7962 transform->fixed_ivlen : transform->ivlen;
7963 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
7964 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
7965 iv_copy_len);
7966 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007967#endif /* MBEDTLS_SSL_CLI_C */
7968#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007969 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007970 key1 = keyblk + mac_key_len * 2 + keylen;
7971 key2 = keyblk + mac_key_len * 2;
7972
7973 mac_enc = keyblk + mac_key_len;
7974 mac_dec = keyblk;
7975
Gilles Peskine449bd832023-01-11 14:50:10 +01007976 iv_copy_len = (transform->fixed_ivlen) ?
7977 transform->fixed_ivlen : transform->ivlen;
7978 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
7979 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
7980 iv_copy_len);
7981 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007982#endif /* MBEDTLS_SSL_SRV_C */
7983 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007984 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007985 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
7986 goto end;
7987 }
7988
Paul Elliott4fb19552023-10-18 12:15:30 +01007989 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007990 ssl->f_export_keys(ssl->p_export_keys,
7991 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
7992 master, 48,
7993 randbytes + 32,
7994 randbytes,
7995 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007996 }
7997
Jerry Yu9bccc4c2022-02-17 14:38:28 +08007998 transform->psa_alg = alg;
7999
Gilles Peskine449bd832023-01-11 14:50:10 +01008000 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8001 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8002 psa_set_key_algorithm(&attributes, alg);
8003 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008004
Gilles Peskine449bd832023-01-11 14:50:10 +01008005 if ((status = psa_import_key(&attributes,
8006 key1,
8007 PSA_BITS_TO_BYTES(key_bits),
8008 &transform->psa_key_enc)) != PSA_SUCCESS) {
8009 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008010 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008011 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008012 goto end;
8013 }
8014
Gilles Peskine449bd832023-01-11 14:50:10 +01008015 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008016
Gilles Peskine449bd832023-01-11 14:50:10 +01008017 if ((status = psa_import_key(&attributes,
8018 key2,
8019 PSA_BITS_TO_BYTES(key_bits),
8020 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008021 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008022 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008023 goto end;
8024 }
8025 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008026
Neil Armstrong29c0c042022-03-17 17:47:28 +01008027#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8028 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8029 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008030 if (mac_key_len != 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008031 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008032
Gilles Peskine449bd832023-01-11 14:50:10 +01008033 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8034 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8035 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008036
Gilles Peskine449bd832023-01-11 14:50:10 +01008037 if ((status = psa_import_key(&attributes,
8038 mac_enc, mac_key_len,
8039 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008040 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008041 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008042 goto end;
8043 }
8044
Gilles Peskine449bd832023-01-11 14:50:10 +01008045 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8046 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008047#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008048 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008049#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008050 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008051 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008052 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8053 PSA_KEY_USAGE_VERIFY_HASH);
8054 } else {
8055 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8056 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008057
Gilles Peskine449bd832023-01-11 14:50:10 +01008058 if ((status = psa_import_key(&attributes,
8059 mac_dec, mac_key_len,
8060 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008061 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008062 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008063 goto end;
8064 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008065 }
8066#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8067
8068 ((void) mac_dec);
8069 ((void) mac_enc);
8070
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008071end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008072 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8073 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008074}
8075
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008076#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008077int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008078 psa_pake_operation_t *pake_ctx,
8079 const unsigned char *buf,
8080 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008081{
8082 psa_status_t status;
8083 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008084 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008085 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8086 * At round two perform a single cycle
8087 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008088 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008089
Gilles Peskine449bd832023-01-11 14:50:10 +01008090 for (; remaining_steps > 0; remaining_steps--) {
8091 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008092 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008093 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008094 /* Length is stored at the first byte */
8095 size_t length = buf[input_offset];
8096 input_offset += 1;
8097
Gilles Peskine449bd832023-01-11 14:50:10 +01008098 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008099 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8100 }
8101
Gilles Peskine449bd832023-01-11 14:50:10 +01008102 status = psa_pake_input(pake_ctx, step,
8103 buf + input_offset, length);
8104 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008105 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008106 }
8107
8108 input_offset += length;
8109 }
8110 }
8111
Gilles Peskine449bd832023-01-11 14:50:10 +01008112 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008113 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008114 }
Valerio Setti30ebe112022-11-17 16:23:34 +01008115
Gilles Peskine449bd832023-01-11 14:50:10 +01008116 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008117}
8118
Valerio Setti6b3dab02022-11-17 17:14:54 +01008119int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008120 psa_pake_operation_t *pake_ctx,
8121 unsigned char *buf,
8122 size_t len, size_t *olen,
8123 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008124{
8125 psa_status_t status;
8126 size_t output_offset = 0;
8127 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01008128 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008129 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8130 * At round two perform a single cycle
8131 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008132 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008133
Gilles Peskine449bd832023-01-11 14:50:10 +01008134 for (; remaining_steps > 0; remaining_steps--) {
8135 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
8136 step <= PSA_PAKE_STEP_ZK_PROOF;
8137 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008138 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01008139 * For each step, prepend 1 byte with the length of the data as
8140 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008141 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008142 status = psa_pake_output(pake_ctx, step,
8143 buf + output_offset + 1,
8144 len - output_offset - 1,
8145 &output_len);
8146 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008147 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008148 }
8149
Valerio Setti99d88c12022-11-22 16:03:43 +01008150 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01008151
8152 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008153 }
8154 }
8155
8156 *olen = output_offset;
8157
Gilles Peskine449bd832023-01-11 14:50:10 +01008158 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01008159}
Manuel Pégourié-Gonnard07a1edd2025-01-23 11:04:48 +01008160#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Valerio Settia08b1a42022-11-17 15:10:02 +01008161
Gilles Peskine449bd832023-01-11 14:50:10 +01008162int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
8163 unsigned char *hash, size_t *hashlen,
8164 unsigned char *data, size_t data_len,
8165 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08008166{
8167 psa_status_t status;
8168 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008169 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008170
Gilles Peskine449bd832023-01-11 14:50:10 +01008171 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08008172
Gilles Peskine449bd832023-01-11 14:50:10 +01008173 if ((status = psa_hash_setup(&hash_operation,
8174 hash_alg)) != PSA_SUCCESS) {
8175 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008176 goto exit;
8177 }
8178
Gilles Peskine449bd832023-01-11 14:50:10 +01008179 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
8180 64)) != PSA_SUCCESS) {
8181 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008182 goto exit;
8183 }
8184
Gilles Peskine449bd832023-01-11 14:50:10 +01008185 if ((status = psa_hash_update(&hash_operation,
8186 data, data_len)) != PSA_SUCCESS) {
8187 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08008188 goto exit;
8189 }
8190
Gilles Peskine449bd832023-01-11 14:50:10 +01008191 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
8192 hashlen)) != PSA_SUCCESS) {
8193 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
8194 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008195 }
8196
8197exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008198 if (status != PSA_SUCCESS) {
8199 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8200 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
8201 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08008202 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01008203 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008204 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
8205 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01008206 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008207 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008208 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008209 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01008210 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008211 }
8212 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008213 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08008214}
8215
Jerry Yuee40f9d2022-02-17 14:55:16 +08008216
Jerry Yud9d91da2022-02-17 14:57:06 +08008217#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
8218
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008219/* Find the preferred hash for a given signature algorithm. */
8220unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01008221 mbedtls_ssl_context *ssl,
8222 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08008223{
Gabor Mezei078e8032022-04-27 21:17:56 +02008224 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02008225 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02008226
Gilles Peskine449bd832023-01-11 14:50:10 +01008227 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
8228 return MBEDTLS_SSL_HASH_NONE;
8229 }
Gabor Mezei078e8032022-04-27 21:17:56 +02008230
Gilles Peskine449bd832023-01-11 14:50:10 +01008231 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008232 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008233 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
8234 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008235 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01008236 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
8237 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008238
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008239 mbedtls_md_type_t md_alg =
8240 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
8241 if (md_alg == MBEDTLS_MD_NONE) {
8242 continue;
8243 }
8244
Gilles Peskine449bd832023-01-11 14:50:10 +01008245 if (sig_alg == sig_alg_received) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008246 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02008247 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02008248 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008249
Gilles Peskine449bd832023-01-11 14:50:10 +01008250 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
8251 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8252 PSA_ALG_ECDSA(psa_hash_alg),
8253 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008254 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008255 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008256
Gilles Peskine449bd832023-01-11 14:50:10 +01008257 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
8258 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
8259 PSA_ALG_RSA_PKCS1V15_SIGN(
8260 psa_hash_alg),
8261 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008262 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008263 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008264 }
Neil Armstrong96eceb82022-06-30 18:05:05 +02008265
Gilles Peskine449bd832023-01-11 14:50:10 +01008266 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02008267 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008268 }
Jerry Yud9d91da2022-02-17 14:57:06 +08008269
Gilles Peskine449bd832023-01-11 14:50:10 +01008270 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08008271}
8272
8273#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8274
Jerry Yudc7bd172022-02-17 13:44:15 +08008275#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8276
XiaokangQian75d40ef2022-04-20 11:05:24 +00008277int mbedtls_ssl_validate_ciphersuite(
8278 const mbedtls_ssl_context *ssl,
8279 const mbedtls_ssl_ciphersuite_t *suite_info,
8280 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01008281 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008282{
8283 (void) ssl;
8284
Gilles Peskine449bd832023-01-11 14:50:10 +01008285 if (suite_info == NULL) {
8286 return -1;
8287 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00008288
Gilles Peskine449bd832023-01-11 14:50:10 +01008289 if ((suite_info->min_tls_version > max_tls_version) ||
8290 (suite_info->max_tls_version < min_tls_version)) {
8291 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008292 }
8293
XiaokangQian060d8672022-04-21 09:24:56 +00008294#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00008295#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008296 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
Manuel Pégourié-Gonnard88800dd2025-01-23 11:01:35 +01008297 ssl->handshake->psa_pake_ctx_is_ok != 1) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008298 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008299 }
8300#endif
8301
8302 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
8303#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008304 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
8305 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
8306 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008307 }
8308#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
8309#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
8310
Gilles Peskine449bd832023-01-11 14:50:10 +01008311 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00008312}
8313
Ronald Crone68ab4f2022-10-05 12:46:29 +02008314#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00008315/*
8316 * Function for writing a signature algorithm extension.
8317 *
8318 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
8319 * value (TLS 1.3 RFC8446):
8320 * enum {
8321 * ....
8322 * ecdsa_secp256r1_sha256( 0x0403 ),
8323 * ecdsa_secp384r1_sha384( 0x0503 ),
8324 * ecdsa_secp521r1_sha512( 0x0603 ),
8325 * ....
8326 * } SignatureScheme;
8327 *
8328 * struct {
8329 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
8330 * } SignatureSchemeList;
8331 *
8332 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
8333 * value (TLS 1.2 RFC5246):
8334 * enum {
8335 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
8336 * sha512(6), (255)
8337 * } HashAlgorithm;
8338 *
8339 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
8340 * SignatureAlgorithm;
8341 *
8342 * struct {
8343 * HashAlgorithm hash;
8344 * SignatureAlgorithm signature;
8345 * } SignatureAndHashAlgorithm;
8346 *
8347 * SignatureAndHashAlgorithm
8348 * supported_signature_algorithms<2..2^16-2>;
8349 *
8350 * The TLS 1.3 signature algorithm extension was defined to be a compatible
8351 * generalization of the TLS 1.2 signature algorithm extension.
8352 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
8353 * `SignatureScheme` field of TLS 1.3
8354 *
8355 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008356int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
8357 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00008358{
8359 unsigned char *p = buf;
8360 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
8361 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
8362
8363 *out_len = 0;
8364
Gilles Peskine449bd832023-01-11 14:50:10 +01008365 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00008366
8367 /* Check if we have space for header and length field:
8368 * - extension_type (2 bytes)
8369 * - extension_data_length (2 bytes)
8370 * - supported_signature_algorithms_length (2 bytes)
8371 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008372 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00008373 p += 6;
8374
8375 /*
8376 * Write supported_signature_algorithms
8377 */
8378 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01008379 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
8380 if (sig_alg == NULL) {
8381 return MBEDTLS_ERR_SSL_BAD_CONFIG;
8382 }
XiaokangQianeaf36512022-04-24 09:07:44 +00008383
Gilles Peskine449bd832023-01-11 14:50:10 +01008384 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
8385 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
8386 *sig_alg,
8387 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
8388 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00008389 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01008390 }
8391 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
8392 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00008393 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008394 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
8395 *sig_alg,
8396 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00008397 }
8398
8399 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008400 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01008401 if (supported_sig_alg_len == 0) {
8402 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
8403 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00008404 }
8405
Gilles Peskine449bd832023-01-11 14:50:10 +01008406 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
8407 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
8408 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00008409
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00008410 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00008411
8412#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008413 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00008414#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08008415
Gilles Peskine449bd832023-01-11 14:50:10 +01008416 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00008417}
Ronald Crone68ab4f2022-10-05 12:46:29 +02008418#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00008419
XiaokangQian40a35232022-05-07 09:02:40 +00008420#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00008421/*
8422 * mbedtls_ssl_parse_server_name_ext
8423 *
8424 * Structure of server_name extension:
8425 *
8426 * enum {
8427 * host_name(0), (255)
8428 * } NameType;
8429 * opaque HostName<1..2^16-1>;
8430 *
8431 * struct {
8432 * NameType name_type;
8433 * select (name_type) {
8434 * case host_name: HostName;
8435 * } name;
8436 * } ServerName;
8437 * struct {
8438 * ServerName server_name_list<1..2^16-1>
8439 * } ServerNameList;
8440 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02008441MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008442int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
8443 const unsigned char *buf,
8444 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00008445{
8446 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8447 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00008448 size_t server_name_list_len, hostname_len;
8449 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00008450
Gilles Peskine449bd832023-01-11 14:50:10 +01008451 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00008452
Gilles Peskine449bd832023-01-11 14:50:10 +01008453 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
8454 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00008455 p += 2;
8456
Gilles Peskine449bd832023-01-11 14:50:10 +01008457 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00008458 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008459 while (p < server_name_list_end) {
8460 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
8461 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
8462 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
8463 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00008464
Gilles Peskine449bd832023-01-11 14:50:10 +01008465 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00008466 /* sni_name is intended to be used only during the parsing of the
8467 * ClientHello message (it is reset to NULL before the end of
8468 * the message parsing). Thus it is ok to just point to the
8469 * reception buffer and not make a copy of it.
8470 */
XiaokangQianf2a94202022-05-20 06:44:24 +00008471 ssl->handshake->sni_name = p + 3;
8472 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008473 if (ssl->conf->f_sni == NULL) {
8474 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008475 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008476 ret = ssl->conf->f_sni(ssl->conf->p_sni,
8477 ssl, p + 3, hostname_len);
8478 if (ret != 0) {
8479 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
8480 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
8481 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
8482 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
8483 }
8484 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008485 }
8486
8487 p += hostname_len + 3;
8488 }
8489
Gilles Peskine449bd832023-01-11 14:50:10 +01008490 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00008491}
8492#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
8493
XiaokangQianacb39922022-06-17 10:18:48 +00008494#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02008495MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008496int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
8497 const unsigned char *buf,
8498 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00008499{
8500 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00008501 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00008502 const unsigned char *protocol_name_list;
8503 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00008504 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008505
8506 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01008507 if (ssl->conf->alpn_list == NULL) {
8508 return 0;
8509 }
XiaokangQianacb39922022-06-17 10:18:48 +00008510
8511 /*
XiaokangQianc7403452022-06-23 03:24:12 +00008512 * RFC7301, section 3.1
8513 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00008514 *
XiaokangQianc7403452022-06-23 03:24:12 +00008515 * struct {
8516 * ProtocolName protocol_name_list<2..2^16-1>
8517 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00008518 */
8519
XiaokangQianc7403452022-06-23 03:24:12 +00008520 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00008521 * protocol_name_list_len 2 bytes
8522 * protocol_name_len 1 bytes
8523 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00008524 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008525 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00008526
Gilles Peskine449bd832023-01-11 14:50:10 +01008527 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008528 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01008529 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00008530 protocol_name_list = p;
8531 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008532
8533 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01008534 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008535 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008536 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
8537 protocol_name_len);
8538 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008539 MBEDTLS_SSL_PEND_FATAL_ALERT(
8540 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01008541 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
8542 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00008543 }
8544
8545 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008546 }
8547
8548 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01008549 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
8550 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00008551 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01008552 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00008553 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008554 if (protocol_name_len == alpn_len &&
8555 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00008556 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01008557 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008558 }
XiaokangQian95d5f542022-06-24 02:29:26 +00008559
8560 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008561 }
8562 }
8563
XiaokangQian95d5f542022-06-24 02:29:26 +00008564 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00008565 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01008566 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
8567 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
8568 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00008569}
8570
Gilles Peskine449bd832023-01-11 14:50:10 +01008571int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
8572 unsigned char *buf,
8573 unsigned char *end,
8574 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00008575{
8576 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00008577 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00008578 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008579
Gilles Peskine449bd832023-01-11 14:50:10 +01008580 if (ssl->alpn_chosen == NULL) {
8581 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008582 }
8583
Gilles Peskine449bd832023-01-11 14:50:10 +01008584 protocol_name_len = strlen(ssl->alpn_chosen);
8585 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008586
Gilles Peskine449bd832023-01-11 14:50:10 +01008587 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00008588 /*
8589 * 0 . 1 ext identifier
8590 * 2 . 3 ext length
8591 * 4 . 5 protocol list length
8592 * 6 . 6 protocol name length
8593 * 7 . 7+n protocol name
8594 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008595 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00008596
XiaokangQian95d5f542022-06-24 02:29:26 +00008597 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00008598
Gilles Peskine449bd832023-01-11 14:50:10 +01008599 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
8600 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00008601 /* Note: the length of the chosen protocol has been checked to be less
8602 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
8603 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008604 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00008605
Gilles Peskine449bd832023-01-11 14:50:10 +01008606 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08008607
8608#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008609 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08008610#endif
8611
Gilles Peskine449bd832023-01-11 14:50:10 +01008612 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00008613}
8614#endif /* MBEDTLS_SSL_ALPN */
8615
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008616#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00008617 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008618 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008619 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008620int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
8621 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008622{
8623 /* Initialize to suppress unnecessary compiler warning */
8624 size_t hostname_len = 0;
8625
8626 /* Check if new hostname is valid before
8627 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008628 if (hostname != NULL) {
8629 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008630
Gilles Peskine449bd832023-01-11 14:50:10 +01008631 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
8632 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8633 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008634 }
8635
8636 /* Now it's clear that we will overwrite the old hostname,
8637 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01008638 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008639 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01008640 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008641 }
8642
8643 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01008644 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008645 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01008646 } else {
8647 session->hostname = mbedtls_calloc(1, hostname_len + 1);
8648 if (session->hostname == NULL) {
8649 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8650 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008651
Gilles Peskine449bd832023-01-11 14:50:10 +01008652 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008653 }
8654
Gilles Peskine449bd832023-01-11 14:50:10 +01008655 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008656}
Xiaokang Qian03409292022-10-12 02:49:52 +00008657#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
8658 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00008659 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00008660 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00008661
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008662#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
8663 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008664int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
8665 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008666{
8667 size_t alpn_len = 0;
8668
8669 if (alpn != NULL) {
8670 alpn_len = strlen(alpn);
8671
8672 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
8673 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
8674 }
8675 }
8676
8677 if (session->ticket_alpn != NULL) {
8678 mbedtls_zeroize_and_free(session->ticket_alpn,
8679 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008680 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008681 }
8682
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008683 if (alpn != NULL) {
8684 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008685 if (session->ticket_alpn == NULL) {
8686 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
8687 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00008688 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00008689 }
8690
8691 return 0;
8692}
8693#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008694
8695/*
8696 * The following functions are used by 1.2 and 1.3, client and server.
8697 */
8698#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
8699int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
8700 const mbedtls_ssl_ciphersuite_t *ciphersuite,
8701 int recv_endpoint,
8702 mbedtls_ssl_protocol_version tls_version,
8703 uint32_t *flags)
8704{
8705 int ret = 0;
8706 unsigned int usage = 0;
8707 const char *ext_oid;
8708 size_t ext_len;
8709
8710 /*
8711 * keyUsage
8712 */
8713
8714 /* Note: don't guard this with MBEDTLS_SSL_CLI_C because the server wants
8715 * to check what a compliant client will think while choosing which cert
8716 * to send to the client. */
8717#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
8718 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8719 recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8720 /* TLS 1.2 server part of the key exchange */
8721 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008722 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
8723 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
8724 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8725 break;
8726
8727 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
8728 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
8729 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
8730 break;
8731
8732 /* Don't use default: we want warnings when adding new values */
8733 case MBEDTLS_KEY_EXCHANGE_NONE:
8734 case MBEDTLS_KEY_EXCHANGE_PSK:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008735 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
8736 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
8737 usage = 0;
8738 }
8739 } else
8740#endif
8741 {
8742 /* This is either TLS 1.3 authentication, which always uses signatures,
8743 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
8744 * options we implement, both using signatures. */
8745 (void) tls_version;
8746 (void) ciphersuite;
8747 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
8748 }
8749
8750 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
8751 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
8752 ret = -1;
8753 }
8754
8755 /*
8756 * extKeyUsage
8757 */
8758
8759 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
8760 ext_oid = MBEDTLS_OID_SERVER_AUTH;
8761 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
8762 } else {
8763 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
8764 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
8765 }
8766
8767 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
8768 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
8769 ret = -1;
8770 }
8771
8772 return ret;
8773}
8774
Gilles Peskine4ac40082025-02-20 18:13:58 +01008775static int get_hostname_for_verification(mbedtls_ssl_context *ssl,
8776 const char **hostname)
8777{
8778 if (!mbedtls_ssl_has_set_hostname_been_called(ssl)) {
8779 MBEDTLS_SSL_DEBUG_MSG(1, ("Certificate verification without having set hostname"));
Gilles Peskine488b9192025-02-13 14:39:02 +01008780 if (mbedtls_ssl_conf_get_endpoint(ssl->conf) == MBEDTLS_SSL_IS_CLIENT &&
8781 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8782 return MBEDTLS_ERR_SSL_CERTIFICATE_VERIFICATION_WITHOUT_HOSTNAME;
8783 }
Gilles Peskine4ac40082025-02-20 18:13:58 +01008784 }
8785
8786 *hostname = ssl->hostname;
8787 if (*hostname == NULL) {
8788 MBEDTLS_SSL_DEBUG_MSG(2, ("Certificate verification without CN verification"));
8789 }
8790
8791 return 0;
8792}
8793
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008794int mbedtls_ssl_verify_certificate(mbedtls_ssl_context *ssl,
8795 int authmode,
8796 mbedtls_x509_crt *chain,
8797 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
8798 void *rs_ctx)
8799{
8800 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
8801 return 0;
8802 }
8803
8804 /*
8805 * Primary check: use the appropriate X.509 verification function
8806 */
8807 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
8808 void *p_vrfy;
8809 if (ssl->f_vrfy != NULL) {
8810 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
8811 f_vrfy = ssl->f_vrfy;
8812 p_vrfy = ssl->p_vrfy;
8813 } else {
8814 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
8815 f_vrfy = ssl->conf->f_vrfy;
8816 p_vrfy = ssl->conf->p_vrfy;
8817 }
8818
Gilles Peskine4ac40082025-02-20 18:13:58 +01008819 const char *hostname = "";
8820 int ret = get_hostname_for_verification(ssl, &hostname);
8821 if (ret != 0) {
8822 MBEDTLS_SSL_DEBUG_RET(1, "get_hostname_for_verification", ret);
8823 return ret;
8824 }
8825
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008826 int have_ca_chain_or_callback = 0;
8827#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
8828 if (ssl->conf->f_ca_cb != NULL) {
8829 ((void) rs_ctx);
8830 have_ca_chain_or_callback = 1;
8831
8832 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
8833 ret = mbedtls_x509_crt_verify_with_ca_cb(
8834 chain,
8835 ssl->conf->f_ca_cb,
8836 ssl->conf->p_ca_cb,
8837 ssl->conf->cert_profile,
Gilles Peskine4ac40082025-02-20 18:13:58 +01008838 hostname,
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008839 &ssl->session_negotiate->verify_result,
8840 f_vrfy, p_vrfy);
8841 } else
8842#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
8843 {
8844 mbedtls_x509_crt *ca_chain;
8845 mbedtls_x509_crl *ca_crl;
8846#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8847 if (ssl->handshake->sni_ca_chain != NULL) {
8848 ca_chain = ssl->handshake->sni_ca_chain;
8849 ca_crl = ssl->handshake->sni_ca_crl;
8850 } else
8851#endif
8852 {
8853 ca_chain = ssl->conf->ca_chain;
8854 ca_crl = ssl->conf->ca_crl;
8855 }
8856
8857 if (ca_chain != NULL) {
8858 have_ca_chain_or_callback = 1;
8859 }
8860
8861 ret = mbedtls_x509_crt_verify_restartable(
8862 chain,
8863 ca_chain, ca_crl,
8864 ssl->conf->cert_profile,
Gilles Peskine4ac40082025-02-20 18:13:58 +01008865 hostname,
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02008866 &ssl->session_negotiate->verify_result,
8867 f_vrfy, p_vrfy, rs_ctx);
8868 }
8869
8870 if (ret != 0) {
8871 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
8872 }
8873
8874#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
8875 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8876 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8877 }
8878#endif
8879
8880 /*
8881 * Secondary checks: always done, but change 'ret' only if it was 0
8882 */
8883
8884 /* With TLS 1.2 and ECC certs, check that the curve used by the
8885 * certificate is on our list of acceptable curves.
8886 *
8887 * With TLS 1.3 this is not needed because the curve is part of the
8888 * signature algorithm (eg ecdsa_secp256r1_sha256) which is checked when
8889 * we validate the signature made with the key associated to this cert.
8890 */
8891#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
8892 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
8893 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
8894 mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY)) {
8895 if (mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
8896 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8897 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
8898 if (ret == 0) {
8899 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8900 }
8901 }
8902 }
8903#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
8904
8905 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
8906 if (mbedtls_ssl_check_cert_usage(chain,
8907 ciphersuite_info,
8908 ssl->conf->endpoint,
8909 ssl->tls_version,
8910 &ssl->session_negotiate->verify_result) != 0) {
8911 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8912 if (ret == 0) {
8913 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
8914 }
8915 }
8916
8917 /* With authmode optional, we want to keep going if the certificate was
8918 * unacceptable, but still fail on other errors (out of memory etc),
8919 * including fatal errors from the f_vrfy callback.
8920 *
8921 * The only acceptable errors are:
8922 * - MBEDTLS_ERR_X509_CERT_VERIFY_FAILED: cert rejected by primary check;
8923 * - MBEDTLS_ERR_SSL_BAD_CERTIFICATE: cert rejected by secondary checks.
8924 * Anything else is a fatal error. */
8925 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8926 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8927 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
8928 ret = 0;
8929 }
8930
8931 /* Return a specific error as this is a user error: inconsistent
8932 * configuration - can't verify without trust anchors. */
8933 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8934 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
8935 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8936 }
8937
8938 if (ret != 0) {
8939 uint8_t alert;
8940
8941 /* The certificate may have been rejected for several reasons.
8942 Pick one and send the corresponding alert. Which alert to send
8943 may be a subject of debate in some cases. */
8944 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
8945 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
8946 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
8947 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
8948 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
8949 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8950 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
8951 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8952 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
8953 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8954 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
8955 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
8956 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
8957 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
8958 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
8959 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
8960 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
8961 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
8962 } else {
8963 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
8964 }
8965 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8966 alert);
8967 }
8968
8969#if defined(MBEDTLS_DEBUG_C)
8970 if (ssl->session_negotiate->verify_result != 0) {
8971 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8972 (unsigned int) ssl->session_negotiate->verify_result));
8973 } else {
8974 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
8975 }
8976#endif /* MBEDTLS_DEBUG_C */
8977
8978 return ret;
8979}
8980#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
8981
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02008982#endif /* MBEDTLS_SSL_TLS_C */