blob: 70621b5ccce21a22fd0015fea487a5ba5648697c [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
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050030#if defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti384fbde2024-01-02 13:26:40 +010031#include "mbedtls/psa_util.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020032#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020033#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050034#include "psa/crypto.h"
35#endif
36
Janos Follath23bdca02016-10-07 14:47:14 +010037#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000038#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020039#endif
40
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050041#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040042/* Define local translating functions to save code size by not using too many
43 * arguments in each translating place. */
44static int local_err_translation(psa_status_t status)
45{
46 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040047 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040048 psa_generic_status_to_mbedtls);
49}
50#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050051#endif
52
Ronald Cronad8c17b2022-06-10 17:18:09 +020053#if defined(MBEDTLS_TEST_HOOKS)
54static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
55
56void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010057 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020058{
59 chk_buf_ptr_fail_args.cur = cur;
60 chk_buf_ptr_fail_args.end = end;
61 chk_buf_ptr_fail_args.need = need;
62}
63
Gilles Peskine449bd832023-01-11 14:50:10 +010064void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020065{
Gilles Peskine449bd832023-01-11 14:50:10 +010066 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020067}
68
Gilles Peskine449bd832023-01-11 14:50:10 +010069int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020070{
Gilles Peskine449bd832023-01-11 14:50:10 +010071 return (chk_buf_ptr_fail_args.cur != args->cur) ||
72 (chk_buf_ptr_fail_args.end != args->end) ||
73 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020074}
75#endif /* MBEDTLS_TEST_HOOKS */
76
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020077#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010078
Hanno Beckera0e20d02019-05-15 14:03:01 +010079#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010080/* Top-level Connection ID API */
81
Gilles Peskine449bd832023-01-11 14:50:10 +010082int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
83 size_t len,
84 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010085{
Gilles Peskine449bd832023-01-11 14:50:10 +010086 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
87 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
88 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010089
Gilles Peskine449bd832023-01-11 14:50:10 +010090 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
91 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
92 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010093 }
94
95 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010096 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010097 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010098}
99
Gilles Peskine449bd832023-01-11 14:50:10 +0100100int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
101 int enable,
102 unsigned char const *own_cid,
103 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100104{
Gilles Peskine449bd832023-01-11 14:50:10 +0100105 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
106 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
107 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100108
Hanno Beckerca092242019-04-25 16:01:49 +0100109 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 if (enable == MBEDTLS_SSL_CID_DISABLED) {
111 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
112 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100113 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100114 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
115 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100116
Gilles Peskine449bd832023-01-11 14:50:10 +0100117 if (own_cid_len != ssl->conf->cid_len) {
118 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
119 (unsigned) own_cid_len,
120 (unsigned) ssl->conf->cid_len));
121 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100122 }
123
Gilles Peskine449bd832023-01-11 14:50:10 +0100124 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100125 /* Truncation is not an issue here because
126 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
127 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100128
Gilles Peskine449bd832023-01-11 14:50:10 +0100129 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100130}
131
Gilles Peskine449bd832023-01-11 14:50:10 +0100132int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
133 int *enabled,
Sam Berry3504c882024-06-11 14:34:17 +0100134 unsigned char own_cid[MBEDTLS_SSL_CID_IN_LEN_MAX],
Gilles Peskine449bd832023-01-11 14:50:10 +0100135 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000136{
137 *enabled = MBEDTLS_SSL_CID_DISABLED;
138
Gilles Peskine449bd832023-01-11 14:50:10 +0100139 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
140 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
141 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000142
143 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
144 * zero as this is indistinguishable from not requesting to use
145 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100146 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
147 return 0;
148 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000149
Gilles Peskine449bd832023-01-11 14:50:10 +0100150 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000151 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100152 if (own_cid != NULL) {
153 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
154 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000155 }
156
157 *enabled = MBEDTLS_SSL_CID_ENABLED;
158
Gilles Peskine449bd832023-01-11 14:50:10 +0100159 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000160}
161
Gilles Peskine449bd832023-01-11 14:50:10 +0100162int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
163 int *enabled,
164 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
165 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100166{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100167 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100168
Gilles Peskine449bd832023-01-11 14:50:10 +0100169 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
170 mbedtls_ssl_is_handshake_over(ssl) == 0) {
171 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100172 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100173
Hanno Beckerc5f24222019-05-03 12:54:52 +0100174 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
175 * were used, but client and server requested the empty CID.
176 * This is indistinguishable from not using the CID extension
177 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100178 if (ssl->transform_in->in_cid_len == 0 &&
179 ssl->transform_in->out_cid_len == 0) {
180 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100181 }
182
Gilles Peskine449bd832023-01-11 14:50:10 +0100183 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100184 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100185 if (peer_cid != NULL) {
186 memcpy(peer_cid, ssl->transform_in->out_cid,
187 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100188 }
189 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100190
191 *enabled = MBEDTLS_SSL_CID_ENABLED;
192
Gilles Peskine449bd832023-01-11 14:50:10 +0100193 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100194}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100195#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100196
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200197#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200198
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200199#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200200/*
201 * Convert max_fragment_length codes to length.
202 * RFC 6066 says:
203 * enum{
204 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
205 * } MaxFragmentLength;
206 * and we add 0 -> extension unused
207 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100208static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200209{
Gilles Peskine449bd832023-01-11 14:50:10 +0100210 switch (mfl) {
211 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
212 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
213 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
214 return 512;
215 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
216 return 1024;
217 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
218 return 2048;
219 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
220 return 4096;
221 default:
222 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000223 }
224}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200226
Gilles Peskine449bd832023-01-11 14:50:10 +0100227int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
228 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200229{
Gilles Peskine449bd832023-01-11 14:50:10 +0100230 mbedtls_ssl_session_free(dst);
231 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800232#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
233 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000234#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
235 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000236 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800237#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000238#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800239
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000240#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
241 defined(MBEDTLS_SSL_EARLY_DATA)
242 dst->ticket_alpn = NULL;
243#endif
244
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200245#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000246
247#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100248 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000249 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200250
Gilles Peskine449bd832023-01-11 14:50:10 +0100251 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
252 if (dst->peer_cert == NULL) {
253 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
254 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200255
Gilles Peskine449bd832023-01-11 14:50:10 +0100256 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200257
Gilles Peskine449bd832023-01-11 14:50:10 +0100258 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
259 src->peer_cert->raw.len)) != 0) {
260 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200261 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100262 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200263 }
264 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000265#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100266 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000267 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100268 mbedtls_calloc(1, src->peer_cert_digest_len);
269 if (dst->peer_cert_digest == NULL) {
270 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
271 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000272
Gilles Peskine449bd832023-01-11 14:50:10 +0100273 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
274 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000275 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000276 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000277 }
278#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
279
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200280#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200281
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000282#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
283 defined(MBEDTLS_SSL_EARLY_DATA)
284 {
285 int ret = mbedtls_ssl_session_set_ticket_alpn(dst, src->ticket_alpn);
286 if (ret != 0) {
287 return ret;
288 }
289 }
290#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_ALPN && MBEDTLS_SSL_EARLY_DATA */
291
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200292#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100293 if (src->ticket != NULL) {
294 dst->ticket = mbedtls_calloc(1, src->ticket_len);
295 if (dst->ticket == NULL) {
296 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
297 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200298
Gilles Peskine449bd832023-01-11 14:50:10 +0100299 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200300 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000301
302#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
303 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100304 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000305 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100306 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
307 if (ret != 0) {
308 return ret;
309 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000310 }
311#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
312 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200313#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200314
Gilles Peskine449bd832023-01-11 14:50:10 +0100315 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200316}
317
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500318#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200319MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100320static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500321{
Gilles Peskine449bd832023-01-11 14:50:10 +0100322 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
323 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800324 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100325 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500326
327 /* We want to copy len_new bytes when downsizing the buffer, and
328 * len_old bytes when upsizing, so we choose the smaller of two sizes,
329 * to fit one buffer into another. Size checks, ensuring that no data is
330 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100331 memcpy(resized_buffer, *buffer,
332 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100333 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500334
335 *buffer = resized_buffer;
336 *len_old = len_new;
337
338 return 0;
339}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200340
Gilles Peskine449bd832023-01-11 14:50:10 +0100341static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
342 size_t in_buf_new_len,
343 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200344{
345 int modified = 0;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000346 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0, hdr_in = 0;
Andrzej Kurek4a063792020-10-21 15:08:44 +0200347 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000348 size_t hshdr_in = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200350 written_in = ssl->in_msg - ssl->in_buf;
351 iv_offset_in = ssl->in_iv - ssl->in_buf;
352 len_offset_in = ssl->in_len - ssl->in_buf;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000353 hdr_in = ssl->in_hdr - ssl->in_buf;
354 if (ssl->in_hshdr != NULL) {
355 hshdr_in = ssl->in_hshdr - ssl->in_buf;
356 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200358 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100359 ssl->in_buf_len < in_buf_new_len) {
360 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
361 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
362 } else {
363 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
364 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200365 modified = 1;
366 }
367 }
368 }
369
Gilles Peskine449bd832023-01-11 14:50:10 +0100370 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200371 written_out = ssl->out_msg - ssl->out_buf;
372 iv_offset_out = ssl->out_iv - ssl->out_buf;
373 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100374 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200375 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100376 ssl->out_buf_len < out_buf_new_len) {
377 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
378 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
379 } else {
380 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
381 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200382 modified = 1;
383 }
384 }
385 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100386 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200387 /* Update pointers here to avoid doing it twice. */
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000388 ssl->in_hdr = ssl->in_buf + hdr_in;
389 mbedtls_ssl_update_in_pointers(ssl);
390 mbedtls_ssl_reset_out_pointers(ssl);
391
Andrzej Kurek4a063792020-10-21 15:08:44 +0200392 /* Fields below might not be properly updated with record
393 * splitting or with CID, so they are manually updated here. */
394 ssl->out_msg = ssl->out_buf + written_out;
395 ssl->out_len = ssl->out_buf + len_offset_out;
396 ssl->out_iv = ssl->out_buf + iv_offset_out;
397
398 ssl->in_msg = ssl->in_buf + written_in;
399 ssl->in_len = ssl->in_buf + len_offset_in;
400 ssl->in_iv = ssl->in_buf + iv_offset_in;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +0000401 if (ssl->in_hshdr != NULL) {
402 ssl->in_hshdr = ssl->in_buf + hshdr_in;
403 }
Andrzej Kurek4a063792020-10-21 15:08:44 +0200404 }
405}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500406#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
407
Jerry Yudb8c48a2022-01-27 14:54:54 +0800408#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800409
410#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100411typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
412 const char *label,
413 const unsigned char *random, size_t rlen,
414 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800415
Gilles Peskine449bd832023-01-11 14:50:10 +0100416static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800417
418#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
419
420/* Type for the TLS PRF */
421typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
422 const unsigned char *, size_t,
423 unsigned char *, size_t);
424
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200425MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100426static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
427 int ciphersuite,
428 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200429#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100430 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200431#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100432 ssl_tls_prf_t tls_prf,
433 const unsigned char randbytes[64],
434 mbedtls_ssl_protocol_version tls_version,
435 unsigned endpoint,
436 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800437
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100438#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200439MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100440static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300441 const char *label,
442 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100443 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100444static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
445static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100446
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100447#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100448
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100449#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100450MBEDTLS_CHECK_RETURN_CRITICAL
451static int tls_prf_sha384(const unsigned char *secret, size_t slen,
452 const char *label,
453 const unsigned char *random, size_t rlen,
454 unsigned char *dstbuf, size_t dlen);
455
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100456static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
457static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100458#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100459
Gilles Peskine449bd832023-01-11 14:50:10 +0100460MBEDTLS_CHECK_RETURN_CRITICAL
461static int ssl_tls12_session_load(mbedtls_ssl_session *session,
462 const unsigned char *buf,
463 size_t len);
464#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
465
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100466static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100467
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100468#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100469static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100470#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100471
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100472#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100473static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100474#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100475
476int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
477 const unsigned char *secret, size_t slen,
478 const char *label,
479 const unsigned char *random, size_t rlen,
480 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300481{
482 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
483
Gilles Peskine449bd832023-01-11 14:50:10 +0100484 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300485#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100486#if defined(PSA_WANT_ALG_SHA_384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300487 case MBEDTLS_SSL_TLS_PRF_SHA384:
488 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100489 break;
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100490#endif /* PSA_WANT_ALG_SHA_384*/
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100491#if defined(PSA_WANT_ALG_SHA_256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300492 case MBEDTLS_SSL_TLS_PRF_SHA256:
493 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100494 break;
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100495#endif /* PSA_WANT_ALG_SHA_256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300496#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100497 default:
498 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300499 }
500
Gilles Peskine449bd832023-01-11 14:50:10 +0100501 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300502}
503
Jerry Yuc73c6182022-02-08 20:29:25 +0800504#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100505static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800506{
507#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100508 if (session->peer_cert != NULL) {
509 mbedtls_x509_crt_free(session->peer_cert);
510 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800511 session->peer_cert = NULL;
512 }
513#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100514 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800515 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100516 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800517 session->peer_cert_digest = NULL;
518 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
519 session->peer_cert_digest_len = 0;
520 }
521#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
522}
523#endif /* MBEDTLS_X509_CRT_PARSE_C */
524
Gilles Peskine449bd832023-01-11 14:50:10 +0100525uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800526{
Gilles Peskine449bd832023-01-11 14:50:10 +0100527 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800528 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100529 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800530
531 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100532 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800533
534 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100535 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800536
537 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100538 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800539
540 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800542
543 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100544 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800545
546 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800548
549 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100550 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800551
552 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100553 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800554
555 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100556 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800557
558 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100559 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800560
561 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100562 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800563
564 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100565 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800566
567 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100568 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800569
570 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100571 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800572
573 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100574 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800575
576 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100577 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800578
579 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100580 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800581
582 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100583 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800584
585 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100586 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800587
588 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800590
591 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800593
594 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100595 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800596
597 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100598 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800599
600 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100601 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800602
603 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800605
Jan Bruckner151f6422023-02-10 12:45:19 +0100606 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
607 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
608
Jerry Yu7a485c12022-10-31 13:08:18 +0800609 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100610 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800611
612 }
613
Gilles Peskine449bd832023-01-11 14:50:10 +0100614 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800615}
616
Gilles Peskine449bd832023-01-11 14:50:10 +0100617uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800618{
Gilles Peskine449bd832023-01-11 14:50:10 +0100619 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800620}
621
Jerry Yud25cab02022-10-31 12:48:30 +0800622#if defined(MBEDTLS_DEBUG_C)
623static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800624 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800625 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
626 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
627 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
628 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
629 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
630 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
631 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
632 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
633 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
634 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
635 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
636 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
637 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
638 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
639 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
640 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
641 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
642 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
643 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
644 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
645 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
646 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
647 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
648 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
649 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
650 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100651 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
652 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800653};
654
Chien Wong4e9683e2023-12-28 17:07:43 +0800655static const unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800656 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
657 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
658 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
659 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
660 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
661 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
662 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
663 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
664 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
665 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
666 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
667 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
668 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
669 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
670 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
671 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
672 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
673 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
674 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
675 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
676 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
677 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
678 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
679 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
680 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
681 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
682 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100683 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
684 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800685};
686
Gilles Peskine449bd832023-01-11 14:50:10 +0100687const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800688{
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 return extension_name_table[
690 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800691}
692
Gilles Peskine449bd832023-01-11 14:50:10 +0100693static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800694{
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800696 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100697 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800698 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800700 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800702 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100703 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800704 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800706 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100707 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800708 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100709 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800710 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100711 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800712}
713
Gilles Peskine449bd832023-01-11 14:50:10 +0100714void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
715 int level, const char *file, int line,
716 int hs_msg_type, unsigned int extension_type,
717 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800718{
719 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100720 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800721 mbedtls_debug_print_msg(
722 ssl, level, file, line,
723 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100724 ssl_tls13_get_hs_msg_name(hs_msg_type),
725 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800726 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100727 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800728 return;
729 }
730
731 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100732 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800733 mbedtls_debug_print_msg(
734 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100735 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
736 mbedtls_ssl_get_extension_name(extension_type), extension_type,
737 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800738 return;
739 }
740
741 mbedtls_debug_print_msg(
742 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
744 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800745}
746
Gilles Peskine449bd832023-01-11 14:50:10 +0100747void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
748 int level, const char *file, int line,
749 int hs_msg_type, uint32_t extensions_mask,
750 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800751{
752
Gilles Peskine449bd832023-01-11 14:50:10 +0100753 for (unsigned i = 0;
754 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
755 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800756 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800757 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100758 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800759 }
760}
761
Pengyu Lvee455c02023-01-12 14:37:24 +0800762#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800763static const char *ticket_flag_name_table[] =
764{
765 [0] = "ALLOW_PSK_RESUMPTION",
766 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
767 [3] = "ALLOW_EARLY_DATA",
768};
769
Pengyu Lv4938a562023-01-16 11:28:49 +0800770void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
771 int level, const char *file, int line,
772 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800773{
774 size_t i;
775
776 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800777 "print ticket_flags (0x%02x)", flags);
778
779 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800780
781 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800782 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800783 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
784 ticket_flag_name_table[i]);
785 }
786 }
787}
788#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
789
Jerry Yud25cab02022-10-31 12:48:30 +0800790#endif /* MBEDTLS_DEBUG_C */
791
Gilles Peskine449bd832023-01-11 14:50:10 +0100792void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
793 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800794{
795 ((void) ciphersuite_info);
796
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100797#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800799 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100800 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800801#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100802#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100803 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800804 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100805 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800806#endif
807 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100808 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800809 return;
810 }
811}
812
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100813int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100814 unsigned hs_type,
815 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100816{
817 unsigned char hs_hdr[4];
818
819 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100820 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
821 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
822 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
823 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100824
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100825 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100826}
827
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100828int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100829 unsigned hs_type,
830 unsigned char const *msg,
831 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100832{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100833 int ret;
834 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100835 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100836 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100837 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100838 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100839}
840
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100841int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800842{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100843#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100844 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100845#if defined(MBEDTLS_USE_PSA_CRYPTO)
846 psa_status_t status;
847#else
848 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
849#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100850#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800851 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100852#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100853#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800854#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100855 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
856 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200857 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100858 }
859 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
860 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200861 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100862 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800863#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100864 mbedtls_md_free(&ssl->handshake->fin_sha256);
865 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100866 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
867 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
868 0);
869 if (ret != 0) {
870 return ret;
871 }
872 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100873 if (ret != 0) {
874 return ret;
875 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800876#endif
877#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100878#if defined(PSA_WANT_ALG_SHA_384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800879#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100880 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
881 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200882 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100883 }
884 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
885 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200886 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100887 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800888#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100889 mbedtls_md_free(&ssl->handshake->fin_sha384);
890 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100891 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
892 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
893 if (ret != 0) {
894 return ret;
895 }
896 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100897 if (ret != 0) {
898 return ret;
899 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800900#endif
901#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100902 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800903}
904
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100905static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100906 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800907{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100908#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100909 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100910#if defined(MBEDTLS_USE_PSA_CRYPTO)
911 psa_status_t status;
912#else
913 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
914#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100915#else /* SHA-256 or SHA-384 */
916 ((void) ssl);
917 (void) buf;
918 (void) len;
919#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100920#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800921#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100922 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
923 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200924 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100925 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800926#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100927 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100928 if (ret != 0) {
929 return ret;
930 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800931#endif
932#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100933#if defined(PSA_WANT_ALG_SHA_384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800934#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100935 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
936 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200937 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100938 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800939#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100940 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100941 if (ret != 0) {
942 return ret;
943 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800944#endif
945#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100946 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800947}
948
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100949#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100950static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100951 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800952{
953#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200954 return mbedtls_md_error_from_psa(psa_hash_update(
955 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800956#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100957 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800958#endif
959}
960#endif
961
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100962#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100963static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100964 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800965{
966#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200967 return mbedtls_md_error_from_psa(psa_hash_update(
968 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800969#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100970 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800971#endif
972}
973#endif
974
Gilles Peskine449bd832023-01-11 14:50:10 +0100975static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200976{
Gilles Peskine449bd832023-01-11 14:50:10 +0100977 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200978
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100979#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500980#if defined(MBEDTLS_USE_PSA_CRYPTO)
981 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500982#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100983 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200984#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500985#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100986#if defined(PSA_WANT_ALG_SHA_384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500987#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500988 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500989#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100990 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200991#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500992#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200993
994 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100995
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200996#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100997 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200998#endif
Valerio Setti7aeec542023-07-05 18:57:21 +0200999#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02001000 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001001 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001002#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001003#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02001004#if defined(MBEDTLS_USE_PSA_CRYPTO)
1005 handshake->psa_pake_ctx = psa_pake_operation_init();
1006 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
1007#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001008 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02001009#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02001010#if defined(MBEDTLS_SSL_CLI_C)
1011 handshake->ecjpake_cache = NULL;
1012 handshake->ecjpake_cache_len = 0;
1013#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02001014#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001015
Gilles Peskineeccd8882020-03-10 12:19:08 +01001016#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001017 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02001018#endif
1019
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001020#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1021 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1022#endif
Hanno Becker75173122019-02-06 16:18:31 +00001023
1024#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1025 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001026 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001027#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001028}
1029
Gilles Peskine449bd832023-01-11 14:50:10 +01001030void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001031{
Gilles Peskine449bd832023-01-11 14:50:10 +01001032 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001033
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001034#if defined(MBEDTLS_USE_PSA_CRYPTO)
1035 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1036 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001037#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001038 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1039 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001040#endif
1041
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001042#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001043#if defined(MBEDTLS_USE_PSA_CRYPTO)
1044 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1045 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001046#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 mbedtls_md_init(&transform->md_ctx_enc);
1048 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001049#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001050#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001051}
1052
Gilles Peskine449bd832023-01-11 14:50:10 +01001053void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001054{
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001056}
1057
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001058MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001059static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001060{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001061 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1062
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001063 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001064#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 if (ssl->transform_negotiate) {
1066 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1067 }
Jerry Yu2e199812022-12-01 18:57:19 +08001068#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001069 if (ssl->session_negotiate) {
1070 mbedtls_ssl_session_free(ssl->session_negotiate);
1071 }
1072 if (ssl->handshake) {
1073 mbedtls_ssl_handshake_free(ssl);
1074 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001075
Jerry Yu2e199812022-12-01 18:57:19 +08001076#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001077 /*
1078 * Either the pointers are now NULL or cleared properly and can be freed.
1079 * Now allocate missing structures.
1080 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001081 if (ssl->transform_negotiate == NULL) {
1082 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001083 }
Jerry Yu2e199812022-12-01 18:57:19 +08001084#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 if (ssl->session_negotiate == NULL) {
1087 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001088 }
Paul Bakker48916f92012-09-16 19:57:18 +00001089
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 if (ssl->handshake == NULL) {
1091 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001092 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001093#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1094 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001095
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1097 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001098#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001099
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001100 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001102#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001103 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001104#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 ssl->session_negotiate == NULL) {
1106 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001107
Gilles Peskine449bd832023-01-11 14:50:10 +01001108 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001109 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001110
1111#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001113 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001114#endif
1115
Gilles Peskine449bd832023-01-11 14:50:10 +01001116 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001117 ssl->session_negotiate = NULL;
1118
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001120 }
1121
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001122#if defined(MBEDTLS_SSL_EARLY_DATA)
1123#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001124 ssl->early_data_state = MBEDTLS_SSL_EARLY_DATA_STATE_IDLE;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001125#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001126#if defined(MBEDTLS_SSL_SRV_C)
1127 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1128#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001129 ssl->total_early_data_size = 0;
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001130#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001131
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001132 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 mbedtls_ssl_session_init(ssl->session_negotiate);
1134 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001135
Jerry Yu2e199812022-12-01 18:57:19 +08001136#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001137 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001138#endif
1139
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001140 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001141 ret = mbedtls_ssl_reset_checksum(ssl);
1142 if (ret != 0) {
1143 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1144 return ret;
1145 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001146
Jerry Yud0766ec2022-09-22 10:46:57 +08001147#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1148 defined(MBEDTLS_SSL_SRV_C) && \
1149 defined(MBEDTLS_SSL_SESSION_TICKETS)
1150 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001152#endif
1153
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001154#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001155 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001156 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001157
Gilles Peskine449bd832023-01-11 14:50:10 +01001158 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001159 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001160 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001161 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001162 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001163
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001165 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001166#endif
1167
Brett Warrene0edc842021-08-17 09:53:13 +01001168/*
1169 * curve_list is translated to IANA TLS group identifiers here because
1170 * mbedtls_ssl_conf_curves returns void and so can't return
1171 * any error codes.
1172 */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001173#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001174#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1175 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001176 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001177 size_t length;
1178 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1179
Thomas Daubney850a0792023-05-22 12:05:03 +01001180 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001181 }
Brett Warrene0edc842021-08-17 09:53:13 +01001182
1183 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001184 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1185 if (group_list == NULL) {
1186 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1187 }
Brett Warrene0edc842021-08-17 09:53:13 +01001188
Gilles Peskine449bd832023-01-11 14:50:10 +01001189 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001190 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001191 curve_list[i]);
1192 if (tls_id == 0) {
1193 mbedtls_free(group_list);
1194 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001195 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001196 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001197 }
1198
1199 group_list[length] = 0;
1200
1201 ssl->handshake->group_list = group_list;
1202 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001203 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001204 ssl->handshake->group_list = ssl->conf->group_list;
1205 ssl->handshake->group_list_heap_allocated = 0;
1206 }
1207#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001208#endif /* MBEDTLS_ECP_C */
Brett Warrene0edc842021-08-17 09:53:13 +01001209
Ronald Crone68ab4f2022-10-05 12:46:29 +02001210#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001211#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001212#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001213 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1214 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001215 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1216 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001217 const int *md;
1218 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001219 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001220 uint16_t *p;
1221
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001222 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1223 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1224 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001225
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1227 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001228 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001229 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001230#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001232#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001233
Jerry Yub476a442022-01-21 18:14:45 +08001234#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001235 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001236#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001237 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1238 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1239 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001240 }
1241
Gilles Peskine449bd832023-01-11 14:50:10 +01001242 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1243 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1244 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001245
Gilles Peskine449bd832023-01-11 14:50:10 +01001246 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1247 sizeof(uint16_t));
1248 if (ssl->handshake->sig_algs == NULL) {
1249 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1250 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001251
Gilles Peskine449bd832023-01-11 14:50:10 +01001252 p = (uint16_t *) ssl->handshake->sig_algs;
1253 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1254 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1255 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001256 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001257 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001258#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001259 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001260 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001261#endif
1262#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001263 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001264 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001265#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001266 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001267 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001268 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001269 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001270#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001271 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001272 ssl->handshake->sig_algs_heap_allocated = 0;
1273 }
Jerry Yucc539102022-06-27 16:27:35 +08001274#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001275#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001276 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001277}
1278
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001279#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001280/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001281MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001282static int ssl_cookie_write_dummy(void *ctx,
1283 unsigned char **p, unsigned char *end,
1284 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001285{
1286 ((void) ctx);
1287 ((void) p);
1288 ((void) end);
1289 ((void) cli_id);
1290 ((void) cli_id_len);
1291
Gilles Peskine449bd832023-01-11 14:50:10 +01001292 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001293}
1294
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001295MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001296static int ssl_cookie_check_dummy(void *ctx,
1297 const unsigned char *cookie, size_t cookie_len,
1298 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001299{
1300 ((void) ctx);
1301 ((void) cookie);
1302 ((void) cookie_len);
1303 ((void) cli_id);
1304 ((void) cli_id_len);
1305
Gilles Peskine449bd832023-01-11 14:50:10 +01001306 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001307}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001308#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001309
Paul Bakker5121ce52009-01-03 21:22:43 +00001310/*
1311 * Initialize an SSL context
1312 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001313void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001314{
Gilles Peskine449bd832023-01-11 14:50:10 +01001315 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001316}
1317
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001318MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001319static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001320{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001321 const mbedtls_ssl_config *conf = ssl->conf;
1322
Ronald Cron6f135e12021-12-08 16:57:54 +01001323#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001324 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1325 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1326 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1327 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001328 }
1329
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1331 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001332 }
1333#endif
1334
1335#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001336 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1337 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1338 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001339 }
1340#endif
1341
Ronald Cron6f135e12021-12-08 16:57:54 +01001342#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001343 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1344 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1345 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1346 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001347 }
1348
Gilles Peskine449bd832023-01-11 14:50:10 +01001349 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1350 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001351 }
1352#endif
1353
Gilles Peskine449bd832023-01-11 14:50:10 +01001354 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1355 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001356}
1357
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001358MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001359static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1360{
1361 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001362 ret = ssl_conf_version_check(ssl);
1363 if (ret != 0) {
1364 return ret;
1365 }
Jerry Yu60835a82021-08-04 10:13:52 +08001366
Yanray Wangb422cab2023-12-01 16:18:10 +08001367 if (ssl->conf->f_rng == NULL) {
1368 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1369 return MBEDTLS_ERR_SSL_NO_RNG;
1370 }
1371
Jerry Yu60835a82021-08-04 10:13:52 +08001372 /* Space for further checks */
1373
Gilles Peskine449bd832023-01-11 14:50:10 +01001374 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001375}
1376
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001377/*
1378 * Setup an SSL context
1379 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001380
Gilles Peskine449bd832023-01-11 14:50:10 +01001381int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1382 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001383{
Janos Follath865b3eb2019-12-16 11:46:15 +00001384 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001385 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1386 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001387
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001388 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001389
Gilles Peskine449bd832023-01-11 14:50:10 +01001390 if ((ret = ssl_conf_check(ssl)) != 0) {
1391 return ret;
1392 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001393 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001394
Paul Bakker62f2dee2012-09-28 07:31:51 +00001395 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001396 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001397 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001398
1399 /* Set to NULL in case of an error condition */
1400 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001401
Darryl Greenb33cc762019-11-28 14:29:44 +00001402#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1403 ssl->in_buf_len = in_buf_len;
1404#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001405 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1406 if (ssl->in_buf == NULL) {
1407 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001408 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001409 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001410 }
1411
Darryl Greenb33cc762019-11-28 14:29:44 +00001412#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1413 ssl->out_buf_len = out_buf_len;
1414#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001415 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1416 if (ssl->out_buf == NULL) {
1417 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001418 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001419 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001420 }
1421
Gilles Peskine449bd832023-01-11 14:50:10 +01001422 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001423
Johan Pascalb62bb512015-12-03 21:56:45 +01001424#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001426#endif
1427
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001429 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001430 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001431
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001433
1434error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001435 mbedtls_free(ssl->in_buf);
1436 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001437
1438 ssl->conf = NULL;
1439
Darryl Greenb33cc762019-11-28 14:29:44 +00001440#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1441 ssl->in_buf_len = 0;
1442 ssl->out_buf_len = 0;
1443#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001444 ssl->in_buf = NULL;
1445 ssl->out_buf = NULL;
1446
1447 ssl->in_hdr = NULL;
1448 ssl->in_ctr = NULL;
1449 ssl->in_len = NULL;
1450 ssl->in_iv = NULL;
1451 ssl->in_msg = NULL;
1452
1453 ssl->out_hdr = NULL;
1454 ssl->out_ctr = NULL;
1455 ssl->out_len = NULL;
1456 ssl->out_iv = NULL;
1457 ssl->out_msg = NULL;
1458
Gilles Peskine449bd832023-01-11 14:50:10 +01001459 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001460}
1461
1462/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001463 * Reset an initialized and used SSL context for re-use while retaining
1464 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001465 *
1466 * If partial is non-zero, keep data in the input buffer and client ID.
1467 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001468 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001469void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1470 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001471{
Darryl Greenb33cc762019-11-28 14:29:44 +00001472#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1473 size_t in_buf_len = ssl->in_buf_len;
1474 size_t out_buf_len = ssl->out_buf_len;
1475#else
1476 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1477 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1478#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001479
Hanno Beckerb0302c42021-08-03 09:39:42 +01001480#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1481 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001482#endif
1483
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001484 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001485 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001486
Gilles Peskine449bd832023-01-11 14:50:10 +01001487 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001488
1489 /* Reset incoming message parsing */
1490 ssl->in_offt = NULL;
1491 ssl->nb_zero = 0;
1492 ssl->in_msgtype = 0;
1493 ssl->in_msglen = 0;
1494 ssl->in_hslen = 0;
1495 ssl->keep_current_message = 0;
1496 ssl->transform_in = NULL;
Deomid rojer Ryabkovac2cf1f2024-03-10 02:11:03 +00001497 ssl->in_hshdr = NULL;
1498 ssl->in_hsfraglen = 0;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001499
1500#if defined(MBEDTLS_SSL_PROTO_DTLS)
1501 ssl->next_record_offset = 0;
1502 ssl->in_epoch = 0;
1503#endif
1504
1505 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001506 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001507 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001508 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001509 }
1510
Ronald Cronad8c17b2022-06-10 17:18:09 +02001511 ssl->send_alert = 0;
1512
Hanno Beckerb0302c42021-08-03 09:39:42 +01001513 /* Reset outgoing message writing */
1514 ssl->out_msgtype = 0;
1515 ssl->out_msglen = 0;
1516 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001517 memset(ssl->out_buf, 0, out_buf_len);
1518 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001519 ssl->transform_out = NULL;
1520
1521#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001523#endif
1524
XiaokangQian2b01dc32022-01-21 02:53:13 +00001525#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001526 if (ssl->transform) {
1527 mbedtls_ssl_transform_free(ssl->transform);
1528 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001529 ssl->transform = NULL;
1530 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001531#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1532
XiaokangQian2b01dc32022-01-21 02:53:13 +00001533#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 mbedtls_ssl_transform_free(ssl->transform_application);
1535 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001536 ssl->transform_application = NULL;
1537
Gilles Peskine449bd832023-01-11 14:50:10 +01001538 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001539#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001540 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1541 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001542 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001543#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001544
Gilles Peskine449bd832023-01-11 14:50:10 +01001545 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1546 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001547 ssl->handshake->transform_handshake = NULL;
1548 }
1549
XiaokangQian2b01dc32022-01-21 02:53:13 +00001550#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001551}
1552
Gilles Peskine449bd832023-01-11 14:50:10 +01001553int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001554{
1555 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1556
1557 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001558 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001559
Gilles Peskine449bd832023-01-11 14:50:10 +01001560 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001561
1562 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001563#if defined(MBEDTLS_SSL_RENEGOTIATION)
1564 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001565 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001566
1567 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001568 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1569 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001570#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001571 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001572
Hanno Beckerb0302c42021-08-03 09:39:42 +01001573 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001574 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001575 if (ssl->session) {
1576 mbedtls_ssl_session_free(ssl->session);
1577 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001578 ssl->session = NULL;
1579 }
1580
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001581#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001582 ssl->alpn_chosen = NULL;
1583#endif
1584
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001585#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001586 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001587#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001588 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001589#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001590 if (free_cli_id) {
1591 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001592 ssl->cli_id = NULL;
1593 ssl->cli_id_len = 0;
1594 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001595#endif
1596
Gilles Peskine449bd832023-01-11 14:50:10 +01001597 if ((ret = ssl_handshake_init(ssl)) != 0) {
1598 return ret;
1599 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001600
Gilles Peskine449bd832023-01-11 14:50:10 +01001601 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001602}
1603
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001604/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001605 * Reset an initialized and used SSL context for re-use while retaining
1606 * all application-set variables, function pointers and data.
1607 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001608int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001609{
Gilles Peskine449bd832023-01-11 14:50:10 +01001610 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001611}
1612
1613/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001614 * SSL set accessors
1615 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001616void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001617{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001618 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001619}
1620
Gilles Peskine449bd832023-01-11 14:50:10 +01001621void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001622{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001623 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001624}
1625
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001626#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001627void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001628{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001629 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001630}
1631#endif
1632
Gilles Peskine449bd832023-01-11 14:50:10 +01001633void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001634{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001635 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001636}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001637
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001638#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001639
Gilles Peskine449bd832023-01-11 14:50:10 +01001640void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1641 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001642{
1643 ssl->disable_datagram_packing = !allow_packing;
1644}
1645
Gilles Peskine449bd832023-01-11 14:50:10 +01001646void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1647 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001648{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001649 conf->hs_timeout_min = min;
1650 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001651}
1652#endif
1653
Gilles Peskine449bd832023-01-11 14:50:10 +01001654void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001655{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001656 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001657}
1658
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001659#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001660void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1661 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1662 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001663{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001664 conf->f_vrfy = f_vrfy;
1665 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001666}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001667#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001668
Gilles Peskine449bd832023-01-11 14:50:10 +01001669void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1670 int (*f_rng)(void *, unsigned char *, size_t),
1671 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001672{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001673 conf->f_rng = f_rng;
1674 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001675}
1676
Gilles Peskine449bd832023-01-11 14:50:10 +01001677void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1678 void (*f_dbg)(void *, int, const char *, int, const char *),
1679 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001680{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001681 conf->f_dbg = f_dbg;
1682 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001683}
1684
Gilles Peskine449bd832023-01-11 14:50:10 +01001685void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1686 void *p_bio,
1687 mbedtls_ssl_send_t *f_send,
1688 mbedtls_ssl_recv_t *f_recv,
1689 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001690{
1691 ssl->p_bio = p_bio;
1692 ssl->f_send = f_send;
1693 ssl->f_recv = f_recv;
1694 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001695}
1696
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001697#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001698void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001699{
1700 ssl->mtu = mtu;
1701}
1702#endif
1703
Gilles Peskine449bd832023-01-11 14:50:10 +01001704void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001705{
1706 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001707}
1708
Gilles Peskine449bd832023-01-11 14:50:10 +01001709void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1710 void *p_timer,
1711 mbedtls_ssl_set_timer_t *f_set_timer,
1712 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001713{
1714 ssl->p_timer = p_timer;
1715 ssl->f_set_timer = f_set_timer;
1716 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001717
1718 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001719 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001720}
1721
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001722#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001723void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1724 void *p_cache,
1725 mbedtls_ssl_cache_get_t *f_get_cache,
1726 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001727{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001728 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001729 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001730 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001731}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001732#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001733
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001734#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001735int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001736{
Janos Follath865b3eb2019-12-16 11:46:15 +00001737 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001738
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001740 session == NULL ||
1741 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001742 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1743 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001744 }
1745
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 if (ssl->handshake->resume == 1) {
1747 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1748 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001749
Jerry Yu21092062022-10-10 21:21:31 +08001750#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001751 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron233fcaa2024-04-04 14:05:21 +02001752#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001753 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001754 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001755
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001757 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001758 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1759 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1760 session->ciphersuite));
1761 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001762 }
Ronald Cron233fcaa2024-04-04 14:05:21 +02001763#else
1764 /*
1765 * If session tickets are not enabled, it is not possible to resume a
1766 * TLS 1.3 session, thus do not make any change to the SSL context in
1767 * the first place.
1768 */
1769 return 0;
1770#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001771 }
Jerry Yu21092062022-10-10 21:21:31 +08001772#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001773
Gilles Peskine449bd832023-01-11 14:50:10 +01001774 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1775 session)) != 0) {
1776 return ret;
1777 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001778
Paul Bakker0a597072012-09-25 21:55:46 +00001779 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001780
Gilles Peskine449bd832023-01-11 14:50:10 +01001781 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001782}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001783#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001784
Gilles Peskine449bd832023-01-11 14:50:10 +01001785void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1786 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001787{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001788 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001789}
1790
Ronald Cron6f135e12021-12-08 16:57:54 +01001791#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001792void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1793 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001794{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001795 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001796}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001797
1798#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001799void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1800 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001801{
1802 conf->early_data_enabled = early_data_enabled;
1803}
Jerry Yucc4e0072022-11-22 17:22:22 +08001804
1805#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001806void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001807 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001808{
Jerry Yu39da9852022-12-06 16:58:36 +08001809 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001810}
1811#endif /* MBEDTLS_SSL_SRV_C */
1812
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001813#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001814#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001815
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001816#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001817void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1818 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001819{
1820 conf->cert_profile = profile;
1821}
1822
Gilles Peskine449bd832023-01-11 14:50:10 +01001823static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001824{
1825 mbedtls_ssl_key_cert *cur = key_cert, *next;
1826
Gilles Peskine449bd832023-01-11 14:50:10 +01001827 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001828 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001830 cur = next;
1831 }
1832}
1833
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001834/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001835MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001836static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1837 mbedtls_x509_crt *cert,
1838 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001839{
niisato8ee24222018-06-25 19:05:48 +09001840 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001841
Gilles Peskine449bd832023-01-11 14:50:10 +01001842 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001843 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001844 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001845 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001846 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001847 }
1848
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1850 if (new_cert == NULL) {
1851 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1852 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001853
niisato8ee24222018-06-25 19:05:48 +09001854 new_cert->cert = cert;
1855 new_cert->key = key;
1856 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001857
Glenn Strauss36872db2022-01-22 05:06:31 -05001858 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001860 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001862 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001863 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001864 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001865 }
niisato8ee24222018-06-25 19:05:48 +09001866 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001867 }
1868
Gilles Peskine449bd832023-01-11 14:50:10 +01001869 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001870}
1871
Gilles Peskine449bd832023-01-11 14:50:10 +01001872int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001873 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001874 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001875{
Gilles Peskine449bd832023-01-11 14:50:10 +01001876 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001877}
1878
Gilles Peskine449bd832023-01-11 14:50:10 +01001879void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001880 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001881 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001882{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001883 conf->ca_chain = ca_chain;
1884 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001885
1886#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1887 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1888 * cannot be used together. */
1889 conf->f_ca_cb = NULL;
1890 conf->p_ca_cb = NULL;
1891#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001892}
Hanno Becker5adaad92019-03-27 16:54:37 +00001893
1894#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001895void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1896 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1897 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001898{
1899 conf->f_ca_cb = f_ca_cb;
1900 conf->p_ca_cb = p_ca_cb;
1901
1902 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1903 * cannot be used together. */
1904 conf->ca_chain = NULL;
1905 conf->ca_crl = NULL;
1906}
1907#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001908#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001909
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001910#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001911const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1912 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001913{
1914 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001915 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001916}
1917
Gilles Peskine449bd832023-01-11 14:50:10 +01001918int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1919 mbedtls_x509_crt *own_cert,
1920 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001921{
Gilles Peskine449bd832023-01-11 14:50:10 +01001922 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1923 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001924}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001925
Gilles Peskine449bd832023-01-11 14:50:10 +01001926void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1927 mbedtls_x509_crt *ca_chain,
1928 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001929{
1930 ssl->handshake->sni_ca_chain = ca_chain;
1931 ssl->handshake->sni_ca_crl = ca_crl;
1932}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001933
Glenn Strauss999ef702022-03-11 01:37:23 -05001934#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001935void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1936 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001937{
1938 ssl->handshake->dn_hints = crt;
1939}
1940#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1941
Gilles Peskine449bd832023-01-11 14:50:10 +01001942void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1943 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001944{
1945 ssl->handshake->sni_authmode = authmode;
1946}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001947#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1948
Hanno Becker8927c832019-04-03 12:52:50 +01001949#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001950void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1951 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1952 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001953{
1954 ssl->f_vrfy = f_vrfy;
1955 ssl->p_vrfy = p_vrfy;
1956}
1957#endif
1958
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001959#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001960
Valerio Setti016f6822022-12-09 14:17:50 +01001961#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001962static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1963static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1964
Valerio Setti016f6822022-12-09 14:17:50 +01001965static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 mbedtls_ssl_context *ssl,
1967 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001968{
1969 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001970 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001971 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001972 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001973 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001974 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001975 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1976 psa_pake_cs_set_primitive(&cipher_suite,
1977 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1978 PSA_ECC_FAMILY_SECP_R1,
1979 256));
1980 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001981
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1983 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001984 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001986
Gilles Peskine449bd832023-01-11 14:50:10 +01001987 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001988 user = jpake_server_id;
1989 user_len = sizeof(jpake_server_id);
1990 peer = jpake_client_id;
1991 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001993 user = jpake_client_id;
1994 user_len = sizeof(jpake_client_id);
1995 peer = jpake_server_id;
1996 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001997 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001998
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001999 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
2000 if (status != PSA_SUCCESS) {
2001 return status;
2002 }
2003
2004 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002005 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01002006 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002007 }
Valerio Setti016f6822022-12-09 14:17:50 +01002008
Gilles Peskine449bd832023-01-11 14:50:10 +01002009 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
2010 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01002011 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002012 }
Valerio Setti016f6822022-12-09 14:17:50 +01002013
2014 ssl->handshake->psa_pake_ctx_is_ok = 1;
2015
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002017}
2018
Gilles Peskine449bd832023-01-11 14:50:10 +01002019int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2020 const unsigned char *pw,
2021 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002022{
2023 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2024 psa_status_t status;
2025
Gilles Peskine449bd832023-01-11 14:50:10 +01002026 if (ssl->handshake == NULL || ssl->conf == NULL) {
2027 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002028 }
2029
Gilles Peskine449bd832023-01-11 14:50:10 +01002030 /* Empty password is not valid */
2031 if ((pw == NULL) || (pw_len == 0)) {
2032 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2033 }
2034
2035 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2036 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2037 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2038
2039 status = psa_import_key(&attributes, pw, pw_len,
2040 &ssl->handshake->psa_pake_password);
2041 if (status != PSA_SUCCESS) {
2042 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2043 }
2044
2045 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2046 ssl->handshake->psa_pake_password);
2047 if (status != PSA_SUCCESS) {
2048 psa_destroy_key(ssl->handshake->psa_pake_password);
2049 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2050 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2051 }
2052
2053 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002054}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002055
Gilles Peskine449bd832023-01-11 14:50:10 +01002056int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2057 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002058{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002059 psa_status_t status;
2060
Gilles Peskine449bd832023-01-11 14:50:10 +01002061 if (ssl->handshake == NULL || ssl->conf == NULL) {
2062 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002063 }
2064
Gilles Peskine449bd832023-01-11 14:50:10 +01002065 if (mbedtls_svc_key_id_is_null(pwd)) {
2066 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2067 }
2068
2069 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2070 if (status != PSA_SUCCESS) {
2071 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2072 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2073 }
2074
2075 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002076}
2077#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002078int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2079 const unsigned char *pw,
2080 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002081{
2082 mbedtls_ecjpake_role role;
2083
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 if (ssl->handshake == NULL || ssl->conf == NULL) {
2085 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2086 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002087
Valerio Settic689ed82022-12-07 14:40:38 +01002088 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002089 if ((pw == NULL) || (pw_len == 0)) {
2090 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2091 }
Valerio Settic689ed82022-12-07 14:40:38 +01002092
Gilles Peskine449bd832023-01-11 14:50:10 +01002093 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002094 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002096 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002098
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2100 role,
2101 MBEDTLS_MD_SHA256,
2102 MBEDTLS_ECP_DP_SECP256R1,
2103 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002104}
Valerio Setti02c25b52022-11-15 14:08:42 +01002105#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002106#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002107
Ronald Cron73fe8df2022-10-05 14:31:43 +02002108#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002109int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002110{
Gilles Peskine449bd832023-01-11 14:50:10 +01002111 if (conf->psk_identity == NULL ||
2112 conf->psk_identity_len == 0) {
2113 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002114 }
2115
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002116#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2118 return 1;
2119 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002120#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002121
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 if (conf->psk != NULL && conf->psk_len != 0) {
2123 return 1;
2124 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002125
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002127}
2128
Gilles Peskine449bd832023-01-11 14:50:10 +01002129static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002130{
2131 /* Remove reference to existing PSK, if any. */
2132#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002134 /* The maintenance of the PSK key slot is the
2135 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002136 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002137 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002138#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002140 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002141 conf->psk = NULL;
2142 conf->psk_len = 0;
2143 }
2144
2145 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002146 if (conf->psk_identity != NULL) {
2147 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002148 conf->psk_identity = NULL;
2149 conf->psk_identity_len = 0;
2150 }
2151}
2152
Hanno Becker7390c712018-11-15 13:33:04 +00002153/* This function assumes that PSK identity in the SSL config is unset.
2154 * It checks that the provided identity is well-formed and attempts
2155 * to make a copy of it in the SSL config.
2156 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002157MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002158static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2159 unsigned char const *psk_identity,
2160 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002161{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002162 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002164 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002165 (psk_identity_len >> 16) != 0 ||
2166 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2167 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002168 }
2169
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2171 if (conf->psk_identity == NULL) {
2172 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2173 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002174
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002175 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002177
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002179}
2180
Gilles Peskine449bd832023-01-11 14:50:10 +01002181int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2182 const unsigned char *psk, size_t psk_len,
2183 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002184{
Janos Follath865b3eb2019-12-16 11:46:15 +00002185 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002186
2187 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2189 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2190 }
Hanno Becker7390c712018-11-15 13:33:04 +00002191
2192 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 if (psk == NULL) {
2194 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2195 }
2196 if (psk_len == 0) {
2197 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2198 }
2199 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2200 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2201 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002202
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2204 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2205 }
Hanno Becker7390c712018-11-15 13:33:04 +00002206 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002208
2209 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002210 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2211 if (ret != 0) {
2212 ssl_conf_remove_psk(conf);
2213 }
Hanno Becker7390c712018-11-15 13:33:04 +00002214
Gilles Peskine449bd832023-01-11 14:50:10 +01002215 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002216}
2217
Gilles Peskine449bd832023-01-11 14:50:10 +01002218static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002219{
2220#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002221 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002222 /* The maintenance of the external PSK key slot is the
2223 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002224 if (ssl->handshake->psk_opaque_is_internal) {
2225 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002226 ssl->handshake->psk_opaque_is_internal = 0;
2227 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002228 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002229 }
Neil Armstronge952a302022-05-03 10:22:14 +02002230#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002231 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002232 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002233 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002234 ssl->handshake->psk_len = 0;
lhuang0454adeab2024-06-10 12:16:29 -07002235 ssl->handshake->psk = NULL;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002236 }
Neil Armstronge952a302022-05-03 10:22:14 +02002237#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002238}
2239
Gilles Peskine449bd832023-01-11 14:50:10 +01002240int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2241 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002242{
Neil Armstrong501c9322022-05-03 09:35:09 +02002243#if defined(MBEDTLS_USE_PSA_CRYPTO)
2244 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002245 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002246 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002247 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002248#endif /* MBEDTLS_USE_PSA_CRYPTO */
2249
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 if (psk == NULL || ssl->handshake == NULL) {
2251 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2252 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002253
Gilles Peskine449bd832023-01-11 14:50:10 +01002254 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2255 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2256 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002257
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002259
Neil Armstrong501c9322022-05-03 09:35:09 +02002260#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002261#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2263 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2264 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2265 } else {
2266 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2267 }
2268 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002269 }
2270#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002271
Jerry Yu568ec252022-07-22 21:27:34 +08002272#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2274 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2275 psa_set_key_usage_flags(&key_attributes,
2276 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002277 }
2278#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2279
Gilles Peskine449bd832023-01-11 14:50:10 +01002280 psa_set_key_algorithm(&key_attributes, alg);
2281 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002282
Gilles Peskine449bd832023-01-11 14:50:10 +01002283 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2284 if (status != PSA_SUCCESS) {
2285 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2286 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002287
2288 /* Allow calling psa_destroy_key() on psk remove */
2289 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002290 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002291#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002292 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2293 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2294 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002295
2296 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002297 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002298
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002300#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002301}
2302
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002303#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002304int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2305 mbedtls_svc_key_id_t psk,
2306 const unsigned char *psk_identity,
2307 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002308{
Janos Follath865b3eb2019-12-16 11:46:15 +00002309 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002310
2311 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2313 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2314 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002315
Hanno Becker7390c712018-11-15 13:33:04 +00002316 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 if (mbedtls_svc_key_id_is_null(psk)) {
2318 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2319 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002320 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002321
2322 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2324 psk_identity_len);
2325 if (ret != 0) {
2326 ssl_conf_remove_psk(conf);
2327 }
Hanno Becker7390c712018-11-15 13:33:04 +00002328
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002330}
2331
Gilles Peskine449bd832023-01-11 14:50:10 +01002332int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2333 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002334{
Gilles Peskine449bd832023-01-11 14:50:10 +01002335 if ((mbedtls_svc_key_id_is_null(psk)) ||
2336 (ssl->handshake == NULL)) {
2337 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2338 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002339
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002341 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002342 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002343}
2344#endif /* MBEDTLS_USE_PSA_CRYPTO */
2345
Jerry Yu8897c072022-08-12 13:56:53 +08002346#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002347void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2348 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2349 size_t),
2350 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002351{
2352 conf->f_psk = f_psk;
2353 conf->p_psk = p_psk;
2354}
Jerry Yu8897c072022-08-12 13:56:53 +08002355#endif /* MBEDTLS_SSL_SRV_C */
2356
Ronald Cron73fe8df2022-10-05 14:31:43 +02002357#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002358
2359#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002360static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002362{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002363#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002364 if (alg == PSA_ALG_CBC_NO_PADDING) {
2365 return MBEDTLS_SSL_MODE_CBC;
2366 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002367#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 if (PSA_ALG_IS_AEAD(alg)) {
2369 return MBEDTLS_SSL_MODE_AEAD;
2370 }
2371 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002372}
2373
2374#else /* MBEDTLS_USE_PSA_CRYPTO */
2375
2376static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002378{
2379#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 if (mode == MBEDTLS_MODE_CBC) {
2381 return MBEDTLS_SSL_MODE_CBC;
2382 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002383#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2384
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002385#if defined(MBEDTLS_GCM_C) || \
2386 defined(MBEDTLS_CCM_C) || \
2387 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002389 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002390 mode == MBEDTLS_MODE_CHACHAPOLY) {
2391 return MBEDTLS_SSL_MODE_AEAD;
2392 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002393#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002394
Gilles Peskine449bd832023-01-11 14:50:10 +01002395 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002396}
Gilles Peskine301711e2022-04-26 16:57:05 +02002397#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002398
Gilles Peskinee108d982022-04-26 16:50:40 +02002399static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2400 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002402{
2403#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2405 base_mode == MBEDTLS_SSL_MODE_CBC) {
2406 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002407 }
2408#else
2409 (void) encrypt_then_mac;
2410#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002411 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002412}
2413
Neil Armstrongab555e02022-04-04 11:07:59 +02002414mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002416{
Gilles Peskinee108d982022-04-26 16:50:40 +02002417 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002418#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002419 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002420#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002421 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002422#endif
2423 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002424
Gilles Peskinee108d982022-04-26 16:50:40 +02002425 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002426#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002427 encrypt_then_mac = transform->encrypt_then_mac;
2428#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002429 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002430}
2431
Neil Armstrongab555e02022-04-04 11:07:59 +02002432mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002433#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002435#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002437{
Gilles Peskinee108d982022-04-26 16:50:40 +02002438 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2439
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002440#if defined(MBEDTLS_USE_PSA_CRYPTO)
2441 psa_status_t status;
2442 psa_algorithm_t alg;
2443 psa_key_type_t type;
2444 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002445 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2446 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 if (status == PSA_SUCCESS) {
2448 base_mode = mbedtls_ssl_get_base_mode(alg);
2449 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002450#else
2451 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002452 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002454 base_mode =
2455 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002456 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002457 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002458#endif /* MBEDTLS_USE_PSA_CRYPTO */
2459
Gilles Peskinee108d982022-04-26 16:50:40 +02002460#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2461 int encrypt_then_mac = 0;
2462#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002464}
2465
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002466#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002467
Ronald Cron8b592d22024-11-12 18:08:25 +01002468const mbedtls_error_pair_t psa_to_ssl_errors[] =
2469{
2470 { PSA_SUCCESS, 0 },
2471 { PSA_ERROR_INSUFFICIENT_MEMORY, MBEDTLS_ERR_SSL_ALLOC_FAILED },
2472 { PSA_ERROR_NOT_SUPPORTED, MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE },
2473 { PSA_ERROR_INVALID_SIGNATURE, MBEDTLS_ERR_SSL_INVALID_MAC },
2474 { PSA_ERROR_INVALID_ARGUMENT, MBEDTLS_ERR_SSL_BAD_INPUT_DATA },
2475 { PSA_ERROR_BAD_STATE, MBEDTLS_ERR_SSL_INTERNAL_ERROR },
2476 { PSA_ERROR_BUFFER_TOO_SMALL, MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL }
2477};
2478
Gilles Peskine449bd832023-01-11 14:50:10 +01002479psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2480 size_t taglen,
2481 psa_algorithm_t *alg,
2482 psa_key_type_t *key_type,
2483 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002484{
Elena Uziunaitec2561722024-07-05 11:37:33 +01002485#if !defined(PSA_WANT_ALG_CCM)
Yanray Wang19e4dc82023-11-16 18:02:05 +08002486 (void) taglen;
2487#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002488 switch (mbedtls_cipher_type) {
Elena Uziunaite74342c72024-07-05 11:31:29 +01002489#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002490 case MBEDTLS_CIPHER_AES_128_CBC:
2491 *alg = PSA_ALG_CBC_NO_PADDING;
2492 *key_type = PSA_KEY_TYPE_AES;
2493 *key_size = 128;
2494 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002495#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002496#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002497 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002498 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002499 *key_type = PSA_KEY_TYPE_AES;
2500 *key_size = 128;
2501 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002502#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002503#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002504 case MBEDTLS_CIPHER_AES_128_GCM:
2505 *alg = PSA_ALG_GCM;
2506 *key_type = PSA_KEY_TYPE_AES;
2507 *key_size = 128;
2508 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002509#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002510#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002511 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002513 *key_type = PSA_KEY_TYPE_AES;
2514 *key_size = 192;
2515 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002516#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002517#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002518 case MBEDTLS_CIPHER_AES_192_GCM:
2519 *alg = PSA_ALG_GCM;
2520 *key_type = PSA_KEY_TYPE_AES;
2521 *key_size = 192;
2522 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002523#endif
Elena Uziunaite74342c72024-07-05 11:31:29 +01002524#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002525 case MBEDTLS_CIPHER_AES_256_CBC:
2526 *alg = PSA_ALG_CBC_NO_PADDING;
2527 *key_type = PSA_KEY_TYPE_AES;
2528 *key_size = 256;
2529 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002530#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002531#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002532 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002533 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002534 *key_type = PSA_KEY_TYPE_AES;
2535 *key_size = 256;
2536 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002537#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002538#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002539 case MBEDTLS_CIPHER_AES_256_GCM:
2540 *alg = PSA_ALG_GCM;
2541 *key_type = PSA_KEY_TYPE_AES;
2542 *key_size = 256;
2543 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002544#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002545#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002546 case MBEDTLS_CIPHER_ARIA_128_CBC:
2547 *alg = PSA_ALG_CBC_NO_PADDING;
2548 *key_type = PSA_KEY_TYPE_ARIA;
2549 *key_size = 128;
2550 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002551#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002552#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002553 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002555 *key_type = PSA_KEY_TYPE_ARIA;
2556 *key_size = 128;
2557 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002558#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002559#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002560 case MBEDTLS_CIPHER_ARIA_128_GCM:
2561 *alg = PSA_ALG_GCM;
2562 *key_type = PSA_KEY_TYPE_ARIA;
2563 *key_size = 128;
2564 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002565#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002566#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002567 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002569 *key_type = PSA_KEY_TYPE_ARIA;
2570 *key_size = 192;
2571 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002572#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002573#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002574 case MBEDTLS_CIPHER_ARIA_192_GCM:
2575 *alg = PSA_ALG_GCM;
2576 *key_type = PSA_KEY_TYPE_ARIA;
2577 *key_size = 192;
2578 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002579#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002580#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002581 case MBEDTLS_CIPHER_ARIA_256_CBC:
2582 *alg = PSA_ALG_CBC_NO_PADDING;
2583 *key_type = PSA_KEY_TYPE_ARIA;
2584 *key_size = 256;
2585 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002586#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002587#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002588 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002590 *key_type = PSA_KEY_TYPE_ARIA;
2591 *key_size = 256;
2592 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002593#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002594#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002595 case MBEDTLS_CIPHER_ARIA_256_GCM:
2596 *alg = PSA_ALG_GCM;
2597 *key_type = PSA_KEY_TYPE_ARIA;
2598 *key_size = 256;
2599 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002600#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002601#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002602 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2603 *alg = PSA_ALG_CBC_NO_PADDING;
2604 *key_type = PSA_KEY_TYPE_CAMELLIA;
2605 *key_size = 128;
2606 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002607#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002608#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002609 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002611 *key_type = PSA_KEY_TYPE_CAMELLIA;
2612 *key_size = 128;
2613 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002614#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002615#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002616 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2617 *alg = PSA_ALG_GCM;
2618 *key_type = PSA_KEY_TYPE_CAMELLIA;
2619 *key_size = 128;
2620 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002621#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002622#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002623 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002624 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002625 *key_type = PSA_KEY_TYPE_CAMELLIA;
2626 *key_size = 192;
2627 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002628#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002629#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002630 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2631 *alg = PSA_ALG_GCM;
2632 *key_type = PSA_KEY_TYPE_CAMELLIA;
2633 *key_size = 192;
2634 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002635#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002636#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002637 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2638 *alg = PSA_ALG_CBC_NO_PADDING;
2639 *key_type = PSA_KEY_TYPE_CAMELLIA;
2640 *key_size = 256;
2641 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002642#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002643#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002644 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002646 *key_type = PSA_KEY_TYPE_CAMELLIA;
2647 *key_size = 256;
2648 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002649#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002650#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002651 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2652 *alg = PSA_ALG_GCM;
2653 *key_type = PSA_KEY_TYPE_CAMELLIA;
2654 *key_size = 256;
2655 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002656#endif
Elena Uziunaite5c70c302024-07-05 11:44:44 +01002657#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002658 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2659 *alg = PSA_ALG_CHACHA20_POLY1305;
2660 *key_type = PSA_KEY_TYPE_CHACHA20;
2661 *key_size = 256;
2662 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002663#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002664 case MBEDTLS_CIPHER_NULL:
2665 *alg = MBEDTLS_SSL_NULL_CIPHER;
2666 *key_type = 0;
2667 *key_size = 0;
2668 break;
2669 default:
2670 return PSA_ERROR_NOT_SUPPORTED;
2671 }
2672
2673 return PSA_SUCCESS;
2674}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002675#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002676
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002677#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002678int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2679 const unsigned char *dhm_P, size_t P_len,
2680 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002681{
Janos Follath865b3eb2019-12-16 11:46:15 +00002682 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002683
Gilles Peskine449bd832023-01-11 14:50:10 +01002684 mbedtls_mpi_free(&conf->dhm_P);
2685 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002686
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2688 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2689 mbedtls_mpi_free(&conf->dhm_P);
2690 mbedtls_mpi_free(&conf->dhm_G);
2691 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002692 }
2693
Gilles Peskine449bd832023-01-11 14:50:10 +01002694 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002695}
Paul Bakker5121ce52009-01-03 21:22:43 +00002696
Gilles Peskine449bd832023-01-11 14:50:10 +01002697int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002698{
Janos Follath865b3eb2019-12-16 11:46:15 +00002699 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002700
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 mbedtls_mpi_free(&conf->dhm_P);
2702 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002703
Gilles Peskine449bd832023-01-11 14:50:10 +01002704 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2705 &conf->dhm_P)) != 0 ||
2706 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2707 &conf->dhm_G)) != 0) {
2708 mbedtls_mpi_free(&conf->dhm_P);
2709 mbedtls_mpi_free(&conf->dhm_G);
2710 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002711 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002712
Gilles Peskine449bd832023-01-11 14:50:10 +01002713 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002714}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002715#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002716
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002717#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2718/*
2719 * Set the minimum length for Diffie-Hellman parameters
2720 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002721void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2722 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002723{
2724 conf->dhm_min_bitlen = bitlen;
2725}
2726#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2727
Ronald Crone68ab4f2022-10-05 12:46:29 +02002728#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002729#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002730/*
2731 * Set allowed/preferred hashes for handshake signatures
2732 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002733void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2734 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002735{
2736 conf->sig_hashes = hashes;
2737}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002738#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002739
Jerry Yuf017ee42022-01-12 15:49:48 +08002740/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002741void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2742 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002743{
Jerry Yuf017ee42022-01-12 15:49:48 +08002744#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2745 conf->sig_hashes = NULL;
2746#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2747 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002748}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002749#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002750
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002751#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002752#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002753/*
2754 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002755 *
2756 * mbedtls_ssl_setup() takes the provided list
2757 * and translates it to a list of IANA TLS group identifiers,
2758 * stored in ssl->handshake->group_list.
2759 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002760 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002761void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2762 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002763{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002764 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002765 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002766}
Brett Warrene0edc842021-08-17 09:53:13 +01002767#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002768#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002769
Brett Warrene0edc842021-08-17 09:53:13 +01002770/*
2771 * Set the allowed groups
2772 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002773void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2774 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002775{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002776#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002777 conf->curve_list = NULL;
2778#endif
2779 conf->group_list = group_list;
2780}
2781
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002782#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002783int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002784{
Hanno Becker947194e2017-04-07 13:25:49 +01002785 /* Initialize to suppress unnecessary compiler warning */
2786 size_t hostname_len = 0;
2787
2788 /* Check if new hostname is valid before
2789 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 if (hostname != NULL) {
2791 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002792
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2794 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2795 }
Hanno Becker947194e2017-04-07 13:25:49 +01002796 }
2797
2798 /* Now it's clear that we will overwrite the old hostname,
2799 * so we can free it safely */
2800
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002802 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002803 }
2804
2805 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002806
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002808 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 } else {
2810 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2811 if (ssl->hostname == NULL) {
2812 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2813 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002814
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002816
Hanno Becker947194e2017-04-07 13:25:49 +01002817 ssl->hostname[hostname_len] = '\0';
2818 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002819
Gilles Peskine449bd832023-01-11 14:50:10 +01002820 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002821}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002822#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002823
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002824#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002825void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2826 int (*f_sni)(void *, mbedtls_ssl_context *,
2827 const unsigned char *, size_t),
2828 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002829{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002830 conf->f_sni = f_sni;
2831 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002832}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002833#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002834
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002835#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002836int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002837{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002838 size_t cur_len, tot_len;
2839 const char **p;
2840
2841 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002842 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2843 * MUST NOT be truncated."
2844 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002845 */
2846 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 for (p = protos; *p != NULL; p++) {
2848 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002849 tot_len += cur_len;
2850
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 if ((cur_len == 0) ||
2852 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2853 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2854 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2855 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002856 }
2857
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002858 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002859
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002861}
2862
Gilles Peskine449bd832023-01-11 14:50:10 +01002863const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002864{
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002866}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002867#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002868
Johan Pascalb62bb512015-12-03 21:56:45 +01002869#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002870void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2871 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002872{
2873 conf->dtls_srtp_mki_support = support_mki_value;
2874}
2875
Gilles Peskine449bd832023-01-11 14:50:10 +01002876int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2877 unsigned char *mki_value,
2878 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002879{
Gilles Peskine449bd832023-01-11 14:50:10 +01002880 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2881 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002882 }
Ron Eldor591f1622018-01-22 12:30:04 +02002883
Gilles Peskine449bd832023-01-11 14:50:10 +01002884 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2885 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002886 }
Ron Eldor591f1622018-01-22 12:30:04 +02002887
Gilles Peskine449bd832023-01-11 14:50:10 +01002888 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002889 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002890 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002891}
2892
Gilles Peskine449bd832023-01-11 14:50:10 +01002893int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2894 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002895{
Johan Pascal253d0262020-09-22 13:04:45 +02002896 const mbedtls_ssl_srtp_profile *p;
2897 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002898
Johan Pascal253d0262020-09-22 13:04:45 +02002899 /* check the profiles list: all entry must be valid,
2900 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002901 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2902 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2903 p++) {
2904 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002905 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002907 /* unsupported value, stop parsing and set the size to an error value */
2908 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002909 }
2910 }
2911
Gilles Peskine449bd832023-01-11 14:50:10 +01002912 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2913 conf->dtls_srtp_profile_list = NULL;
2914 conf->dtls_srtp_profile_list_len = 0;
2915 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002916 }
2917
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002918 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002919 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002920
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002922}
2923
Gilles Peskine449bd832023-01-11 14:50:10 +01002924void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2925 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002926{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002927 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2928 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002929 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002930 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002932 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2934 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002935 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002936}
Johan Pascalb62bb512015-12-03 21:56:45 +01002937#endif /* MBEDTLS_SSL_DTLS_SRTP */
2938
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302939#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002940void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002941{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002942 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002943}
2944
Gilles Peskine449bd832023-01-11 14:50:10 +01002945void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002946{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002947 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002948}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302949#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002950
Janos Follath088ce432017-04-10 12:42:31 +01002951#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002952void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2953 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002954{
2955 conf->cert_req_ca_list = cert_req_ca_list;
2956}
2957#endif
2958
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002959#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002960void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002961{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002962 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002963}
2964#endif
2965
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002966#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002967void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002968{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002969 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002970}
2971#endif
2972
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002973#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002974int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002975{
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2977 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2978 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002979 }
2980
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002981 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002982
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002984}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002985#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002986
Gilles Peskine449bd832023-01-11 14:50:10 +01002987void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002988{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002989 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002990}
2991
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002992#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002993void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002994{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002995 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002996}
2997
Gilles Peskine449bd832023-01-11 14:50:10 +01002998void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002999{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003000 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003001}
3002
Gilles Peskine449bd832023-01-11 14:50:10 +01003003void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3004 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003005{
Gilles Peskine449bd832023-01-11 14:50:10 +01003006 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003007}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003008#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003009
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003010#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003011#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003012void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003013{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003014 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003015}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003016#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003017
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003018#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003019
Jerry Yud0766ec2022-09-22 10:46:57 +08003020#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003021void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3022 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003023{
Jerry Yud0766ec2022-09-22 10:46:57 +08003024 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003025}
3026#endif
3027
Gilles Peskine449bd832023-01-11 14:50:10 +01003028void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3029 mbedtls_ssl_ticket_write_t *f_ticket_write,
3030 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3031 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003032{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003033 conf->f_ticket_write = f_ticket_write;
3034 conf->f_ticket_parse = f_ticket_parse;
3035 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003036}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003037#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003038#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003039
Gilles Peskine449bd832023-01-11 14:50:10 +01003040void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3041 mbedtls_ssl_export_keys_t *f_export_keys,
3042 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003043{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003044 ssl->f_export_keys = f_export_keys;
3045 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003046}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003047
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003048#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003049void mbedtls_ssl_conf_async_private_cb(
3050 mbedtls_ssl_config *conf,
3051 mbedtls_ssl_async_sign_t *f_async_sign,
3052 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3053 mbedtls_ssl_async_resume_t *f_async_resume,
3054 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003056{
3057 conf->f_async_sign_start = f_async_sign;
3058 conf->f_async_decrypt_start = f_async_decrypt;
3059 conf->f_async_resume = f_async_resume;
3060 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003061 conf->p_async_config_data = async_config_data;
3062}
3063
Gilles Peskine449bd832023-01-11 14:50:10 +01003064void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003065{
Gilles Peskine449bd832023-01-11 14:50:10 +01003066 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003067}
3068
Gilles Peskine449bd832023-01-11 14:50:10 +01003069void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003070{
Gilles Peskine449bd832023-01-11 14:50:10 +01003071 if (ssl->handshake == NULL) {
3072 return NULL;
3073 } else {
3074 return ssl->handshake->user_async_ctx;
3075 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003076}
3077
Gilles Peskine449bd832023-01-11 14:50:10 +01003078void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3079 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003080{
Gilles Peskine449bd832023-01-11 14:50:10 +01003081 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003082 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003083 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003084}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003085#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003086
Paul Bakker5121ce52009-01-03 21:22:43 +00003087/*
3088 * SSL get accessors
3089 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003090uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003091{
Gilles Peskine449bd832023-01-11 14:50:10 +01003092 if (ssl->session != NULL) {
3093 return ssl->session->verify_result;
3094 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003095
Gilles Peskine449bd832023-01-11 14:50:10 +01003096 if (ssl->session_negotiate != NULL) {
3097 return ssl->session_negotiate->verify_result;
3098 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003099
Gilles Peskine449bd832023-01-11 14:50:10 +01003100 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003101}
3102
Gilles Peskine449bd832023-01-11 14:50:10 +01003103int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003104{
Gilles Peskine449bd832023-01-11 14:50:10 +01003105 if (ssl == NULL || ssl->session == NULL) {
3106 return 0;
3107 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003108
Gilles Peskine449bd832023-01-11 14:50:10 +01003109 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003110}
3111
Gilles Peskine449bd832023-01-11 14:50:10 +01003112const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003113{
Gilles Peskine449bd832023-01-11 14:50:10 +01003114 if (ssl == NULL || ssl->session == NULL) {
3115 return NULL;
3116 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003117
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003119}
3120
Gilles Peskine449bd832023-01-11 14:50:10 +01003121const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003122{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003123#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003124 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3125 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003126 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003128 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003129 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003130 }
3131 }
3132#endif
3133
Gilles Peskine449bd832023-01-11 14:50:10 +01003134 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003135 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003136 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003137 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003138 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003139 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003140 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003141 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003142}
3143
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003144#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3145
3146size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3147{
3148 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3149 size_t record_size_limit = max_len;
3150
3151 if (ssl->session != NULL &&
3152 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3153 ssl->session->record_size_limit < max_len) {
3154 record_size_limit = ssl->session->record_size_limit;
3155 }
3156
3157 // TODO: this is currently untested
3158 /* During a handshake, use the value being negotiated */
3159 if (ssl->session_negotiate != NULL &&
3160 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3161 ssl->session_negotiate->record_size_limit < max_len) {
3162 record_size_limit = ssl->session_negotiate->record_size_limit;
3163 }
3164
3165 return record_size_limit;
3166}
3167#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3168
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003169#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003170size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003171{
David Horstmann95d516f2021-05-04 18:36:56 +01003172 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003173 size_t read_mfl;
3174
Jerry Yuddda0502022-12-01 19:43:12 +08003175#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003176 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003177 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3178 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3179 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003180 }
Jerry Yuddda0502022-12-01 19:43:12 +08003181#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003182
3183 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003184 if (ssl->session_out != NULL) {
3185 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3186 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003187 max_len = read_mfl;
3188 }
3189 }
3190
Jerry Yuddda0502022-12-01 19:43:12 +08003191 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003192 if (ssl->session_negotiate != NULL) {
3193 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3194 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003195 max_len = read_mfl;
3196 }
3197 }
3198
Gilles Peskine449bd832023-01-11 14:50:10 +01003199 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003200}
3201
Gilles Peskine449bd832023-01-11 14:50:10 +01003202size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003203{
3204 size_t max_len;
3205
3206 /*
3207 * Assume mfl_code is correct since it was checked when set
3208 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003209 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003210
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003211 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 if (ssl->session_out != NULL &&
3213 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3214 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003215 }
3216
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003217 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003218 if (ssl->session_negotiate != NULL &&
3219 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3220 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003221 }
3222
Gilles Peskine449bd832023-01-11 14:50:10 +01003223 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003224}
3225#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3226
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003227#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003228size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003229{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003230 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003231 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3232 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3233 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3234 return 0;
3235 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003236
Gilles Peskine449bd832023-01-11 14:50:10 +01003237 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3238 return ssl->mtu;
3239 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003240
Gilles Peskine449bd832023-01-11 14:50:10 +01003241 if (ssl->mtu == 0) {
3242 return ssl->handshake->mtu;
3243 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003244
Gilles Peskine449bd832023-01-11 14:50:10 +01003245 return ssl->mtu < ssl->handshake->mtu ?
3246 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003247}
3248#endif /* MBEDTLS_SSL_PROTO_DTLS */
3249
Gilles Peskine449bd832023-01-11 14:50:10 +01003250int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003251{
3252 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3253
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003254#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003255 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003256 !defined(MBEDTLS_SSL_PROTO_DTLS)
3257 (void) ssl;
3258#endif
3259
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003260#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003261 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003262
Gilles Peskine449bd832023-01-11 14:50:10 +01003263 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003264 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003265 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003266#endif
3267
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003268#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3269 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3270
3271 if (max_len > record_size_limit) {
3272 max_len = record_size_limit;
3273 }
3274#endif
3275
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003276 if (ssl->transform_out != NULL &&
3277 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003278 /*
3279 * In TLS 1.3 case, when records are protected, `max_len` as computed
3280 * above is the maximum length of the TLSInnerPlaintext structure that
3281 * along the plaintext payload contains the inner content type (one byte)
3282 * and some zero padding. Given the algorithm used for padding
3283 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3284 * the plaintext payload. Round down to a multiple of
3285 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3286 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003287 */
3288 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3289 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3290 }
3291
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003292#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003293 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3294 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3295 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003296 const size_t overhead = (size_t) ret;
3297
Gilles Peskine449bd832023-01-11 14:50:10 +01003298 if (ret < 0) {
3299 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003300 }
3301
Gilles Peskine449bd832023-01-11 14:50:10 +01003302 if (mtu <= overhead) {
3303 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3304 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3305 }
3306
3307 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003308 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003309 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003310 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003311#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003312
Hanno Becker0defedb2018-08-10 12:35:02 +01003313#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003314 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3315 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003316 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003317#endif
3318
Gilles Peskine449bd832023-01-11 14:50:10 +01003319 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003320}
3321
Gilles Peskine449bd832023-01-11 14:50:10 +01003322int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003323{
3324 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3325
3326#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3327 (void) ssl;
3328#endif
3329
3330#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003331 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003332
Gilles Peskine449bd832023-01-11 14:50:10 +01003333 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003334 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003335 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003336#endif
3337
Gilles Peskine449bd832023-01-11 14:50:10 +01003338 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003339}
3340
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003341#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003342const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003343{
Gilles Peskine449bd832023-01-11 14:50:10 +01003344 if (ssl == NULL || ssl->session == NULL) {
3345 return NULL;
3346 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003347
Hanno Beckere6824572019-02-07 13:18:46 +00003348#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003349 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003350#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003351 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003352#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003353}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003354#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003355
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003356#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003357int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3358 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003359{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003360 int ret;
3361
Gilles Peskine449bd832023-01-11 14:50:10 +01003362 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003363 dst == NULL ||
3364 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003365 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3366 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003367 }
3368
Hanno Beckere810bbc2021-05-14 16:01:05 +01003369 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3370 * idempotent: Each session can only be exported once.
3371 *
3372 * (This is in preparation for TLS 1.3 support where we will
3373 * need the ability to export multiple sessions (aka tickets),
3374 * which will be achieved by calling mbedtls_ssl_get_session()
3375 * multiple times until it fails.)
3376 *
3377 * Check whether we have already exported the current session,
3378 * and fail if so.
3379 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003380 if (ssl->session->exported == 1) {
3381 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3382 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003383
Gilles Peskine449bd832023-01-11 14:50:10 +01003384 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3385 if (ret != 0) {
3386 return ret;
3387 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003388
3389 /* Remember that we've exported the session. */
3390 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003391 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003392}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003393#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003394
David Horstmanncb01b362024-02-29 17:31:46 +00003395#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3396
3397/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003398 *
David Horstmanncb01b362024-02-29 17:31:46 +00003399 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003400 */
3401static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3402 unsigned char *buf,
3403 size_t buf_len)
3404{
3405 unsigned char *p = buf;
3406 size_t used = 0;
3407
3408#if defined(MBEDTLS_HAVE_TIME)
3409 uint64_t start;
3410#endif
3411#if defined(MBEDTLS_X509_CRT_PARSE_C)
3412#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3413 size_t cert_len;
3414#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3415#endif /* MBEDTLS_X509_CRT_PARSE_C */
3416
3417 /*
3418 * Time
3419 */
3420#if defined(MBEDTLS_HAVE_TIME)
3421 used += 8;
3422
3423 if (used <= buf_len) {
3424 start = (uint64_t) session->start;
3425
3426 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3427 p += 8;
3428 }
3429#endif /* MBEDTLS_HAVE_TIME */
3430
3431 /*
3432 * Basic mandatory fields
3433 */
3434 used += 1 /* id_len */
3435 + sizeof(session->id)
3436 + sizeof(session->master)
3437 + 4; /* verify_result */
3438
3439 if (used <= buf_len) {
3440 *p++ = MBEDTLS_BYTE_0(session->id_len);
3441 memcpy(p, session->id, 32);
3442 p += 32;
3443
3444 memcpy(p, session->master, 48);
3445 p += 48;
3446
3447 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3448 p += 4;
3449 }
3450
3451 /*
3452 * Peer's end-entity certificate
3453 */
3454#if defined(MBEDTLS_X509_CRT_PARSE_C)
3455#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3456 if (session->peer_cert == NULL) {
3457 cert_len = 0;
3458 } else {
3459 cert_len = session->peer_cert->raw.len;
3460 }
3461
3462 used += 3 + cert_len;
3463
3464 if (used <= buf_len) {
3465 *p++ = MBEDTLS_BYTE_2(cert_len);
3466 *p++ = MBEDTLS_BYTE_1(cert_len);
3467 *p++ = MBEDTLS_BYTE_0(cert_len);
3468
3469 if (session->peer_cert != NULL) {
3470 memcpy(p, session->peer_cert->raw.p, cert_len);
3471 p += cert_len;
3472 }
3473 }
3474#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3475 if (session->peer_cert_digest != NULL) {
3476 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3477 if (used <= buf_len) {
3478 *p++ = (unsigned char) session->peer_cert_digest_type;
3479 *p++ = (unsigned char) session->peer_cert_digest_len;
3480 memcpy(p, session->peer_cert_digest,
3481 session->peer_cert_digest_len);
3482 p += session->peer_cert_digest_len;
3483 }
3484 } else {
3485 used += 2;
3486 if (used <= buf_len) {
3487 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3488 *p++ = 0;
3489 }
3490 }
3491#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3492#endif /* MBEDTLS_X509_CRT_PARSE_C */
3493
3494 /*
3495 * Session ticket if any, plus associated data
3496 */
3497#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3498#if defined(MBEDTLS_SSL_CLI_C)
3499 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3500 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3501
3502 if (used <= buf_len) {
3503 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3504 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3505 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3506
3507 if (session->ticket != NULL) {
3508 memcpy(p, session->ticket, session->ticket_len);
3509 p += session->ticket_len;
3510 }
3511
3512 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3513 p += 4;
3514 }
3515 }
3516#endif /* MBEDTLS_SSL_CLI_C */
3517#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3518 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3519 used += 8;
3520
3521 if (used <= buf_len) {
3522 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3523 p += 8;
3524 }
3525 }
3526#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3527#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3528
3529 /*
3530 * Misc extension-related info
3531 */
3532#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3533 used += 1;
3534
3535 if (used <= buf_len) {
3536 *p++ = session->mfl_code;
3537 }
3538#endif
3539
3540#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3541 used += 1;
3542
3543 if (used <= buf_len) {
3544 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3545 }
3546#endif
3547
3548 return used;
3549}
3550
3551MBEDTLS_CHECK_RETURN_CRITICAL
3552static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3553 const unsigned char *buf,
3554 size_t len)
3555{
3556#if defined(MBEDTLS_HAVE_TIME)
3557 uint64_t start;
3558#endif
3559#if defined(MBEDTLS_X509_CRT_PARSE_C)
3560#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3561 size_t cert_len;
3562#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3563#endif /* MBEDTLS_X509_CRT_PARSE_C */
3564
3565 const unsigned char *p = buf;
3566 const unsigned char * const end = buf + len;
3567
3568 /*
3569 * Time
3570 */
3571#if defined(MBEDTLS_HAVE_TIME)
3572 if (8 > (size_t) (end - p)) {
3573 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3574 }
3575
3576 start = MBEDTLS_GET_UINT64_BE(p, 0);
3577 p += 8;
3578
3579 session->start = (time_t) start;
3580#endif /* MBEDTLS_HAVE_TIME */
3581
3582 /*
3583 * Basic mandatory fields
3584 */
3585 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3586 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3587 }
3588
3589 session->id_len = *p++;
3590 memcpy(session->id, p, 32);
3591 p += 32;
3592
3593 memcpy(session->master, p, 48);
3594 p += 48;
3595
3596 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3597 p += 4;
3598
3599 /* Immediately clear invalid pointer values that have been read, in case
3600 * we exit early before we replaced them with valid ones. */
3601#if defined(MBEDTLS_X509_CRT_PARSE_C)
3602#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3603 session->peer_cert = NULL;
3604#else
3605 session->peer_cert_digest = NULL;
3606#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3607#endif /* MBEDTLS_X509_CRT_PARSE_C */
3608#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3609 session->ticket = NULL;
3610#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3611
3612 /*
3613 * Peer certificate
3614 */
3615#if defined(MBEDTLS_X509_CRT_PARSE_C)
3616#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3617 /* Deserialize CRT from the end of the ticket. */
3618 if (3 > (size_t) (end - p)) {
3619 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3620 }
3621
3622 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3623 p += 3;
3624
3625 if (cert_len != 0) {
3626 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3627
3628 if (cert_len > (size_t) (end - p)) {
3629 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3630 }
3631
3632 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3633
3634 if (session->peer_cert == NULL) {
3635 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3636 }
3637
3638 mbedtls_x509_crt_init(session->peer_cert);
3639
3640 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3641 p, cert_len)) != 0) {
3642 mbedtls_x509_crt_free(session->peer_cert);
3643 mbedtls_free(session->peer_cert);
3644 session->peer_cert = NULL;
3645 return ret;
3646 }
3647
3648 p += cert_len;
3649 }
3650#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3651 /* Deserialize CRT digest from the end of the ticket. */
3652 if (2 > (size_t) (end - p)) {
3653 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3654 }
3655
3656 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3657 session->peer_cert_digest_len = (size_t) *p++;
3658
3659 if (session->peer_cert_digest_len != 0) {
3660 const mbedtls_md_info_t *md_info =
3661 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3662 if (md_info == NULL) {
3663 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3664 }
3665 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3666 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3667 }
3668
3669 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3670 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3671 }
3672
3673 session->peer_cert_digest =
3674 mbedtls_calloc(1, session->peer_cert_digest_len);
3675 if (session->peer_cert_digest == NULL) {
3676 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3677 }
3678
3679 memcpy(session->peer_cert_digest, p,
3680 session->peer_cert_digest_len);
3681 p += session->peer_cert_digest_len;
3682 }
3683#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3684#endif /* MBEDTLS_X509_CRT_PARSE_C */
3685
3686 /*
3687 * Session ticket and associated data
3688 */
3689#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3690#if defined(MBEDTLS_SSL_CLI_C)
3691 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3692 if (3 > (size_t) (end - p)) {
3693 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3694 }
3695
3696 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3697 p += 3;
3698
3699 if (session->ticket_len != 0) {
3700 if (session->ticket_len > (size_t) (end - p)) {
3701 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3702 }
3703
3704 session->ticket = mbedtls_calloc(1, session->ticket_len);
3705 if (session->ticket == NULL) {
3706 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3707 }
3708
3709 memcpy(session->ticket, p, session->ticket_len);
3710 p += session->ticket_len;
3711 }
3712
3713 if (4 > (size_t) (end - p)) {
3714 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3715 }
3716
3717 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3718 p += 4;
3719 }
3720#endif /* MBEDTLS_SSL_CLI_C */
3721#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3722 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3723 if (8 > (size_t) (end - p)) {
3724 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3725 }
3726 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3727 p += 8;
3728 }
3729#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3730#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3731
3732 /*
3733 * Misc extension-related info
3734 */
3735#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3736 if (1 > (size_t) (end - p)) {
3737 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3738 }
3739
3740 session->mfl_code = *p++;
3741#endif
3742
3743#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3744 if (1 > (size_t) (end - p)) {
3745 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3746 }
3747
3748 session->encrypt_then_mac = *p++;
3749#endif
3750
3751 /* Done, should have consumed entire buffer */
3752 if (p != end) {
3753 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3754 }
3755
3756 return 0;
3757}
3758
3759#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3760
3761#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3762/* Serialization of TLS 1.3 sessions:
3763 *
David Horstmanncb01b362024-02-29 17:31:46 +00003764 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003765 */
3766#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3767MBEDTLS_CHECK_RETURN_CRITICAL
3768static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3769 unsigned char *buf,
3770 size_t buf_len,
3771 size_t *olen)
3772{
3773 unsigned char *p = buf;
3774#if defined(MBEDTLS_SSL_CLI_C) && \
3775 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3776 size_t hostname_len = (session->hostname == NULL) ?
3777 0 : strlen(session->hostname) + 1;
3778#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003779
3780#if defined(MBEDTLS_SSL_SRV_C) && \
3781 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003782 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003783 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003784#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003785 size_t needed = 4 /* ticket_age_add */
3786 + 1 /* ticket_flags */
3787 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003788
David Horstmanne59f9702024-02-29 16:08:57 +00003789 *olen = 0;
3790
3791 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3792 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3793 }
3794 needed += session->resumption_key_len; /* resumption_key */
3795
3796#if defined(MBEDTLS_SSL_EARLY_DATA)
3797 needed += 4; /* max_early_data_size */
3798#endif
3799#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3800 needed += 2; /* record_size_limit */
3801#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3802
3803#if defined(MBEDTLS_HAVE_TIME)
3804 needed += 8; /* ticket_creation_time or ticket_reception_time */
3805#endif
3806
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003807#if defined(MBEDTLS_SSL_SRV_C)
3808 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3809#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003810 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003811 + alpn_len; /* alpn */
3812#endif
3813 }
3814#endif /* MBEDTLS_SSL_SRV_C */
3815
David Horstmanne59f9702024-02-29 16:08:57 +00003816#if defined(MBEDTLS_SSL_CLI_C)
3817 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3818#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3819 needed += 2 /* hostname_len */
3820 + hostname_len; /* hostname */
3821#endif
3822
3823 needed += 4 /* ticket_lifetime */
3824 + 2; /* ticket_len */
3825
3826 /* Check size_t overflow */
3827 if (session->ticket_len > SIZE_MAX - needed) {
3828 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3829 }
3830
3831 needed += session->ticket_len; /* ticket */
3832 }
3833#endif /* MBEDTLS_SSL_CLI_C */
3834
3835 *olen = needed;
3836 if (needed > buf_len) {
3837 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3838 }
3839
3840 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3841 p[4] = session->ticket_flags;
3842
3843 /* save resumption_key */
3844 p[5] = session->resumption_key_len;
3845 p += 6;
3846 memcpy(p, session->resumption_key, session->resumption_key_len);
3847 p += session->resumption_key_len;
3848
3849#if defined(MBEDTLS_SSL_EARLY_DATA)
3850 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3851 p += 4;
3852#endif
3853#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3854 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3855 p += 2;
3856#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3857
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003858#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003859 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003860#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003861 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3862 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003863#endif /* MBEDTLS_HAVE_TIME */
3864
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003865#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003866 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3867 p += 2;
3868
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003869 if (alpn_len > 0) {
3870 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003871 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003872 p += alpn_len;
3873 }
3874#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3875 }
3876#endif /* MBEDTLS_SSL_SRV_C */
3877
David Horstmanne59f9702024-02-29 16:08:57 +00003878#if defined(MBEDTLS_SSL_CLI_C)
3879 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3880#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3881 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3882 p += 2;
3883 if (hostname_len > 0) {
3884 /* save host name */
3885 memcpy(p, session->hostname, hostname_len);
3886 p += hostname_len;
3887 }
3888#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3889
3890#if defined(MBEDTLS_HAVE_TIME)
3891 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3892 p += 8;
3893#endif
3894 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3895 p += 4;
3896
3897 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3898 p += 2;
3899
3900 if (session->ticket != NULL && session->ticket_len > 0) {
3901 memcpy(p, session->ticket, session->ticket_len);
3902 p += session->ticket_len;
3903 }
3904 }
3905#endif /* MBEDTLS_SSL_CLI_C */
3906 return 0;
3907}
3908
3909MBEDTLS_CHECK_RETURN_CRITICAL
3910static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3911 const unsigned char *buf,
3912 size_t len)
3913{
3914 const unsigned char *p = buf;
3915 const unsigned char *end = buf + len;
3916
3917 if (end - p < 6) {
3918 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3919 }
3920 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3921 session->ticket_flags = p[4];
3922
3923 /* load resumption_key */
3924 session->resumption_key_len = p[5];
3925 p += 6;
3926
3927 if (end - p < session->resumption_key_len) {
3928 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3929 }
3930
3931 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3932 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3933 }
3934 memcpy(session->resumption_key, p, session->resumption_key_len);
3935 p += session->resumption_key_len;
3936
3937#if defined(MBEDTLS_SSL_EARLY_DATA)
3938 if (end - p < 4) {
3939 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3940 }
3941 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3942 p += 4;
3943#endif
3944#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3945 if (end - p < 2) {
3946 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3947 }
3948 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3949 p += 2;
3950#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3951
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003952#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003953 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003954#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003955 if (end - p < 8) {
3956 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3957 }
3958 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3959 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003960#endif /* MBEDTLS_HAVE_TIME */
3961
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003962#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003963 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003964
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003965 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003966 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3967 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003968
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003969 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3970 p += 2;
3971
3972 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003973 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3974 }
3975
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003976 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003977 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3978 if (ret != 0) {
3979 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003980 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003981 p += alpn_len;
3982 }
3983#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3984 }
3985#endif /* MBEDTLS_SSL_SRV_C */
3986
David Horstmanne59f9702024-02-29 16:08:57 +00003987#if defined(MBEDTLS_SSL_CLI_C)
3988 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3989#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3990 size_t hostname_len;
3991 /* load host name */
3992 if (end - p < 2) {
3993 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3994 }
3995 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3996 p += 2;
3997
3998 if (end - p < (long int) hostname_len) {
3999 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4000 }
4001 if (hostname_len > 0) {
4002 session->hostname = mbedtls_calloc(1, hostname_len);
4003 if (session->hostname == NULL) {
4004 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4005 }
4006 memcpy(session->hostname, p, hostname_len);
4007 p += hostname_len;
4008 }
4009#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4010
4011#if defined(MBEDTLS_HAVE_TIME)
4012 if (end - p < 8) {
4013 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4014 }
4015 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
4016 p += 8;
4017#endif
4018 if (end - p < 4) {
4019 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4020 }
4021 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
4022 p += 4;
4023
4024 if (end - p < 2) {
4025 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4026 }
4027 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
4028 p += 2;
4029
4030 if (end - p < (long int) session->ticket_len) {
4031 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4032 }
4033 if (session->ticket_len > 0) {
4034 session->ticket = mbedtls_calloc(1, session->ticket_len);
4035 if (session->ticket == NULL) {
4036 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4037 }
4038 memcpy(session->ticket, p, session->ticket_len);
4039 p += session->ticket_len;
4040 }
4041 }
4042#endif /* MBEDTLS_SSL_CLI_C */
4043
4044 return 0;
4045
4046}
4047#else /* MBEDTLS_SSL_SESSION_TICKETS */
4048MBEDTLS_CHECK_RETURN_CRITICAL
4049static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
4050 unsigned char *buf,
4051 size_t buf_len,
4052 size_t *olen)
4053{
4054 ((void) session);
4055 ((void) buf);
4056 ((void) buf_len);
4057 *olen = 0;
4058 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4059}
4060
4061static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01004062 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00004063 size_t buf_len)
4064{
4065 ((void) session);
4066 ((void) buf);
4067 ((void) buf_len);
4068 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4069}
4070#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
4071#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4072
Paul Bakker5121ce52009-01-03 21:22:43 +00004073/*
Hanno Beckera835da52019-05-16 12:39:07 +01004074 * Define ticket header determining Mbed TLS version
4075 * and structure of the ticket.
4076 */
4077
Hanno Becker94ef3b32019-05-16 12:50:45 +01004078/*
Hanno Becker50b59662019-05-28 14:30:45 +01004079 * Define bitflag determining compile-time settings influencing
4080 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01004081 */
4082
Hanno Becker50b59662019-05-28 14:30:45 +01004083#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01004084#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01004085#else
Hanno Becker3e088662019-05-29 11:10:18 +01004086#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004087#endif /* MBEDTLS_HAVE_TIME */
4088
4089#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004090#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004091#else
Hanno Becker3e088662019-05-29 11:10:18 +01004092#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004093#endif /* MBEDTLS_X509_CRT_PARSE_C */
4094
David Horstmann5c5a32f2024-02-13 17:53:35 +00004095#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00004096#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00004097#else
David Horstmannf686f1d2024-03-01 11:20:32 +00004098#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00004099#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4100
Hanno Becker94ef3b32019-05-16 12:50:45 +01004101#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004102#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004103#else
Hanno Becker3e088662019-05-29 11:10:18 +01004104#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004105#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4106
4107#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004108#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004109#else
Hanno Becker3e088662019-05-29 11:10:18 +01004110#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004111#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4112
Hanno Becker94ef3b32019-05-16 12:50:45 +01004113#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004114#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004115#else
Hanno Becker3e088662019-05-29 11:10:18 +01004116#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004117#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4118
Hanno Becker94ef3b32019-05-16 12:50:45 +01004119#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4120#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4121#else
4122#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4123#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4124
David Horstmann92b258b2024-02-13 17:23:34 +00004125#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4126#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
4127#else
4128#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
4129#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4130
4131#if defined(MBEDTLS_SSL_EARLY_DATA)
4132#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
4133#else
4134#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
4135#endif /* MBEDTLS_SSL_EARLY_DATA */
4136
4137#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4138#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
4139#else
4140#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
4141#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
4142
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004143#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
4144 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00004145#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
4146#else
4147#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
4148#endif /* MBEDTLS_SSL_ALPN */
4149
Hanno Becker3e088662019-05-29 11:10:18 +01004150#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4151#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4152#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4153#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004154#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4155#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00004156#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00004157#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
4158#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
4159#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00004160#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01004161
Hanno Becker50b59662019-05-28 14:30:45 +01004162#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004163 ((uint16_t) ( \
4164 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
4165 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
4166 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
4167 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
4168 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
4169 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00004170 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00004171 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
4172 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00004173 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
4174 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
4175 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
4176 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004177 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00004178 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004179 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01004180
Chien Wong4e9683e2023-12-28 17:07:43 +08004181static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004182 MBEDTLS_VERSION_MAJOR,
4183 MBEDTLS_VERSION_MINOR,
4184 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004185 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4186 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01004187};
Hanno Beckera835da52019-05-16 12:39:07 +01004188
4189/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004190 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004191 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004192 *
David Horstmanncb01b362024-02-29 17:31:46 +00004193 * TLS 1.2 session:
4194 *
4195 * struct {
4196 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
4197 * opaque ticket<0..2^24-1>; // length 0 means no ticket
4198 * uint32 ticket_lifetime;
4199 * #endif
4200 * } ClientOnlyData;
4201 *
4202 * struct {
4203 * #if defined(MBEDTLS_HAVE_TIME)
4204 * uint64 start_time;
4205 * #endif
4206 * uint8 session_id_len; // at most 32
4207 * opaque session_id[32];
4208 * opaque master[48]; // fixed length in the standard
4209 * uint32 verify_result;
4210 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
4211 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
4212 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00004213 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00004214 * opaque peer_cert_digest<0..2^8-1>
4215 * #endif
4216 * select (endpoint) {
4217 * case client: ClientOnlyData;
4218 * case server: uint64 ticket_creation_time;
4219 * };
4220 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4221 * uint8 mfl_code; // up to 255 according to standard
4222 * #endif
4223 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4224 * uint8 encrypt_then_mac; // 0 or 1
4225 * #endif
4226 * } serialized_session_tls12;
4227 *
4228 *
4229 * TLS 1.3 Session:
4230 *
4231 * struct {
4232 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4233 * opaque hostname<0..2^16-1>;
4234 * #endif
4235 * #if defined(MBEDTLS_HAVE_TIME)
4236 * uint64 ticket_reception_time;
4237 * #endif
4238 * uint32 ticket_lifetime;
4239 * opaque ticket<1..2^16-1>;
4240 * } ClientOnlyData;
4241 *
4242 * struct {
4243 * uint32 ticket_age_add;
4244 * uint8 ticket_flags;
4245 * opaque resumption_key<0..255>;
4246 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4247 * uint32 max_early_data_size;
4248 * #endif
4249 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4250 * uint16 record_size_limit;
4251 * #endif
4252 * select ( endpoint ) {
4253 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004254 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00004255 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004256 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00004257 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004258 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004259 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00004260 * #endif
4261 * };
4262 * } serialized_session_tls13;
4263 *
4264 *
4265 * SSL session:
4266 *
4267 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004268 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004269 * opaque mbedtls_version[3]; // library version: major, minor, patch
4270 * opaque session_format[2]; // library-version specific 16-bit field
4271 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004272 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004273 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004274 * Note: When updating the format, remember to keep
4275 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004276 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004277 * // In this version, `session_format` determines
4278 * // the setting of those compile-time
4279 * // configuration options which influence
4280 * // the structure of mbedtls_ssl_session.
4281 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004282 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004283 * // - TLS 1.2 (0x0303)
4284 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004285 * uint8_t endpoint;
4286 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004287 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004288 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004289 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004290 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004291 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004292 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004293 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004294 *
4295 * };
4296 *
4297 * } serialized_session;
4298 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004299 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004300
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004301MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004302static int ssl_session_save(const mbedtls_ssl_session *session,
4303 unsigned char omit_header,
4304 unsigned char *buf,
4305 size_t buf_len,
4306 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004307{
4308 unsigned char *p = buf;
4309 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004310 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004311#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4312 size_t out_len;
4313 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4314#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004315 if (session == NULL) {
4316 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4317 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004318
Gilles Peskine449bd832023-01-11 14:50:10 +01004319 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004320 /*
4321 * Add Mbed TLS version identifier
4322 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004324
Gilles Peskine449bd832023-01-11 14:50:10 +01004325 if (used <= buf_len) {
4326 memcpy(p, ssl_serialized_session_header,
4327 sizeof(ssl_serialized_session_header));
4328 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004329 }
4330 }
4331
4332 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004333 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004334 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004335 used += 1 /* TLS version */
4336 + 1 /* endpoint */
4337 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004338 if (used <= buf_len) {
4339 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004340 *p++ = session->endpoint;
4341 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4342 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004343 }
4344
4345 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004346 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004347 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004348#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004349 case MBEDTLS_SSL_VERSION_TLS1_2:
4350 used += ssl_tls12_session_save(session, p, remaining_len);
4351 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004352#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4353
Jerry Yu251a12e2022-07-13 15:15:48 +08004354#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004355 case MBEDTLS_SSL_VERSION_TLS1_3:
4356 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4357 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4358 return ret;
4359 }
4360 used += out_len;
4361 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004362#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4363
Gilles Peskine449bd832023-01-11 14:50:10 +01004364 default:
4365 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004366 }
4367
4368 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004369 if (used > buf_len) {
4370 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4371 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004372
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004374}
4375
4376/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004377 * Public wrapper for ssl_session_save()
4378 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004379int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4380 unsigned char *buf,
4381 size_t buf_len,
4382 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004383{
Gilles Peskine449bd832023-01-11 14:50:10 +01004384 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004385}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004386
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004387/*
4388 * Deserialize session, see mbedtls_ssl_session_save() for format.
4389 *
4390 * This internal version is wrapped by a public function that cleans up in
4391 * case of error, and has an extra option omit_header.
4392 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004393MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004394static int ssl_session_load(mbedtls_ssl_session *session,
4395 unsigned char omit_header,
4396 const unsigned char *buf,
4397 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004398{
4399 const unsigned char *p = buf;
4400 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004401 size_t remaining_len;
4402
4403
Gilles Peskine449bd832023-01-11 14:50:10 +01004404 if (session == NULL) {
4405 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4406 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004407
Gilles Peskine449bd832023-01-11 14:50:10 +01004408 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004409 /*
4410 * Check Mbed TLS version identifier
4411 */
4412
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4414 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004415 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004416
4417 if (memcmp(p, ssl_serialized_session_header,
4418 sizeof(ssl_serialized_session_header)) != 0) {
4419 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4420 }
4421 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004422 }
4423
4424 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004425 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004426 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004427 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004428 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4429 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004430 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004431 session->endpoint = *p++;
4432 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4433 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004434
4435 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004436 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004438#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004439 case MBEDTLS_SSL_VERSION_TLS1_2:
4440 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004441#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4442
Jerry Yu438ddd82022-07-07 06:55:50 +00004443#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 case MBEDTLS_SSL_VERSION_TLS1_3:
4445 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004446#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4447
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 default:
4449 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004450 }
4451}
4452
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004453/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004454 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004455 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004456int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4457 const unsigned char *buf,
4458 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004459{
Gilles Peskine449bd832023-01-11 14:50:10 +01004460 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004461
Gilles Peskine449bd832023-01-11 14:50:10 +01004462 if (ret != 0) {
4463 mbedtls_ssl_session_free(session);
4464 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004465
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004467}
4468
4469/*
Paul Bakker1961b702013-01-25 14:49:24 +01004470 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004471 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004472MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004473static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004474{
4475 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4476
Ronald Cron66dbf912022-02-02 15:33:46 +01004477 /*
4478 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004479 * that were written into the output buffer by the previous handshake step,
4480 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004481 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4482 * We proceed to the next handshake step only when all data from the
4483 * previous one have been sent to the peer, thus we make sure that this is
4484 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4485 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4486 * we have to wait before to go ahead.
4487 * In the case of TLS 1.3, handshake step handlers do not send data to the
4488 * peer. Data are only sent here and through
4489 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004490 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004491 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4493 return ret;
4494 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004495
4496#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004497 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4498 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4499 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4500 return ret;
4501 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004502 }
4503#endif /* MBEDTLS_SSL_PROTO_DTLS */
4504
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004506}
4507
Gilles Peskine449bd832023-01-11 14:50:10 +01004508int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004509{
Hanno Becker41934dd2021-08-07 19:13:43 +01004510 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004511
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004513 ssl->conf == NULL ||
4514 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4516 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004517 }
4518
Gilles Peskine449bd832023-01-11 14:50:10 +01004519 ret = ssl_prepare_handshake_step(ssl);
4520 if (ret != 0) {
4521 return ret;
4522 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004523
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 ret = mbedtls_ssl_handle_pending_alert(ssl);
4525 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004526 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 }
Jerry Yue7047812021-09-13 19:26:39 +08004528
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004529 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4530 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4531 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4532
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004533#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4535 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004536 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004537
Gilles Peskine449bd832023-01-11 14:50:10 +01004538 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004539 case MBEDTLS_SSL_HELLO_REQUEST:
4540 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004541 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004542 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004543
Ronald Cron9f0fba32022-02-10 16:45:15 +01004544 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004546 break;
4547
4548 default:
4549#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4551 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4552 } else {
4553 ret = mbedtls_ssl_handshake_client_step(ssl);
4554 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004555#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004556 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004557#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004559#endif
4560 }
Jerry Yub9930e72021-08-06 17:11:51 +08004561 }
Ronald Cron6291b232023-03-08 15:51:25 +01004562#endif /* MBEDTLS_SSL_CLI_C */
4563
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004564#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004565 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004566#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4567 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004568 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004569 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 ret = mbedtls_ssl_handshake_server_step(ssl);
4571 }
Ronald Cron6291b232023-03-08 15:51:25 +01004572#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4573 ret = mbedtls_ssl_handshake_server_step(ssl);
4574#else
4575 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004576#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004577 }
4578#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004579
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004581 /* handshake_step return error. And it is same
4582 * with alert_reason.
4583 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 if (ssl->send_alert) {
4585 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004586 goto cleanup;
4587 }
4588 }
4589
4590cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004592}
4593
4594/*
4595 * Perform the SSL handshake
4596 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004597int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004598{
4599 int ret = 0;
4600
Hanno Beckera817ea42020-10-20 15:20:23 +01004601 /* Sanity checks */
4602
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 if (ssl == NULL || ssl->conf == NULL) {
4604 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4605 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004606
Hanno Beckera817ea42020-10-20 15:20:23 +01004607#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004608 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4609 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4610 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4611 "mbedtls_ssl_set_timer_cb() for DTLS"));
4612 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004613 }
4614#endif /* MBEDTLS_SSL_PROTO_DTLS */
4615
Gilles Peskine449bd832023-01-11 14:50:10 +01004616 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004617
Hanno Beckera817ea42020-10-20 15:20:23 +01004618 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004619 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4620 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004621
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004623 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 }
Paul Bakker1961b702013-01-25 14:49:24 +01004625 }
4626
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004628
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004630}
4631
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004632#if defined(MBEDTLS_SSL_RENEGOTIATION)
4633#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004634/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004635 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004636 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004637MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004638static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004639{
Janos Follath865b3eb2019-12-16 11:46:15 +00004640 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004641
Gilles Peskine449bd832023-01-11 14:50:10 +01004642 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004643
4644 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004645 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4646 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004647
Gilles Peskine449bd832023-01-11 14:50:10 +01004648 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4649 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4650 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004651 }
4652
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004654
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004656}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004657#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004658
4659/*
4660 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004661 * - any side: calling mbedtls_ssl_renegotiate(),
4662 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4663 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004664 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004665 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004666 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004667 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004668int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004669{
Janos Follath865b3eb2019-12-16 11:46:15 +00004670 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004671
Gilles Peskine449bd832023-01-11 14:50:10 +01004672 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004673
Gilles Peskine449bd832023-01-11 14:50:10 +01004674 if ((ret = ssl_handshake_init(ssl)) != 0) {
4675 return ret;
4676 }
Paul Bakker48916f92012-09-16 19:57:18 +00004677
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004678 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4679 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004680#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004681 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4682 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4683 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004684 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004685 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004686 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004688 }
4689#endif
4690
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004691 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4692 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004693
Gilles Peskine449bd832023-01-11 14:50:10 +01004694 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4695 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4696 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004697 }
4698
Gilles Peskine449bd832023-01-11 14:50:10 +01004699 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004700
Gilles Peskine449bd832023-01-11 14:50:10 +01004701 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004702}
4703
4704/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004705 * Renegotiate current connection on client,
4706 * or request renegotiation on server
4707 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004708int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004709{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004710 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004711
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 if (ssl == NULL || ssl->conf == NULL) {
4713 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4714 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004715
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004716#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004717 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004718 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4719 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4720 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4721 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004722
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004723 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004724
4725 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004726 if (ssl->out_left != 0) {
4727 return mbedtls_ssl_flush_output(ssl);
4728 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004729
Gilles Peskine449bd832023-01-11 14:50:10 +01004730 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004731 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004732#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004733
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004734#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004735 /*
4736 * On client, either start the renegotiation process or,
4737 * if already in progress, continue the handshake
4738 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4740 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4741 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004742 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004743
4744 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4745 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4746 return ret;
4747 }
4748 } else {
4749 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4750 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4751 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004752 }
4753 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004754#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004755
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004757}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004758#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004759
Gilles Peskine449bd832023-01-11 14:50:10 +01004760void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004761{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004762 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4763
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004765 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004766 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004767
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004768#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Brett Warrene0edc842021-08-17 09:53:13 +01004769#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004770 if (ssl->handshake->group_list_heap_allocated) {
4771 mbedtls_free((void *) handshake->group_list);
4772 }
Brett Warrene0edc842021-08-17 09:53:13 +01004773 handshake->group_list = NULL;
4774#endif /* MBEDTLS_DEPRECATED_REMOVED */
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004775#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Brett Warrene0edc842021-08-17 09:53:13 +01004776
Ronald Crone68ab4f2022-10-05 12:46:29 +02004777#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004778#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004779 if (ssl->handshake->sig_algs_heap_allocated) {
4780 mbedtls_free((void *) handshake->sig_algs);
4781 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004782 handshake->sig_algs = NULL;
4783#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004784#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004785 if (ssl->handshake->certificate_request_context) {
4786 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004787 }
4788#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004789#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004790
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004791#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004792 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4793 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004794 handshake->async_in_progress = 0;
4795 }
4796#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4797
Elena Uziunaite0916cd72024-05-23 17:01:07 +01004798#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004799#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004800 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004801#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004802 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004803#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004804#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01004805#if defined(PSA_WANT_ALG_SHA_384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004806#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004807 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004808#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004809 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004810#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004811#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004812
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004813#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004815#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004816#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004817 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004819#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004820
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004821#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004822#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004824 /*
4825 * Opaque keys are not stored in the handshake's data and it's the user
4826 * responsibility to destroy them. Clear ones, instead, are created by
4827 * the TLS library and should be destroyed at the same level
4828 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4830 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004831 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004832 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4833#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004835#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004836#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004837 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004838 handshake->ecjpake_cache = NULL;
4839 handshake->ecjpake_cache_len = 0;
4840#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004841#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004842
Valerio Setti7aeec542023-07-05 18:57:21 +02004843#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004844 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004845 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004846 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004847 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004848#endif
4849
Ronald Cron73fe8df2022-10-05 14:31:43 +02004850#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004851#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004853 /* The maintenance of the external PSK key slot is the
4854 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004855 if (ssl->handshake->psk_opaque_is_internal) {
4856 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004857 ssl->handshake->psk_opaque_is_internal = 0;
4858 }
4859 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4860 }
Neil Armstronge952a302022-05-03 10:22:14 +02004861#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004862 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004863 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004864 }
Neil Armstronge952a302022-05-03 10:22:14 +02004865#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004866#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004867
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004868#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4869 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004870 /*
4871 * Free only the linked list wrapper, not the keys themselves
4872 * since the belong to the SNI callback
4873 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004875#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004876
Gilles Peskineeccd8882020-03-10 12:19:08 +01004877#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004878 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4879 if (handshake->ecrs_peer_cert != NULL) {
4880 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4881 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004882 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004883#endif
4884
Hanno Becker75173122019-02-06 16:18:31 +00004885#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4886 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004888#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4889
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004890#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004891 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4892 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004893#endif /* MBEDTLS_SSL_CLI_C &&
4894 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004895
4896#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004897 mbedtls_ssl_flight_free(handshake->flight);
4898 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004899#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004900
Valerio Settiea59c432023-07-25 11:14:03 +02004901#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004902 if (handshake->xxdh_psa_privkey_is_external == 0) {
4903 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004904 }
Valerio Settiea59c432023-07-25 11:14:03 +02004905#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004906
Ronald Cron6f135e12021-12-08 16:57:54 +01004907#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004908 mbedtls_ssl_transform_free(handshake->transform_handshake);
4909 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004910#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004911 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4912 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004913#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004914#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004915
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004916
4917#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4918 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4919 * processes datagrams and the fact that a datagram is allowed to have
4920 * several records in it, it is possible that the I/O buffers are not
4921 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004922 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4923 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004924#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004925
Jerry Yuba9c7272021-10-30 11:54:10 +08004926 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004927 mbedtls_platform_zeroize(handshake,
4928 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004929}
4930
Gilles Peskine449bd832023-01-11 14:50:10 +01004931void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004932{
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004934 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004936
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004937#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004938 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004939#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004940
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004941#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004942#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4943 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004944 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004945#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004946 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004947#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004948
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004949#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4950 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004951 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004952#endif
4953
Gilles Peskine449bd832023-01-11 14:50:10 +01004954 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004955}
4956
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004957#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004958
4959#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4960#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4961#else
4962#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4963#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4964
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004965#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004966
4967#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4968#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4969#else
4970#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4971#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4972
4973#if defined(MBEDTLS_SSL_ALPN)
4974#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4975#else
4976#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4977#endif /* MBEDTLS_SSL_ALPN */
4978
4979#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4980#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4981#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4982#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4983
4984#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004985 ((uint32_t) ( \
4986 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4987 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4988 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4989 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4990 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4991 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4992 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4993 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004994
Chien Wong4e9683e2023-12-28 17:07:43 +08004995static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004996 MBEDTLS_VERSION_MAJOR,
4997 MBEDTLS_VERSION_MINOR,
4998 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004999 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
5000 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
5001 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
5002 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
5003 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005004};
5005
Paul Bakker5121ce52009-01-03 21:22:43 +00005006/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005007 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005008 *
5009 * The format of the serialized data is:
5010 * (in the presentation language of TLS, RFC 8446 section 3)
5011 *
5012 * // header
5013 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005014 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005015 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005016 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005017 * Note: When updating the format, remember to keep these
5018 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005019 *
5020 * // session sub-structure
5021 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
5022 * // transform sub-structure
5023 * uint8 random[64]; // ServerHello.random+ClientHello.random
5024 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
5025 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
5026 * // fields from ssl_context
5027 * uint32 badmac_seen; // DTLS: number of records with failing MAC
5028 * uint64 in_window_top; // DTLS: last validated record seq_num
5029 * uint64 in_window; // DTLS: bitmask for replay protection
5030 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
5031 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
5032 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
5033 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
5034 *
5035 * Note that many fields of the ssl_context or sub-structures are not
5036 * serialized, as they fall in one of the following categories:
5037 *
5038 * 1. forced value (eg in_left must be 0)
5039 * 2. pointer to dynamically-allocated memory (eg session, transform)
5040 * 3. value can be re-derived from other data (eg session keys from MS)
5041 * 4. value was temporary (eg content of input buffer)
5042 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005043 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005044int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5045 unsigned char *buf,
5046 size_t buf_len,
5047 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005048{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005049 unsigned char *p = buf;
5050 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005051 size_t session_len;
5052 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005053
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005054 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005055 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
5056 * this function's documentation.
5057 *
5058 * These are due to assumptions/limitations in the implementation. Some of
5059 * them are likely to stay (no handshake in progress) some might go away
5060 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005061 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005062 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01005063 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
5064 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
5065 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005066 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005067 if (ssl->handshake != NULL) {
5068 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
5069 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005070 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005071 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01005072 if (ssl->transform == NULL || ssl->session == NULL) {
5073 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
5074 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005075 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005076 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 if (mbedtls_ssl_check_pending(ssl) != 0) {
5078 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
5079 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005080 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005081 if (ssl->out_left != 0) {
5082 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
5083 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005084 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00005085 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005086 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5087 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
5088 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005089 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005090 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005091 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
5092 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
5093 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005094 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005095 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01005096 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
5097 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
5098 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005099 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005100 /* Renegotiation must not be enabled */
5101#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5103 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
5104 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005105 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005106#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005107
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005108 /*
5109 * Version and format identifier
5110 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005111 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005112
Gilles Peskine449bd832023-01-11 14:50:10 +01005113 if (used <= buf_len) {
5114 memcpy(p, ssl_serialized_context_header,
5115 sizeof(ssl_serialized_context_header));
5116 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005117 }
5118
5119 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005120 * Session (length + data)
5121 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005122 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
5123 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
5124 return ret;
5125 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005126
5127 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005128 if (used <= buf_len) {
5129 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005130 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005131
Gilles Peskine449bd832023-01-11 14:50:10 +01005132 ret = ssl_session_save(ssl->session, 1,
5133 p, session_len, &session_len);
5134 if (ret != 0) {
5135 return ret;
5136 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005137
5138 p += session_len;
5139 }
5140
5141 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005142 * Transform
5143 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 used += sizeof(ssl->transform->randbytes);
5145 if (used <= buf_len) {
5146 memcpy(p, ssl->transform->randbytes,
5147 sizeof(ssl->transform->randbytes));
5148 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005149 }
5150
5151#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005152 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005153 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005154 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005155 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005156 p += ssl->transform->in_cid_len;
5157
5158 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005159 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005160 p += ssl->transform->out_cid_len;
5161 }
5162#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5163
5164 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005165 * Saved fields from top-level ssl_context structure
5166 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005167 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 if (used <= buf_len) {
5169 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005170 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005171 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005172
5173#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5174 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 if (used <= buf_len) {
5176 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005177 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005178
Gilles Peskine449bd832023-01-11 14:50:10 +01005179 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005180 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005181 }
5182#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5183
5184#if defined(MBEDTLS_SSL_PROTO_DTLS)
5185 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005187 *p++ = ssl->disable_datagram_packing;
5188 }
5189#endif /* MBEDTLS_SSL_PROTO_DTLS */
5190
Jerry Yuae0b2e22021-10-08 15:21:19 +08005191 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01005192 if (used <= buf_len) {
5193 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08005194 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005195 }
5196
5197#if defined(MBEDTLS_SSL_PROTO_DTLS)
5198 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005199 if (used <= buf_len) {
5200 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005201 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005202 }
5203#endif /* MBEDTLS_SSL_PROTO_DTLS */
5204
5205#if defined(MBEDTLS_SSL_ALPN)
5206 {
5207 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01005208 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005209 : 0;
5210
5211 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005212 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005213 *p++ = alpn_len;
5214
Gilles Peskine449bd832023-01-11 14:50:10 +01005215 if (ssl->alpn_chosen != NULL) {
5216 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005217 p += alpn_len;
5218 }
5219 }
5220 }
5221#endif /* MBEDTLS_SSL_ALPN */
5222
5223 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005224 * Done
5225 */
5226 *olen = used;
5227
Gilles Peskine449bd832023-01-11 14:50:10 +01005228 if (used > buf_len) {
5229 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
5230 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005231
Gilles Peskine449bd832023-01-11 14:50:10 +01005232 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005233
Gilles Peskine449bd832023-01-11 14:50:10 +01005234 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005235}
5236
5237/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005238 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005239 *
5240 * This internal version is wrapped by a public function that cleans up in
5241 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005242 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005243MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005244static int ssl_context_load(mbedtls_ssl_context *ssl,
5245 const unsigned char *buf,
5246 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005247{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005248 const unsigned char *p = buf;
5249 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005250 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005251 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005252#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04005253 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005254#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005255
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005256 /*
5257 * The context should have been freshly setup or reset.
5258 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005259 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005260 * renegotiating, or if the user mistakenly loaded a session first.)
5261 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005262 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5263 ssl->session != NULL) {
5264 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005265 }
5266
5267 /*
5268 * We can't check that the config matches the initial one, but we can at
5269 * least check it matches the requirements for serializing.
5270 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005271 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005272#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005273 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005274#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005275 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5276 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5277 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5278 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005279 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005280 }
5281
Gilles Peskine449bd832023-01-11 14:50:10 +01005282 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005283
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005284 /*
5285 * Check version identifier
5286 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005287 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5288 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005289 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005290
5291 if (memcmp(p, ssl_serialized_context_header,
5292 sizeof(ssl_serialized_context_header)) != 0) {
5293 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5294 }
5295 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005296
5297 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005298 * Session
5299 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005300 if ((size_t) (end - p) < 4) {
5301 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5302 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005303
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005304 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005305 p += 4;
5306
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005307 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005308 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005309 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005310 ssl->session_in = ssl->session;
5311 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005312 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005313
Gilles Peskine449bd832023-01-11 14:50:10 +01005314 if ((size_t) (end - p) < session_len) {
5315 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5316 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005317
Gilles Peskine449bd832023-01-11 14:50:10 +01005318 ret = ssl_session_load(ssl->session, 1, p, session_len);
5319 if (ret != 0) {
5320 mbedtls_ssl_session_free(ssl->session);
5321 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005322 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005323
5324 p += session_len;
5325
5326 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005327 * Transform
5328 */
5329
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005330 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005331 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005332#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005333 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005334 ssl->transform_in = ssl->transform;
5335 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005336 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005337#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005338
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005339#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005340 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5341 if (prf_func == NULL) {
5342 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5343 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005344
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005345 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005346 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5347 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5348 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005349
Gilles Peskine449bd832023-01-11 14:50:10 +01005350 ret = ssl_tls12_populate_transform(ssl->transform,
5351 ssl->session->ciphersuite,
5352 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005353#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005354 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005355#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 prf_func,
5357 p, /* currently pointing to randbytes */
5358 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5359 ssl->conf->endpoint,
5360 ssl);
5361 if (ret != 0) {
5362 return ret;
5363 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005364#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005365 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005366
5367#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5368 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005369 if ((size_t) (end - p) < 1) {
5370 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5371 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005372
5373 ssl->transform->in_cid_len = *p++;
5374
Gilles Peskine449bd832023-01-11 14:50:10 +01005375 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5376 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5377 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005378
Gilles Peskine449bd832023-01-11 14:50:10 +01005379 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005380 p += ssl->transform->in_cid_len;
5381
5382 ssl->transform->out_cid_len = *p++;
5383
Gilles Peskine449bd832023-01-11 14:50:10 +01005384 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5385 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5386 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005387
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005389 p += ssl->transform->out_cid_len;
5390#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5391
5392 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005393 * Saved fields from top-level ssl_context structure
5394 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005395 if ((size_t) (end - p) < 4) {
5396 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5397 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005398
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005399 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005400 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005401
5402#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005403 if ((size_t) (end - p) < 16) {
5404 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5405 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005406
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005407 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005408 p += 8;
5409
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005410 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005411 p += 8;
5412#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5413
5414#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005415 if ((size_t) (end - p) < 1) {
5416 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5417 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005418
5419 ssl->disable_datagram_packing = *p++;
5420#endif /* MBEDTLS_SSL_PROTO_DTLS */
5421
Gilles Peskine449bd832023-01-11 14:50:10 +01005422 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5423 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5424 }
5425 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5426 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005427
5428#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005429 if ((size_t) (end - p) < 2) {
5430 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5431 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005432
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005433 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005434 p += 2;
5435#endif /* MBEDTLS_SSL_PROTO_DTLS */
5436
5437#if defined(MBEDTLS_SSL_ALPN)
5438 {
5439 uint8_t alpn_len;
5440 const char **cur;
5441
Gilles Peskine449bd832023-01-11 14:50:10 +01005442 if ((size_t) (end - p) < 1) {
5443 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5444 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005445
5446 alpn_len = *p++;
5447
Gilles Peskine449bd832023-01-11 14:50:10 +01005448 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005449 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005450 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5451 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005452 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005453 ssl->alpn_chosen = *cur;
5454 break;
5455 }
5456 }
5457 }
5458
5459 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005460 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5461 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5462 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005463
5464 p += alpn_len;
5465 }
5466#endif /* MBEDTLS_SSL_ALPN */
5467
5468 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005469 * Forced fields from top-level ssl_context structure
5470 *
5471 * Most of them already set to the correct value by mbedtls_ssl_init() and
5472 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5473 */
5474 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005475 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005476
Hanno Becker361b10d2019-08-30 10:42:49 +01005477 /* Adjust pointers for header fields of outgoing records to
5478 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005479 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005480
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005481#if defined(MBEDTLS_SSL_PROTO_DTLS)
5482 ssl->in_epoch = 1;
5483#endif
5484
5485 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5486 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005487 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5488 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 if (ssl->handshake != NULL) {
5490 mbedtls_ssl_handshake_free(ssl);
5491 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005492 ssl->handshake = NULL;
5493 }
5494
5495 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005496 * Done - should have consumed entire buffer
5497 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 if (p != end) {
5499 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5500 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005501
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005503}
5504
5505/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005506 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005507 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005508int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5509 const unsigned char *buf,
5510 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005511{
Gilles Peskine449bd832023-01-11 14:50:10 +01005512 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005513
Gilles Peskine449bd832023-01-11 14:50:10 +01005514 if (ret != 0) {
5515 mbedtls_ssl_free(context);
5516 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005517
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005519}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005520#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005521
5522/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005523 * Free an SSL context
5524 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005525void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005526{
Gilles Peskine449bd832023-01-11 14:50:10 +01005527 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005528 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005530
Gilles Peskine449bd832023-01-11 14:50:10 +01005531 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005532
Gilles Peskine449bd832023-01-11 14:50:10 +01005533 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005534#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5535 size_t out_buf_len = ssl->out_buf_len;
5536#else
5537 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5538#endif
5539
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005540 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005541 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005542 }
5543
Gilles Peskine449bd832023-01-11 14:50:10 +01005544 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005545#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5546 size_t in_buf_len = ssl->in_buf_len;
5547#else
5548 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5549#endif
5550
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005551 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005552 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005553 }
5554
Gilles Peskine449bd832023-01-11 14:50:10 +01005555 if (ssl->transform) {
5556 mbedtls_ssl_transform_free(ssl->transform);
5557 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005558 }
5559
Gilles Peskine449bd832023-01-11 14:50:10 +01005560 if (ssl->handshake) {
5561 mbedtls_ssl_handshake_free(ssl);
5562 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005563
5564#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005565 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5566 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005567#endif
5568
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 mbedtls_ssl_session_free(ssl->session_negotiate);
5570 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005571 }
5572
Ronald Cron6f135e12021-12-08 16:57:54 +01005573#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005574 mbedtls_ssl_transform_free(ssl->transform_application);
5575 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005576#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005577
Gilles Peskine449bd832023-01-11 14:50:10 +01005578 if (ssl->session) {
5579 mbedtls_ssl_session_free(ssl->session);
5580 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005581 }
5582
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005583#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005584 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005585 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005586 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005587#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005588
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005589#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005590 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005591#endif
5592
Gilles Peskine449bd832023-01-11 14:50:10 +01005593 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005594
Paul Bakker86f04f42013-02-14 11:20:09 +01005595 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005596 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005597}
5598
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005599/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005600 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005601 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005602void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005603{
Gilles Peskine449bd832023-01-11 14:50:10 +01005604 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005605}
5606
Gilles Peskineae270bf2021-06-02 00:05:29 +02005607/* The selection should be the same as mbedtls_x509_crt_profile_default in
5608 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005609 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005610 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005611 * about this list.
5612 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005613static const uint16_t ssl_preset_default_groups[] = {
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005614#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Brett Warrene0edc842021-08-17 09:53:13 +01005615 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005616#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005617#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005618 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005619#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005620#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005621 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005622#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005623#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Brett Warrene0edc842021-08-17 09:53:13 +01005624 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005625#endif
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005626#if defined(PSA_WANT_ECC_SECP_R1_521)
Brett Warrene0edc842021-08-17 09:53:13 +01005627 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005628#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005629#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005630 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005631#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005632#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005633 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005634#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005635#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Brett Warrene0edc842021-08-17 09:53:13 +01005636 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005637#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005638#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005639 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5640 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5641 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5642 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5643 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5644#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005645 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005646};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005647
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005648static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005649 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5650 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5651 0
5652};
5653
Ronald Crone68ab4f2022-10-05 12:46:29 +02005654#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005655
Jerry Yu909df7b2022-01-22 11:56:27 +08005656/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005657 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005658 * rules SHOULD be upheld.
5659 * - No duplicate entries.
5660 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005661 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005662 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005663 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005664static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005665
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005666#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005667 defined(PSA_WANT_ALG_SHA_256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005668 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005669 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005670 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5671#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005672
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005673#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005674 defined(PSA_WANT_ALG_SHA_384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005675 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005676 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005677 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5678#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005679
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005680#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Gabor Mezeic15ef932024-06-13 12:53:54 +02005681 defined(PSA_WANT_ALG_SHA_512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005682 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005683 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005684 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5685#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005686
Gabor Mezeic15ef932024-06-13 12:53:54 +02005687#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005688 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005689#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005690
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005691#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005692 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005693#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005694
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005695#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005696 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005697#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005698
Gabor Mezeic15ef932024-06-13 12:53:54 +02005699#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005700 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Gabor Mezeic15ef932024-06-13 12:53:54 +02005701#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005702
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005703#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005704 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005705#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005706
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005707#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005708 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005709#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005710
Gabor Mezei15b95a62022-05-09 16:37:58 +02005711 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005712};
5713
5714/* NOTICE: see above */
5715#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5716static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005717
Gabor Mezeic15ef932024-06-13 12:53:54 +02005718#if defined(PSA_WANT_ALG_SHA_512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005719#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005720 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005721#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005722#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5723 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005724#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005725#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005727#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005728#endif /* PSA_WANT_ALG_SHA_512 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005729
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005730#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005731#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005733#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005734#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5735 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005736#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005737#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005738 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005739#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005740#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005741
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005742#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005743#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005744 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005745#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005746#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5747 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005748#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005749#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005750 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005751#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005752#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005753
Gabor Mezei15b95a62022-05-09 16:37:58 +02005754 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005755};
5756#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005757
Jerry Yu909df7b2022-01-22 11:56:27 +08005758/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005759static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005760
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005761#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005762 defined(PSA_WANT_ALG_SHA_256) && \
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005763 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005764 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005765 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5766#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005767
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005768#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005769 defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005770 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu53037892022-01-25 11:02:06 +08005771 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005772 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5773#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005774
Gabor Mezei15b95a62022-05-09 16:37:58 +02005775 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005776};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005777
Jerry Yu909df7b2022-01-22 11:56:27 +08005778/* NOTICE: see above */
5779#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5780static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005781
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005782#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005783#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005784 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005785#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005786#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005787
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005788#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005789#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005790 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005791#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005792#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005793
Gabor Mezei15b95a62022-05-09 16:37:58 +02005794 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005795};
Jerry Yu909df7b2022-01-22 11:56:27 +08005796#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5797
Ronald Crone68ab4f2022-10-05 12:46:29 +02005798#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005799
Chien Wong4e9683e2023-12-28 17:07:43 +08005800static const uint16_t ssl_preset_suiteb_groups[] = {
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005801#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005802 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005803#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005804#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005805 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005806#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005807 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005808};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005809
Ronald Crone68ab4f2022-10-05 12:46:29 +02005810#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005811/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005812 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005813MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005814static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005815{
5816 size_t i, j;
5817 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005818
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5820 for (j = 0; j < i; j++) {
5821 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005822 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005823 }
5824 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5825 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5826 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005827 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005828 }
5829 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005830 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005831}
5832
Ronald Crone68ab4f2022-10-05 12:46:29 +02005833#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005834
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005835/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005836 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005837 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005838int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5839 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005840{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005841#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005842 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005843#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005844
Ronald Crone68ab4f2022-10-05 12:46:29 +02005845#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5847 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5848 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005849 }
5850
Gilles Peskine449bd832023-01-11 14:50:10 +01005851 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5852 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5853 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005854 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005855
5856#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005857 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5858 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5859 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005860 }
5861
Gilles Peskine449bd832023-01-11 14:50:10 +01005862 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5863 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5864 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005865 }
5866#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005867#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005868
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005869 /* Use the functions here so that they are covered in tests,
5870 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005871 mbedtls_ssl_conf_endpoint(conf, endpoint);
5872 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005873
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005874 /*
5875 * Things that are common to all presets
5876 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005877#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005878 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005879 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5880#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5881 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5882#endif
5883 }
5884#endif
5885
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005886#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5887 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5888#endif
5889
5890#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5891 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5892#endif
5893
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005894#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005895 conf->f_cookie_write = ssl_cookie_write_dummy;
5896 conf->f_cookie_check = ssl_cookie_check_dummy;
5897#endif
5898
5899#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5900 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5901#endif
5902
Janos Follath088ce432017-04-10 12:42:31 +01005903#if defined(MBEDTLS_SSL_SRV_C)
5904 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005905 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005906#endif
5907
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005908#if defined(MBEDTLS_SSL_PROTO_DTLS)
5909 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5910 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5911#endif
5912
5913#if defined(MBEDTLS_SSL_RENEGOTIATION)
5914 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005915 memset(conf->renego_period, 0x00, 2);
5916 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005917#endif
5918
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005919#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005920 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005921 const unsigned char dhm_p[] =
5922 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5923 const unsigned char dhm_g[] =
5924 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005925
Gilles Peskine449bd832023-01-11 14:50:10 +01005926 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5927 dhm_p, sizeof(dhm_p),
5928 dhm_g, sizeof(dhm_g))) != 0) {
5929 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005930 }
5931 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005932#endif
5933
Ronald Cron6f135e12021-12-08 16:57:54 +01005934#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005935
5936#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005937 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005938#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005939 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005940#endif
5941#endif /* MBEDTLS_SSL_EARLY_DATA */
5942
Jerry Yud0766ec2022-09-22 10:46:57 +08005943#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005944 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005945 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005946#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005947 /*
5948 * Allow all TLS 1.3 key exchange modes by default.
5949 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005950 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005951#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005952
Gilles Peskine449bd832023-01-11 14:50:10 +01005953 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005954#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005955 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005956 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005957#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005958 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005959#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005960 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005961#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005962 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5963 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005964#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5965 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5966 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5967#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5968 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5969 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5970#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005971 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005972#endif
5973 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005974
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005975 /*
5976 * Preset-specific defaults
5977 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005978 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005979 /*
5980 * NSA Suite B
5981 */
5982 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005983
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005984 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005985
5986#if defined(MBEDTLS_X509_CRT_PARSE_C)
5987 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005988#endif
5989
Ronald Crone68ab4f2022-10-05 12:46:29 +02005990#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005991#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005992 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005993 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005995#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005997#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005998
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005999#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006000 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006001#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006002 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02006003 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006004
6005 /*
6006 * Default
6007 */
6008 default:
Ronald Cronf6606552022-03-15 11:23:25 +01006009
Hanno Beckerd60b6c62021-04-29 12:04:11 +01006010 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006011
6012#if defined(MBEDTLS_X509_CRT_PARSE_C)
6013 conf->cert_profile = &mbedtls_x509_crt_profile_default;
6014#endif
6015
Ronald Crone68ab4f2022-10-05 12:46:29 +02006016#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08006017#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006018 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08006019 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01006020 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08006021#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006022 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02006023#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006024
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02006025#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006026 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006027#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006028 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006029
6030#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
6031 conf->dhm_min_bitlen = 1024;
6032#endif
6033 }
6034
Gilles Peskine449bd832023-01-11 14:50:10 +01006035 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006036}
6037
6038/*
6039 * Free mbedtls_ssl_config
6040 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006041void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006042{
Troy-Butlerda73abc2024-04-02 13:37:31 -04006043 if (conf == NULL) {
6044 return;
6045 }
6046
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006047#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006048 mbedtls_mpi_free(&conf->dhm_P);
6049 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006050#endif
6051
Ronald Cron73fe8df2022-10-05 14:31:43 +02006052#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02006053#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006054 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02006055 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
6056 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02006057#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006059 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006060 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006061 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09006062 }
6063
Gilles Peskine449bd832023-01-11 14:50:10 +01006064 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006065 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006066 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006067 conf->psk_identity_len = 0;
6068 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02006069#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006070
6071#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006073#endif
6074
Gilles Peskine449bd832023-01-11 14:50:10 +01006075 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006076}
6077
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02006078#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02006079 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006080/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006081 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006082 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006083unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006084{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006085#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006086 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
6087 return MBEDTLS_SSL_SIG_RSA;
6088 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006089#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006090#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006091 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
6092 return MBEDTLS_SSL_SIG_ECDSA;
6093 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006094#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006096}
6097
Gilles Peskine449bd832023-01-11 14:50:10 +01006098unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01006099{
Gilles Peskine449bd832023-01-11 14:50:10 +01006100 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01006101 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006102 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006103 case MBEDTLS_PK_ECDSA:
6104 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006106 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006107 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006108 }
6109}
6110
Gilles Peskine449bd832023-01-11 14:50:10 +01006111mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006112{
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006114#if defined(MBEDTLS_RSA_C)
6115 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006117#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006118#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006119 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006120 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006121#endif
6122 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006123 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006124 }
6125}
Valerio Settie9646ec2023-08-02 20:02:28 +02006126#endif /* MBEDTLS_PK_C &&
6127 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006128
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006129/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006130 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006131 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006132mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006133{
Gilles Peskine449bd832023-01-11 14:50:10 +01006134 switch (hash) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01006135#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006136 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006137 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006138#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01006139#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006140 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006141 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006142#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01006143#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006144 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006145 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006146#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006147#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006148 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006149 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006150#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006151#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006152 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006153 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006154#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02006155#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006156 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006157 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006158#endif
6159 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006160 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006161 }
6162}
6163
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006164/*
6165 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6166 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006167unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006168{
Gilles Peskine449bd832023-01-11 14:50:10 +01006169 switch (md) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01006170#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006171 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006172 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006173#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01006174#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006175 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006177#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01006178#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006179 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006181#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006182#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006183 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006185#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006186#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006187 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006188 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006189#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02006190#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006191 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006193#endif
6194 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006196 }
6197}
6198
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006199/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006200 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006201 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006202 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006203int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006204{
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006206
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 if (group_list == NULL) {
6208 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01006209 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006210
Gilles Peskine449bd832023-01-11 14:50:10 +01006211 for (; *group_list != 0; group_list++) {
6212 if (*group_list == tls_id) {
6213 return 0;
6214 }
6215 }
6216
6217 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006218}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006219
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01006220#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006221/*
6222 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6223 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006224int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006225{
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006227
Gilles Peskine449bd832023-01-11 14:50:10 +01006228 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006229 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006231
Gilles Peskine449bd832023-01-11 14:50:10 +01006232 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006233}
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01006234#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Valerio Setti67419f02023-01-04 16:12:42 +01006235
Valerio Setti18c9fed2022-12-30 17:44:24 +01006236static const struct {
6237 uint16_t tls_id;
6238 mbedtls_ecp_group_id ecp_group_id;
6239 psa_ecc_family_t psa_family;
6240 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01006241} tls_id_match_table[] =
6242{
Elena Uziunaite24e24f22024-07-04 17:53:40 +01006243#if defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02006244 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006245#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01006246#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02006247 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006248#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01006249#if defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02006250 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006251#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01006252#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02006253 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006254#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01006255#if defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02006256 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006257#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01006258#if defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02006259 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006260#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01006261#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02006262 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006263#endif
Elena Uziunaiteeaa0cf02024-07-04 17:41:25 +01006264#if defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02006265 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006266#endif
Elena Uziunaite63cb13e2024-09-05 12:43:14 +01006267#if defined(PSA_WANT_ECC_SECP_K1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02006268 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006269#endif
Elena Uziunaitea3632862024-07-04 13:52:43 +01006270#if defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02006271 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006272#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01006273#if defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02006274 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006275#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01006276#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02006277 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006278#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01006279#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006280 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006281#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006282 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006283};
6284
Gilles Peskine449bd832023-01-11 14:50:10 +01006285int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006286 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006288{
Gilles Peskine449bd832023-01-11 14:50:10 +01006289 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6290 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006291 if (type != NULL) {
6292 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006293 }
6294 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006295 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006296 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006297 return PSA_SUCCESS;
6298 }
6299 }
6300
6301 return PSA_ERROR_NOT_SUPPORTED;
6302}
6303
Gilles Peskine449bd832023-01-11 14:50:10 +01006304mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006305{
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6307 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006308 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006309 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006310 }
6311
6312 return MBEDTLS_ECP_DP_NONE;
6313}
6314
Gilles Peskine449bd832023-01-11 14:50:10 +01006315uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006316{
Gilles Peskine449bd832023-01-11 14:50:10 +01006317 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6318 i++) {
6319 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006320 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006321 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006322 }
6323
6324 return 0;
6325}
6326
Valerio Setti67419f02023-01-04 16:12:42 +01006327#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006328static const struct {
6329 uint16_t tls_id;
6330 const char *name;
6331} tls_id_curve_name_table[] =
6332{
Valerio Setti54e23792023-07-07 10:49:27 +02006333 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6334 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6335 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6336 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6337 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6338 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6339 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6340 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6341 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6342 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6343 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6344 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6345 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006346 { 0, NULL },
6347};
6348
Gilles Peskine449bd832023-01-11 14:50:10 +01006349const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006350{
Valerio Settiacd32c02023-06-29 18:06:29 +02006351 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6352 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6353 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006354 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006355 }
6356
6357 return NULL;
6358}
Valerio Setti67419f02023-01-04 16:12:42 +01006359#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006360
Jerry Yu148165c2021-09-24 23:20:59 +08006361#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006362int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6363 const mbedtls_md_type_t md,
6364 unsigned char *dst,
6365 size_t dst_len,
6366 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006367{
Ronald Cronf6893e12022-01-07 22:09:01 +01006368 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6369 psa_hash_operation_t *hash_operation_to_clone;
6370 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6371
Jerry Yu148165c2021-09-24 23:20:59 +08006372 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006373
Gilles Peskine449bd832023-01-11 14:50:10 +01006374 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006375#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006376 case MBEDTLS_MD_SHA384:
6377 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6378 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006379#endif
6380
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006381#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006382 case MBEDTLS_MD_SHA256:
6383 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6384 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006385#endif
6386
Gilles Peskine449bd832023-01-11 14:50:10 +01006387 default:
6388 goto exit;
6389 }
6390
6391 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6392 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006393 goto exit;
6394 }
6395
Gilles Peskine449bd832023-01-11 14:50:10 +01006396 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6397 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006398 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006399 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006400
6401exit:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006402#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006403 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006404 (void) ssl;
6405#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006406 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006407}
6408#else /* MBEDTLS_USE_PSA_CRYPTO */
6409
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006410#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006411MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006412static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
6413 unsigned char *dst,
6414 size_t dst_len,
6415 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006416{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006417 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006418 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006419
Gilles Peskine449bd832023-01-11 14:50:10 +01006420 if (dst_len < 48) {
6421 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6422 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006423
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006424 mbedtls_md_init(&sha384);
6425 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006426 if (ret != 0) {
6427 goto exit;
6428 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006429 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006430 if (ret != 0) {
6431 goto exit;
6432 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006433
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006434 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006435 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006436 goto exit;
6437 }
6438
6439 *olen = 48;
6440
6441exit:
6442
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006443 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006444 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006445}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006446#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006447
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006448#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006449MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006450static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
6451 unsigned char *dst,
6452 size_t dst_len,
6453 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006454{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006455 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006456 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006457
Gilles Peskine449bd832023-01-11 14:50:10 +01006458 if (dst_len < 32) {
6459 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6460 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006461
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006462 mbedtls_md_init(&sha256);
6463 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6464 if (ret != 0) {
6465 goto exit;
6466 }
6467 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6468 if (ret != 0) {
6469 goto exit;
6470 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006471
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006472 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
6473 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006474 goto exit;
6475 }
6476
6477 *olen = 32;
6478
6479exit:
6480
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006481 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006482 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006483}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006484#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006485
Gilles Peskine449bd832023-01-11 14:50:10 +01006486int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6487 const mbedtls_md_type_t md,
6488 unsigned char *dst,
6489 size_t dst_len,
6490 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006491{
Gilles Peskine449bd832023-01-11 14:50:10 +01006492 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006493
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006494#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006495 case MBEDTLS_MD_SHA384:
6496 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006497#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006498
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006499#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006500 case MBEDTLS_MD_SHA256:
6501 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006502#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006503
Gilles Peskine449bd832023-01-11 14:50:10 +01006504 default:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006505#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006506 !defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006507 (void) ssl;
6508 (void) dst;
6509 (void) dst_len;
6510 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006511#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006512 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006513 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006514 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006515}
XiaokangQian647719a2021-12-07 09:16:29 +00006516
Jerry Yu148165c2021-09-24 23:20:59 +08006517#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006518
Ronald Crone68ab4f2022-10-05 12:46:29 +02006519#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006520/* mbedtls_ssl_parse_sig_alg_ext()
6521 *
6522 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6523 * value (TLS 1.3 RFC8446):
6524 * enum {
6525 * ....
6526 * ecdsa_secp256r1_sha256( 0x0403 ),
6527 * ecdsa_secp384r1_sha384( 0x0503 ),
6528 * ecdsa_secp521r1_sha512( 0x0603 ),
6529 * ....
6530 * } SignatureScheme;
6531 *
6532 * struct {
6533 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6534 * } SignatureSchemeList;
6535 *
6536 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6537 * value (TLS 1.2 RFC5246):
6538 * enum {
6539 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6540 * sha512(6), (255)
6541 * } HashAlgorithm;
6542 *
6543 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6544 * SignatureAlgorithm;
6545 *
6546 * struct {
6547 * HashAlgorithm hash;
6548 * SignatureAlgorithm signature;
6549 * } SignatureAndHashAlgorithm;
6550 *
6551 * SignatureAndHashAlgorithm
6552 * supported_signature_algorithms<2..2^16-2>;
6553 *
6554 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6555 * generalization of the TLS 1.2 signature algorithm extension.
6556 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6557 * `SignatureScheme` field of TLS 1.3
6558 *
6559 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006560int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6561 const unsigned char *buf,
6562 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006563{
6564 const unsigned char *p = buf;
6565 size_t supported_sig_algs_len = 0;
6566 const unsigned char *supported_sig_algs_end;
6567 uint16_t sig_alg;
6568 uint32_t common_idx = 0;
6569
Gilles Peskine449bd832023-01-11 14:50:10 +01006570 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6571 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006572 p += 2;
6573
Gilles Peskine449bd832023-01-11 14:50:10 +01006574 memset(ssl->handshake->received_sig_algs, 0,
6575 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006576
Gilles Peskine449bd832023-01-11 14:50:10 +01006577 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006578 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006579 while (p < supported_sig_algs_end) {
6580 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6581 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006582 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006583 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6584 sig_alg,
6585 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006586#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006587 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6588 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6589 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006590 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006591 }
6592#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006593
Gilles Peskine449bd832023-01-11 14:50:10 +01006594 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6595 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006596
Gilles Peskine449bd832023-01-11 14:50:10 +01006597 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006598 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6599 common_idx += 1;
6600 }
6601 }
6602 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006603 if (p != end) {
6604 MBEDTLS_SSL_DEBUG_MSG(1,
6605 ("Signature algorithms extension length misaligned"));
6606 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6607 MBEDTLS_ERR_SSL_DECODE_ERROR);
6608 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006609 }
6610
Gilles Peskine449bd832023-01-11 14:50:10 +01006611 if (common_idx == 0) {
6612 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6613 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6614 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6615 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006616 }
6617
Gabor Mezei15b95a62022-05-09 16:37:58 +02006618 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006619 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006620}
6621
Ronald Crone68ab4f2022-10-05 12:46:29 +02006622#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006623
Jerry Yudc7bd172022-02-17 13:44:15 +08006624#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6625
6626#if defined(MBEDTLS_USE_PSA_CRYPTO)
6627
Gilles Peskine449bd832023-01-11 14:50:10 +01006628static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6629 mbedtls_svc_key_id_t key,
6630 psa_algorithm_t alg,
6631 const unsigned char *raw_psk, size_t raw_psk_length,
6632 const unsigned char *seed, size_t seed_length,
6633 const unsigned char *label, size_t label_length,
6634 const unsigned char *other_secret,
6635 size_t other_secret_length,
6636 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006637{
6638 psa_status_t status;
6639
Gilles Peskine449bd832023-01-11 14:50:10 +01006640 status = psa_key_derivation_setup(derivation, alg);
6641 if (status != PSA_SUCCESS) {
6642 return status;
6643 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006644
Gilles Peskine449bd832023-01-11 14:50:10 +01006645 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6646 status = psa_key_derivation_input_bytes(derivation,
6647 PSA_KEY_DERIVATION_INPUT_SEED,
6648 seed, seed_length);
6649 if (status != PSA_SUCCESS) {
6650 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006651 }
6652
Gilles Peskine449bd832023-01-11 14:50:10 +01006653 if (other_secret != NULL) {
6654 status = psa_key_derivation_input_bytes(derivation,
6655 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6656 other_secret, other_secret_length);
6657 if (status != PSA_SUCCESS) {
6658 return status;
6659 }
6660 }
6661
6662 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006663 status = psa_key_derivation_input_bytes(
6664 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006665 raw_psk, raw_psk_length);
6666 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006667 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006668 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006669 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006670 if (status != PSA_SUCCESS) {
6671 return status;
6672 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006673
Gilles Peskine449bd832023-01-11 14:50:10 +01006674 status = psa_key_derivation_input_bytes(derivation,
6675 PSA_KEY_DERIVATION_INPUT_LABEL,
6676 label, label_length);
6677 if (status != PSA_SUCCESS) {
6678 return status;
6679 }
6680 } else {
6681 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006682 }
6683
Gilles Peskine449bd832023-01-11 14:50:10 +01006684 status = psa_key_derivation_set_capacity(derivation, capacity);
6685 if (status != PSA_SUCCESS) {
6686 return status;
6687 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006688
Gilles Peskine449bd832023-01-11 14:50:10 +01006689 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006690}
6691
Andrzej Kurek57d10632022-10-24 10:32:01 -04006692#if defined(PSA_WANT_ALG_SHA_384) || \
6693 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006694MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006695static int tls_prf_generic(mbedtls_md_type_t md_type,
6696 const unsigned char *secret, size_t slen,
6697 const char *label,
6698 const unsigned char *random, size_t rlen,
6699 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006700{
6701 psa_status_t status;
6702 psa_algorithm_t alg;
6703 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6704 psa_key_derivation_operation_t derivation =
6705 PSA_KEY_DERIVATION_OPERATION_INIT;
6706
Gilles Peskine449bd832023-01-11 14:50:10 +01006707 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006708 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006709 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006710 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006711 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006712
6713 /* Normally a "secret" should be long enough to be impossible to
6714 * find by brute force, and in particular should not be empty. But
6715 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6716 * and for this use case it makes sense to have a 0-length "secret".
6717 * Since the key API doesn't allow importing a key of length 0,
6718 * keep master_key=0, which setup_psa_key_derivation() understands
6719 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006720 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006721 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006722 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6723 psa_set_key_algorithm(&key_attributes, alg);
6724 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006725
Gilles Peskine449bd832023-01-11 14:50:10 +01006726 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6727 if (status != PSA_SUCCESS) {
6728 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6729 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006730 }
6731
Gilles Peskine449bd832023-01-11 14:50:10 +01006732 status = setup_psa_key_derivation(&derivation,
6733 master_key, alg,
6734 NULL, 0,
6735 random, rlen,
6736 (unsigned char const *) label,
6737 (size_t) strlen(label),
6738 NULL, 0,
6739 dlen);
6740 if (status != PSA_SUCCESS) {
6741 psa_key_derivation_abort(&derivation);
6742 psa_destroy_key(master_key);
6743 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006744 }
6745
Gilles Peskine449bd832023-01-11 14:50:10 +01006746 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6747 if (status != PSA_SUCCESS) {
6748 psa_key_derivation_abort(&derivation);
6749 psa_destroy_key(master_key);
6750 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006751 }
6752
Gilles Peskine449bd832023-01-11 14:50:10 +01006753 status = psa_key_derivation_abort(&derivation);
6754 if (status != PSA_SUCCESS) {
6755 psa_destroy_key(master_key);
6756 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006757 }
6758
Gilles Peskine449bd832023-01-11 14:50:10 +01006759 if (!mbedtls_svc_key_id_is_null(master_key)) {
6760 status = psa_destroy_key(master_key);
6761 }
6762 if (status != PSA_SUCCESS) {
6763 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6764 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006765
Gilles Peskine449bd832023-01-11 14:50:10 +01006766 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006767}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006768#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006769#else /* MBEDTLS_USE_PSA_CRYPTO */
6770
Andrzej Kurek57d10632022-10-24 10:32:01 -04006771#if defined(MBEDTLS_MD_C) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006772 (defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006773 defined(PSA_WANT_ALG_SHA_384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006774MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006775static int tls_prf_generic(mbedtls_md_type_t md_type,
6776 const unsigned char *secret, size_t slen,
6777 const char *label,
6778 const unsigned char *random, size_t rlen,
6779 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006780{
6781 size_t nb;
6782 size_t i, j, k, md_len;
6783 unsigned char *tmp;
6784 size_t tmp_len = 0;
6785 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6786 const mbedtls_md_info_t *md_info;
6787 mbedtls_md_context_t md_ctx;
6788 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6789
Gilles Peskine449bd832023-01-11 14:50:10 +01006790 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006791
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6793 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6794 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006795
Gilles Peskine449bd832023-01-11 14:50:10 +01006796 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006797
Gilles Peskine449bd832023-01-11 14:50:10 +01006798 tmp_len = md_len + strlen(label) + rlen;
6799 tmp = mbedtls_calloc(1, tmp_len);
6800 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006801 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6802 goto exit;
6803 }
6804
Gilles Peskine449bd832023-01-11 14:50:10 +01006805 nb = strlen(label);
6806 memcpy(tmp + md_len, label, nb);
6807 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006808 nb += rlen;
6809
6810 /*
6811 * Compute P_<hash>(secret, label + random)[0..dlen]
6812 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006813 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006814 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006815 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006816
Gilles Peskine449bd832023-01-11 14:50:10 +01006817 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6818 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006819 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006820 }
6821 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6822 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006823 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 }
6825 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6826 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006827 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006828 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006829
Gilles Peskine449bd832023-01-11 14:50:10 +01006830 for (i = 0; i < dlen; i += md_len) {
6831 ret = mbedtls_md_hmac_reset(&md_ctx);
6832 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006833 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006834 }
6835 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6836 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006837 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006838 }
6839 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6840 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006841 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006843
Gilles Peskine449bd832023-01-11 14:50:10 +01006844 ret = mbedtls_md_hmac_reset(&md_ctx);
6845 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006846 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006847 }
6848 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6849 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006850 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006851 }
6852 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6853 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006854 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006855 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006856
Gilles Peskine449bd832023-01-11 14:50:10 +01006857 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006858
Gilles Peskine449bd832023-01-11 14:50:10 +01006859 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006860 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006861 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006862 }
6863
6864exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006865 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006866
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 if (tmp != NULL) {
6868 mbedtls_platform_zeroize(tmp, tmp_len);
6869 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006870
Gilles Peskine449bd832023-01-11 14:50:10 +01006871 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006872
Gilles Peskine449bd832023-01-11 14:50:10 +01006873 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006874
Gilles Peskine449bd832023-01-11 14:50:10 +01006875 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006876}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006877#endif /* MBEDTLS_MD_C && ( PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006878#endif /* MBEDTLS_USE_PSA_CRYPTO */
6879
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006880#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006881MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006882static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6883 const char *label,
6884 const unsigned char *random, size_t rlen,
6885 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006886{
Gilles Peskine449bd832023-01-11 14:50:10 +01006887 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6888 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006889}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006890#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006891
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006892#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006893MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006894static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6895 const char *label,
6896 const unsigned char *random, size_t rlen,
6897 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006898{
Gilles Peskine449bd832023-01-11 14:50:10 +01006899 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6900 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006901}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006902#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006903
Jerry Yuf009d862022-02-17 14:01:37 +08006904/*
6905 * Set appropriate PRF function and other SSL / TLS1.2 functions
6906 *
6907 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006908 * - hash associated with the ciphersuite (only used by TLS 1.2)
6909 *
6910 * Outputs:
6911 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6912 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006913MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006914static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6915 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006916{
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006917#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006918 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006919 handshake->tls_prf = tls_prf_sha384;
6920 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6921 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006922 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006923#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006924#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuf009d862022-02-17 14:01:37 +08006925 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006926 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006927 handshake->tls_prf = tls_prf_sha256;
6928 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6929 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6930 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006931#else
Jerry Yuf009d862022-02-17 14:01:37 +08006932 {
Jerry Yuf009d862022-02-17 14:01:37 +08006933 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006934 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006935 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006936 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006937#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006938
Gilles Peskine449bd832023-01-11 14:50:10 +01006939 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006940}
Jerry Yud6ab2352022-02-17 14:03:43 +08006941
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006942/*
6943 * Compute master secret if needed
6944 *
6945 * Parameters:
6946 * [in/out] handshake
6947 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6948 * (PSA-PSK) ciphersuite_info, psk_opaque
6949 * [out] premaster (cleared)
6950 * [out] master
6951 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6952 * debug: conf->f_dbg, conf->p_dbg
6953 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006954 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006955 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006956MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006957static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6958 unsigned char *master,
6959 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006960{
6961 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6962
6963 /* cf. RFC 5246, Section 8.1:
6964 * "The master secret is always exactly 48 bytes in length." */
6965 size_t const master_secret_len = 48;
6966
6967#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6968 unsigned char session_hash[48];
6969#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6970
6971 /* The label for the KDF used for key expansion.
6972 * This is either "master secret" or "extended master secret"
6973 * depending on whether the Extended Master Secret extension
6974 * is used. */
6975 char const *lbl = "master secret";
6976
Przemek Stekielae4ed302022-04-05 17:15:55 +02006977 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006978 * - If the Extended Master Secret extension is not used,
6979 * this is ClientHello.Random + ServerHello.Random
6980 * (see Sect. 8.1 in RFC 5246).
6981 * - If the Extended Master Secret extension is used,
6982 * this is the transcript of the handshake so far.
6983 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006984 unsigned char const *seed = handshake->randbytes;
6985 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006986
6987#if !defined(MBEDTLS_DEBUG_C) && \
6988 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6989 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006990 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006991 ssl = NULL; /* make sure we don't use it except for those cases */
6992 (void) ssl;
6993#endif
6994
Gilles Peskine449bd832023-01-11 14:50:10 +01006995 if (handshake->resume != 0) {
6996 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6997 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006998 }
6999
7000#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007002 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02007003 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007004 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
7005 if (ret != 0) {
7006 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
7007 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007008
Gilles Peskine449bd832023-01-11 14:50:10 +01007009 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
7010 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007011 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02007012#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007013
Przemek Stekiel99114f32022-04-22 11:20:09 +02007014#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02007015 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007016 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007017 /* Perform PSK-to-MS expansion in a single step. */
7018 psa_status_t status;
7019 psa_algorithm_t alg;
7020 mbedtls_svc_key_id_t psk;
7021 psa_key_derivation_operation_t derivation =
7022 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01007023 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007024
Gilles Peskine449bd832023-01-11 14:50:10 +01007025 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007026
Gilles Peskine449bd832023-01-11 14:50:10 +01007027 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007028
Gilles Peskine449bd832023-01-11 14:50:10 +01007029 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007030 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01007031 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007032 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01007033 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007034
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007035 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007036 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02007037
Gilles Peskine449bd832023-01-11 14:50:10 +01007038 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007039 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007040 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007041 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02007042 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007043 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007044 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007045 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
7046 other_secret = handshake->premaster + 2;
7047 break;
7048 default:
7049 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02007050 }
7051
Gilles Peskine449bd832023-01-11 14:50:10 +01007052 status = setup_psa_key_derivation(&derivation, psk, alg,
7053 ssl->conf->psk, ssl->conf->psk_len,
7054 seed, seed_len,
7055 (unsigned char const *) lbl,
7056 (size_t) strlen(lbl),
7057 other_secret, other_secret_len,
7058 master_secret_len);
7059 if (status != PSA_SUCCESS) {
7060 psa_key_derivation_abort(&derivation);
7061 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007062 }
7063
Gilles Peskine449bd832023-01-11 14:50:10 +01007064 status = psa_key_derivation_output_bytes(&derivation,
7065 master,
7066 master_secret_len);
7067 if (status != PSA_SUCCESS) {
7068 psa_key_derivation_abort(&derivation);
7069 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007070 }
7071
Gilles Peskine449bd832023-01-11 14:50:10 +01007072 status = psa_key_derivation_abort(&derivation);
7073 if (status != PSA_SUCCESS) {
7074 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7075 }
7076 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007077#endif
7078 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007079#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007080 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7081 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007082 psa_status_t status;
7083 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
7084 psa_key_derivation_operation_t derivation =
7085 PSA_KEY_DERIVATION_OPERATION_INIT;
7086
Gilles Peskine449bd832023-01-11 14:50:10 +01007087 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02007088
7089 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
7090
Gilles Peskine449bd832023-01-11 14:50:10 +01007091 status = psa_key_derivation_setup(&derivation, alg);
7092 if (status != PSA_SUCCESS) {
7093 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007094 }
7095
Gilles Peskine449bd832023-01-11 14:50:10 +01007096 status = psa_key_derivation_set_capacity(&derivation,
7097 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
7098 if (status != PSA_SUCCESS) {
7099 psa_key_derivation_abort(&derivation);
7100 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007101 }
7102
Gilles Peskine449bd832023-01-11 14:50:10 +01007103 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
7104 &derivation);
7105 if (status != PSA_SUCCESS) {
7106 psa_key_derivation_abort(&derivation);
7107 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007108 }
7109
Gilles Peskine449bd832023-01-11 14:50:10 +01007110 status = psa_key_derivation_output_bytes(&derivation,
7111 handshake->premaster,
7112 handshake->pmslen);
7113 if (status != PSA_SUCCESS) {
7114 psa_key_derivation_abort(&derivation);
7115 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7116 }
7117
7118 status = psa_key_derivation_abort(&derivation);
7119 if (status != PSA_SUCCESS) {
7120 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007121 }
7122 }
7123#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007124 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
7125 lbl, seed, seed_len,
7126 master,
7127 master_secret_len);
7128 if (ret != 0) {
7129 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7130 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007131 }
7132
Gilles Peskine449bd832023-01-11 14:50:10 +01007133 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
7134 handshake->premaster,
7135 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007136
Gilles Peskine449bd832023-01-11 14:50:10 +01007137 mbedtls_platform_zeroize(handshake->premaster,
7138 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007139 }
7140
Gilles Peskine449bd832023-01-11 14:50:10 +01007141 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007142}
7143
Gilles Peskine449bd832023-01-11 14:50:10 +01007144int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08007145{
7146 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7147 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7148 ssl->handshake->ciphersuite_info;
7149
Gilles Peskine449bd832023-01-11 14:50:10 +01007150 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007151
7152 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007153 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01007154 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007155 if (ret != 0) {
7156 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
7157 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007158 }
7159
7160 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01007161 ret = ssl_compute_master(ssl->handshake,
7162 ssl->session_negotiate->master,
7163 ssl);
7164 if (ret != 0) {
7165 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
7166 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007167 }
7168
7169 /* Swap the client and server random values:
7170 * - MS derivation wanted client+server (RFC 5246 8.1)
7171 * - key derivation wants server+client (RFC 5246 6.3) */
7172 {
7173 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01007174 memcpy(tmp, ssl->handshake->randbytes, 64);
7175 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
7176 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
7177 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08007178 }
7179
7180 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01007181 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
7182 ssl->session_negotiate->ciphersuite,
7183 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007184#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007185 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007186#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007187 ssl->handshake->tls_prf,
7188 ssl->handshake->randbytes,
7189 ssl->tls_version,
7190 ssl->conf->endpoint,
7191 ssl);
7192 if (ret != 0) {
7193 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
7194 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007195 }
7196
7197 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01007198 mbedtls_platform_zeroize(ssl->handshake->randbytes,
7199 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08007200
Gilles Peskine449bd832023-01-11 14:50:10 +01007201 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007202
Gilles Peskine449bd832023-01-11 14:50:10 +01007203 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08007204}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007205
Gilles Peskine449bd832023-01-11 14:50:10 +01007206int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007207{
Gilles Peskine449bd832023-01-11 14:50:10 +01007208 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007209#if defined(PSA_WANT_ALG_SHA_384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007210 case MBEDTLS_SSL_HASH_SHA384:
7211 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
7212 break;
7213#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007214#if defined(PSA_WANT_ALG_SHA_256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007215 case MBEDTLS_SSL_HASH_SHA256:
7216 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
7217 break;
7218#endif
7219 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007220 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007221 }
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007222#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007223 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007224 (void) ssl;
7225#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007226 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007227}
7228
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007229#if defined(MBEDTLS_USE_PSA_CRYPTO)
7230static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
7231 const psa_hash_operation_t *hs_op,
7232 size_t buffer_size,
7233 unsigned char *hash,
7234 size_t *hlen)
7235{
7236 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007237 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007238
7239#if !defined(MBEDTLS_DEBUG_C)
7240 (void) ssl;
7241#endif
7242 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007243 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007244 if (status != PSA_SUCCESS) {
7245 goto exit;
7246 }
7247
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007248 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007249 if (status != PSA_SUCCESS) {
7250 goto exit;
7251 }
7252
7253 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
7254 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
7255
7256exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007257 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007258 return mbedtls_md_error_from_psa(status);
7259}
7260#else
7261static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
7262 const mbedtls_md_context_t *hs_ctx,
7263 unsigned char *hash,
7264 size_t *hlen)
7265{
7266 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007267 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007268
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007269 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007270
7271#if !defined(MBEDTLS_DEBUG_C)
7272 (void) ssl;
7273#endif
7274 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
7275
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007276 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007277 if (ret != 0) {
7278 goto exit;
7279 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007280 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007281 if (ret != 0) {
7282 goto exit;
7283 }
7284
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007285 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007286 if (ret != 0) {
7287 goto exit;
7288 }
7289
7290 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
7291
7292 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
7293 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
7294
7295exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007296 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007297 return ret;
7298}
7299#endif /* MBEDTLS_USE_PSA_CRYPTO */
7300
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007301#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007302int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
7303 unsigned char *hash,
7304 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08007305{
7306#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007307 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
7308 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007309#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007310 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
7311 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007312#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007313}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007314#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007315
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007316#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007317int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
7318 unsigned char *hash,
7319 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08007320{
7321#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007322 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
7323 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007324#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007325 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
7326 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007327#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007328}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007329#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007330
Neil Armstrong80f6f322022-05-03 17:56:38 +02007331#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
7332 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007333int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08007334{
7335 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01007336 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007337 const unsigned char *psk = NULL;
7338 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007339 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007340
Gilles Peskine449bd832023-01-11 14:50:10 +01007341 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007342 /*
7343 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007344 * checked before calling this function.
7345 *
7346 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007347 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08007348 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007349 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
7350 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7351 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007352 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007353 }
7354
7355 /*
7356 * PMS = struct {
7357 * opaque other_secret<0..2^16-1>;
7358 * opaque psk<0..2^16-1>;
7359 * };
7360 * with "other_secret" depending on the particular key exchange
7361 */
7362#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007363 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
7364 if (end - p < 2) {
7365 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7366 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007367
Gilles Peskine449bd832023-01-11 14:50:10 +01007368 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007369 p += 2;
7370
Gilles Peskine449bd832023-01-11 14:50:10 +01007371 if (end < p || (size_t) (end - p) < psk_len) {
7372 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7373 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007374
Gilles Peskine449bd832023-01-11 14:50:10 +01007375 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007376 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007377 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007378#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007379#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007380 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007381 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7382 size_t len;
7383
7384 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01007385 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007386 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01007387 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7388 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
7389 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007390 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007391 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007392 p += 2 + len;
7393
Gilles Peskine449bd832023-01-11 14:50:10 +01007394 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
7395 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007396#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02007397#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007398 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007399 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7400 size_t zlen;
7401
Gilles Peskine449bd832023-01-11 14:50:10 +01007402 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007403 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01007404 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7405 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
7406 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007407 }
7408
Gilles Peskine449bd832023-01-11 14:50:10 +01007409 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007410 p += 2 + zlen;
7411
Gilles Peskine449bd832023-01-11 14:50:10 +01007412 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
7413 MBEDTLS_DEBUG_ECDH_Z);
7414 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02007415#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007416 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007417 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7418 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08007419 }
7420
7421 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01007422 if (end - p < 2) {
7423 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7424 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007425
Gilles Peskine449bd832023-01-11 14:50:10 +01007426 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007427 p += 2;
7428
Gilles Peskine449bd832023-01-11 14:50:10 +01007429 if (end < p || (size_t) (end - p) < psk_len) {
7430 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7431 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007432
Gilles Peskine449bd832023-01-11 14:50:10 +01007433 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007434 p += psk_len;
7435
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007436 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007437
Gilles Peskine449bd832023-01-11 14:50:10 +01007438 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08007439}
Neil Armstrong80f6f322022-05-03 17:56:38 +02007440#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007441
7442#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007443MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007444static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007445
7446#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007447int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08007448{
7449 /* If renegotiation is not enforced, retransmit until we would reach max
7450 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01007451 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007452 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7453 unsigned char doublings = 1;
7454
Gilles Peskine449bd832023-01-11 14:50:10 +01007455 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007456 ++doublings;
7457 ratio >>= 1;
7458 }
7459
Gilles Peskine449bd832023-01-11 14:50:10 +01007460 if (++ssl->renego_records_seen > doublings) {
7461 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
7462 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08007463 }
7464 }
7465
Gilles Peskine449bd832023-01-11 14:50:10 +01007466 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007467}
7468#endif
7469#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007470
Jerry Yud9526692022-02-17 14:23:47 +08007471/*
7472 * Handshake functions
7473 */
7474#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7475/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007476int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007477{
7478 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7479 ssl->handshake->ciphersuite_info;
7480
Gilles Peskine449bd832023-01-11 14:50:10 +01007481 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007482
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7484 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007485 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007487 }
7488
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7490 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007491}
7492
Gilles Peskine449bd832023-01-11 14:50:10 +01007493int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007494{
7495 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7496 ssl->handshake->ciphersuite_info;
7497
Gilles Peskine449bd832023-01-11 14:50:10 +01007498 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007499
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7501 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007502 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007503 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007504 }
7505
Gilles Peskine449bd832023-01-11 14:50:10 +01007506 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7507 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007508}
7509
7510#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7511/* Some certificate support -> implement write and parse */
7512
Gilles Peskine449bd832023-01-11 14:50:10 +01007513int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007514{
7515 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7516 size_t i, n;
7517 const mbedtls_x509_crt *crt;
7518 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7519 ssl->handshake->ciphersuite_info;
7520
Gilles Peskine449bd832023-01-11 14:50:10 +01007521 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007522
Gilles Peskine449bd832023-01-11 14:50:10 +01007523 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7524 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007525 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007526 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007527 }
7528
7529#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007530 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7531 if (ssl->handshake->client_auth == 0) {
7532 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007533 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007534 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007535 }
7536 }
7537#endif /* MBEDTLS_SSL_CLI_C */
7538#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007539 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7540 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007541 /* Should never happen because we shouldn't have picked the
7542 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007544 }
7545 }
7546#endif
7547
Gilles Peskine449bd832023-01-11 14:50:10 +01007548 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007549
7550 /*
7551 * 0 . 0 handshake type
7552 * 1 . 3 handshake length
7553 * 4 . 6 length of all certs
7554 * 7 . 9 length of cert. 1
7555 * 10 . n-1 peer certificate
7556 * n . n+2 length of cert. 2
7557 * n+3 . ... upper level cert, etc.
7558 */
7559 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007560 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007561
Gilles Peskine449bd832023-01-11 14:50:10 +01007562 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007563 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007564 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7565 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7566 " > %" MBEDTLS_PRINTF_SIZET,
7567 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7568 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007569 }
7570
Gilles Peskine449bd832023-01-11 14:50:10 +01007571 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7572 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7573 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007574
Gilles Peskine449bd832023-01-11 14:50:10 +01007575 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007576 i += n; crt = crt->next;
7577 }
7578
Gilles Peskine449bd832023-01-11 14:50:10 +01007579 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7580 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7581 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007582
7583 ssl->out_msglen = i;
7584 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7585 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7586
7587 ssl->state++;
7588
Gilles Peskine449bd832023-01-11 14:50:10 +01007589 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7590 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7591 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007592 }
7593
Gilles Peskine449bd832023-01-11 14:50:10 +01007594 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007595
Gilles Peskine449bd832023-01-11 14:50:10 +01007596 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007597}
7598
7599#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7600
7601#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007602MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007603static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7604 unsigned char *crt_buf,
7605 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007606{
7607 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7608
Gilles Peskine449bd832023-01-11 14:50:10 +01007609 if (peer_crt == NULL) {
7610 return -1;
7611 }
Jerry Yud9526692022-02-17 14:23:47 +08007612
Gilles Peskine449bd832023-01-11 14:50:10 +01007613 if (peer_crt->raw.len != crt_buf_len) {
7614 return -1;
7615 }
Jerry Yud9526692022-02-17 14:23:47 +08007616
Gilles Peskine449bd832023-01-11 14:50:10 +01007617 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007618}
7619#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007620MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007621static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7622 unsigned char *crt_buf,
7623 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007624{
7625 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7626 unsigned char const * const peer_cert_digest =
7627 ssl->session->peer_cert_digest;
7628 mbedtls_md_type_t const peer_cert_digest_type =
7629 ssl->session->peer_cert_digest_type;
7630 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007631 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007632 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7633 size_t digest_len;
7634
Gilles Peskine449bd832023-01-11 14:50:10 +01007635 if (peer_cert_digest == NULL || digest_info == NULL) {
7636 return -1;
7637 }
Jerry Yud9526692022-02-17 14:23:47 +08007638
Gilles Peskine449bd832023-01-11 14:50:10 +01007639 digest_len = mbedtls_md_get_size(digest_info);
7640 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7641 return -1;
7642 }
Jerry Yud9526692022-02-17 14:23:47 +08007643
Gilles Peskine449bd832023-01-11 14:50:10 +01007644 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7645 if (ret != 0) {
7646 return -1;
7647 }
Jerry Yud9526692022-02-17 14:23:47 +08007648
Gilles Peskine449bd832023-01-11 14:50:10 +01007649 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007650}
7651#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7652#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7653
7654/*
7655 * Once the certificate message is read, parse it into a cert chain and
7656 * perform basic checks, but leave actual verification to the caller
7657 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007658MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007659static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7660 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007661{
7662 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7663#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007664 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007665#endif
7666 size_t i, n;
7667 uint8_t alert;
7668
Gilles Peskine449bd832023-01-11 14:50:10 +01007669 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7670 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7671 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7672 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7673 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007674 }
7675
Gilles Peskine449bd832023-01-11 14:50:10 +01007676 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7677 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7678 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7679 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007680 }
7681
Gilles Peskine449bd832023-01-11 14:50:10 +01007682 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7683 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7684 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7685 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7686 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007687 }
7688
Gilles Peskine449bd832023-01-11 14:50:10 +01007689 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007690
7691 /*
7692 * Same message structure as in mbedtls_ssl_write_certificate()
7693 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007694 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007695
Gilles Peskine449bd832023-01-11 14:50:10 +01007696 if (ssl->in_msg[i] != 0 ||
7697 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7698 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7699 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7700 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7701 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007702 }
7703
7704 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7705 i += 3;
7706
7707 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007708 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007709 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007710 if (i + 3 > ssl->in_hslen) {
7711 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7712 mbedtls_ssl_send_alert_message(ssl,
7713 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7714 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7715 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007716 }
7717 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7718 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007719 if (ssl->in_msg[i] != 0) {
7720 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7721 mbedtls_ssl_send_alert_message(ssl,
7722 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7723 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7724 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007725 }
7726
7727 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007728 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007729 i += 3;
7730
Gilles Peskine449bd832023-01-11 14:50:10 +01007731 if (n < 128 || i + n > ssl->in_hslen) {
7732 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7733 mbedtls_ssl_send_alert_message(ssl,
7734 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7735 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7736 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007737 }
7738
7739 /* Check if we're handling the first CRT in the chain. */
7740#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007741 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007742 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007743 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007744 /* During client-side renegotiation, check that the server's
7745 * end-CRTs hasn't changed compared to the initial handshake,
7746 * mitigating the triple handshake attack. On success, reuse
7747 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007748 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7749 if (ssl_check_peer_crt_unchanged(ssl,
7750 &ssl->in_msg[i],
7751 n) != 0) {
7752 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7753 mbedtls_ssl_send_alert_message(ssl,
7754 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7755 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7756 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007757 }
7758
7759 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007760 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007761 }
7762#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7763
7764 /* Parse the next certificate in the chain. */
7765#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007766 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007767#else
7768 /* If we don't need to store the CRT chain permanently, parse
7769 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007770 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007771#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007772 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007773 case 0: /*ok*/
7774 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7775 /* Ignore certificate with an unknown algorithm: maybe a
7776 prior certificate was already trusted. */
7777 break;
7778
7779 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7780 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7781 goto crt_parse_der_failed;
7782
7783 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7784 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7785 goto crt_parse_der_failed;
7786
7787 default:
7788 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007789crt_parse_der_failed:
7790 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7791 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7792 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007793 }
7794
7795 i += n;
7796 }
7797
Gilles Peskine449bd832023-01-11 14:50:10 +01007798 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7799 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007800}
7801
7802#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007803MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007804static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007805{
Gilles Peskine449bd832023-01-11 14:50:10 +01007806 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7807 return -1;
7808 }
Jerry Yud9526692022-02-17 14:23:47 +08007809
Gilles Peskine449bd832023-01-11 14:50:10 +01007810 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007811 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7812 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007813 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7814 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7815 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007816 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007817 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007818}
7819#endif /* MBEDTLS_SSL_SRV_C */
7820
7821/* Check if a certificate message is expected.
7822 * Return either
7823 * - SSL_CERTIFICATE_EXPECTED, or
7824 * - SSL_CERTIFICATE_SKIP
7825 * indicating whether a Certificate message is expected or not.
7826 */
7827#define SSL_CERTIFICATE_EXPECTED 0
7828#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007829MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007830static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7831 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007832{
7833 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7834 ssl->handshake->ciphersuite_info;
7835
Gilles Peskine449bd832023-01-11 14:50:10 +01007836 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7837 return SSL_CERTIFICATE_SKIP;
7838 }
Jerry Yud9526692022-02-17 14:23:47 +08007839
7840#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007841 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007842 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007843 ssl->session_negotiate->verify_result =
7844 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007845 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007846 }
7847 }
7848#else
7849 ((void) authmode);
7850#endif /* MBEDTLS_SSL_SRV_C */
7851
Gilles Peskine449bd832023-01-11 14:50:10 +01007852 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007853}
7854
Jerry Yud9526692022-02-17 14:23:47 +08007855#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007856MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007857static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7858 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007859{
7860 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7861 /* Remember digest of the peer's end-CRT. */
7862 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007863 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7864 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7865 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7866 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7867 mbedtls_ssl_send_alert_message(ssl,
7868 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7869 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007870
Gilles Peskine449bd832023-01-11 14:50:10 +01007871 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007872 }
7873
Gilles Peskine449bd832023-01-11 14:50:10 +01007874 ret = mbedtls_md(mbedtls_md_info_from_type(
7875 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7876 start, len,
7877 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007878
7879 ssl->session_negotiate->peer_cert_digest_type =
7880 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7881 ssl->session_negotiate->peer_cert_digest_len =
7882 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7883
Gilles Peskine449bd832023-01-11 14:50:10 +01007884 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007885}
7886
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007887MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007888static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7889 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007890{
7891 unsigned char *end = start + len;
7892 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7893
7894 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007895 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7896 ret = mbedtls_pk_parse_subpubkey(&start, end,
7897 &ssl->handshake->peer_pubkey);
7898 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007899 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007900 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007901 }
7902
Gilles Peskine449bd832023-01-11 14:50:10 +01007903 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007904}
7905#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7906
Gilles Peskine449bd832023-01-11 14:50:10 +01007907int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007908{
7909 int ret = 0;
7910 int crt_expected;
Manuel Pégourié-Gonnard58ab9ba2024-08-14 09:47:38 +02007911 /* Authmode: precedence order is SNI if used else configuration */
Jerry Yud9526692022-02-17 14:23:47 +08007912#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7913 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7914 ? ssl->handshake->sni_authmode
7915 : ssl->conf->authmode;
7916#else
7917 const int authmode = ssl->conf->authmode;
7918#endif
7919 void *rs_ctx = NULL;
7920 mbedtls_x509_crt *chain = NULL;
7921
Gilles Peskine449bd832023-01-11 14:50:10 +01007922 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007923
Gilles Peskine449bd832023-01-11 14:50:10 +01007924 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7925 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7926 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007927 goto exit;
7928 }
7929
7930#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007931 if (ssl->handshake->ecrs_enabled &&
7932 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007933 chain = ssl->handshake->ecrs_peer_cert;
7934 ssl->handshake->ecrs_peer_cert = NULL;
7935 goto crt_verify;
7936 }
7937#endif
7938
Gilles Peskine449bd832023-01-11 14:50:10 +01007939 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007940 /* mbedtls_ssl_read_record may have sent an alert already. We
7941 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007942 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007943 goto exit;
7944 }
7945
7946#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007947 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007948 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7949
Gilles Peskine449bd832023-01-11 14:50:10 +01007950 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007951 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007952 }
Jerry Yud9526692022-02-17 14:23:47 +08007953
7954 goto exit;
7955 }
7956#endif /* MBEDTLS_SSL_SRV_C */
7957
7958 /* Clear existing peer CRT structure in case we tried to
7959 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007960 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007961
Gilles Peskine449bd832023-01-11 14:50:10 +01007962 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7963 if (chain == NULL) {
7964 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7965 sizeof(mbedtls_x509_crt)));
7966 mbedtls_ssl_send_alert_message(ssl,
7967 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7968 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007969
7970 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7971 goto exit;
7972 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007973 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007974
Gilles Peskine449bd832023-01-11 14:50:10 +01007975 ret = ssl_parse_certificate_chain(ssl, chain);
7976 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007977 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007978 }
Jerry Yud9526692022-02-17 14:23:47 +08007979
7980#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007981 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007982 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007983 }
Jerry Yud9526692022-02-17 14:23:47 +08007984
7985crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007986 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007987 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007988 }
Jerry Yud9526692022-02-17 14:23:47 +08007989#endif
7990
Manuel Pégourié-Gonnard19dd9f52024-08-16 11:03:42 +02007991 ret = mbedtls_ssl_verify_certificate(ssl, authmode, chain,
7992 ssl->handshake->ciphersuite_info,
7993 rs_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +01007994 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007995 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007996 }
Jerry Yud9526692022-02-17 14:23:47 +08007997
7998#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7999 {
8000 unsigned char *crt_start, *pk_start;
8001 size_t crt_len, pk_len;
8002
8003 /* We parse the CRT chain without copying, so
8004 * these pointers point into the input buffer,
8005 * and are hence still valid after freeing the
8006 * CRT chain. */
8007
8008 crt_start = chain->raw.p;
8009 crt_len = chain->raw.len;
8010
8011 pk_start = chain->pk_raw.p;
8012 pk_len = chain->pk_raw.len;
8013
8014 /* Free the CRT structures before computing
8015 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008016 mbedtls_x509_crt_free(chain);
8017 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008018 chain = NULL;
8019
Gilles Peskine449bd832023-01-11 14:50:10 +01008020 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
8021 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008022 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008023 }
Jerry Yud9526692022-02-17 14:23:47 +08008024
Gilles Peskine449bd832023-01-11 14:50:10 +01008025 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
8026 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008027 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008028 }
Jerry Yud9526692022-02-17 14:23:47 +08008029 }
8030#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8031 /* Pass ownership to session structure. */
8032 ssl->session_negotiate->peer_cert = chain;
8033 chain = NULL;
8034#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8035
Gilles Peskine449bd832023-01-11 14:50:10 +01008036 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008037
8038exit:
8039
Gilles Peskine449bd832023-01-11 14:50:10 +01008040 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008041 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008042 }
Jerry Yud9526692022-02-17 14:23:47 +08008043
8044#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008045 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08008046 ssl->handshake->ecrs_peer_cert = chain;
8047 chain = NULL;
8048 }
8049#endif
8050
Gilles Peskine449bd832023-01-11 14:50:10 +01008051 if (chain != NULL) {
8052 mbedtls_x509_crt_free(chain);
8053 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008054 }
8055
Gilles Peskine449bd832023-01-11 14:50:10 +01008056 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008057}
8058#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8059
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008060static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
8061 unsigned char *padbuf, size_t hlen,
8062 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008063{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008064 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008065 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008066#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008067 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008068 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008069 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008070 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008071#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008072 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008073 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008074 mbedtls_md_context_t cloned_ctx;
8075 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008076#endif
8077
8078 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01008079 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08008080 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01008081 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008082
Gilles Peskine449bd832023-01-11 14:50:10 +01008083 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008084 ? "client finished"
8085 : "server finished";
8086
8087#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008088 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008089
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008090 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01008091 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008092 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008093 }
8094
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008095 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01008096 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008097 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008098 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008099 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008100#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008101 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008102
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008103 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008104 if (ret != 0) {
8105 goto exit;
8106 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008107 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008108 if (ret != 0) {
8109 goto exit;
8110 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008111
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008112 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008113 if (ret != 0) {
8114 goto exit;
8115 }
8116#endif /* MBEDTLS_USE_PSA_CRYPTO */
8117
8118 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
8119
Jerry Yu615bd6f2022-02-17 14:25:15 +08008120 /*
8121 * TLSv1.2:
8122 * hash = PRF( master, finished_label,
8123 * Hash( handshake ) )[0.11]
8124 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008125 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008126 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008127
Gilles Peskine449bd832023-01-11 14:50:10 +01008128 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008129
Paul Elliottecb95be2023-08-11 16:41:04 +01008130 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008131
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008132 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008133
8134exit:
8135#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008136 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02008137 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008138#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008139 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008140 return ret;
8141#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08008142}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008143
Elena Uziunaite0916cd72024-05-23 17:01:07 +01008144#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008145static int ssl_calc_finished_tls_sha256(
8146 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
8147{
8148 unsigned char padbuf[32];
8149 return ssl_calc_finished_tls_generic(ssl,
8150#if defined(MBEDTLS_USE_PSA_CRYPTO)
8151 &ssl->handshake->fin_sha256_psa,
8152#else
8153 &ssl->handshake->fin_sha256,
8154#endif
8155 padbuf, sizeof(padbuf),
8156 buf, from);
8157}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01008158#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08008159
Jerry Yub7ba49e2022-02-17 14:25:53 +08008160
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01008161#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01008162static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01008163 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08008164{
Jerry Yub7ba49e2022-02-17 14:25:53 +08008165 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008166 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008167#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008168 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008169#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008170 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008171#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008172 padbuf, sizeof(padbuf),
8173 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08008174}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01008175#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08008176
Gilles Peskine449bd832023-01-11 14:50:10 +01008177void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08008178{
Gilles Peskine449bd832023-01-11 14:50:10 +01008179 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008180
8181 /*
8182 * Free our handshake params
8183 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008184 mbedtls_ssl_handshake_free(ssl);
8185 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08008186 ssl->handshake = NULL;
8187
8188 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08008189 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08008190 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008191 if (ssl->transform) {
8192 mbedtls_ssl_transform_free(ssl->transform);
8193 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08008194 }
8195 ssl->transform = ssl->transform_negotiate;
8196 ssl->transform_negotiate = NULL;
8197
Gilles Peskine449bd832023-01-11 14:50:10 +01008198 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008199}
8200
Gilles Peskine449bd832023-01-11 14:50:10 +01008201void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08008202{
8203 int resume = ssl->handshake->resume;
8204
Gilles Peskine449bd832023-01-11 14:50:10 +01008205 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008206
8207#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008208 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008209 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
8210 ssl->renego_records_seen = 0;
8211 }
8212#endif
8213
8214 /*
8215 * Free the previous session and switch in the current one
8216 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008217 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008218#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8219 /* RFC 7366 3.1: keep the EtM state */
8220 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01008221 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008222#endif
8223
Gilles Peskine449bd832023-01-11 14:50:10 +01008224 mbedtls_ssl_session_free(ssl->session);
8225 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008226 }
8227 ssl->session = ssl->session_negotiate;
8228 ssl->session_negotiate = NULL;
8229
8230 /*
8231 * Add cache entry
8232 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008233 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08008234 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01008235 resume == 0) {
8236 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
8237 ssl->session->id,
8238 ssl->session->id_len,
8239 ssl->session) != 0) {
8240 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
8241 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08008242 }
8243
8244#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008245 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8246 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008247 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01008248 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008249
8250 /* Keep last flight around in case we need to resend it:
8251 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01008252 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
8253 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08008254#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008255 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008256
Jerry Yu5ed73ff2022-10-27 13:08:42 +08008257 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008258
Gilles Peskine449bd832023-01-11 14:50:10 +01008259 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008260}
8261
Gilles Peskine449bd832023-01-11 14:50:10 +01008262int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008263{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008264 int ret;
8265 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008266
Gilles Peskine449bd832023-01-11 14:50:10 +01008267 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008268
Gilles Peskine449bd832023-01-11 14:50:10 +01008269 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008270
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008271 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
8272 if (ret != 0) {
8273 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8274 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008275
8276 /*
8277 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
8278 * may define some other value. Currently (early 2016), no defined
8279 * ciphersuite does this (and this is unlikely to change as activity has
8280 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
8281 */
8282 hash_len = 12;
8283
8284#if defined(MBEDTLS_SSL_RENEGOTIATION)
8285 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008286 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008287#endif
8288
8289 ssl->out_msglen = 4 + hash_len;
8290 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8291 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8292
8293 /*
8294 * In case of session resuming, invert the client and server
8295 * ChangeCipherSpec messages order.
8296 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008297 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008298#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008299 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008300 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008301 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008302#endif
8303#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008304 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008305 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008306 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008307#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008308 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008309 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008310 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008311
8312 /*
8313 * Switch to our negotiated transform and session parameters for outbound
8314 * data.
8315 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008316 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008317
8318#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008319 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008320 unsigned char i;
8321
8322 /* Remember current epoch settings for resending */
8323 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008324 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8325 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008326
8327 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008328 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008329
8330
8331 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008332 for (i = 2; i > 0; i--) {
8333 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008334 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008335 }
8336 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008337
8338 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008339 if (i == 0) {
8340 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8341 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008342 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008343 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008344#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008345 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008346
8347 ssl->transform_out = ssl->transform_negotiate;
8348 ssl->session_out = ssl->session_negotiate;
8349
8350#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008351 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8352 mbedtls_ssl_send_flight_completed(ssl);
8353 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008354#endif
8355
Gilles Peskine449bd832023-01-11 14:50:10 +01008356 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8357 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8358 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008359 }
8360
8361#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008362 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8363 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8364 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8365 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008366 }
8367#endif
8368
Gilles Peskine449bd832023-01-11 14:50:10 +01008369 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008370
Gilles Peskine449bd832023-01-11 14:50:10 +01008371 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008372}
8373
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008374#define SSL_MAX_HASH_LEN 12
8375
Gilles Peskine449bd832023-01-11 14:50:10 +01008376int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008377{
8378 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8379 unsigned int hash_len = 12;
8380 unsigned char buf[SSL_MAX_HASH_LEN];
8381
Gilles Peskine449bd832023-01-11 14:50:10 +01008382 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008383
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008384 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8385 if (ret != 0) {
8386 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8387 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008388
Gilles Peskine449bd832023-01-11 14:50:10 +01008389 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8390 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008391 goto exit;
8392 }
8393
Gilles Peskine449bd832023-01-11 14:50:10 +01008394 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8395 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8396 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8397 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008398 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8399 goto exit;
8400 }
8401
Gilles Peskine449bd832023-01-11 14:50:10 +01008402 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8403 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8404 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008405 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8406 goto exit;
8407 }
8408
Gilles Peskine449bd832023-01-11 14:50:10 +01008409 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8410 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8411 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8412 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008413 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8414 goto exit;
8415 }
8416
Gilles Peskine449bd832023-01-11 14:50:10 +01008417 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8418 buf, hash_len) != 0) {
8419 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8420 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8421 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008422 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8423 goto exit;
8424 }
8425
8426#if defined(MBEDTLS_SSL_RENEGOTIATION)
8427 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008428 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008429#endif
8430
Gilles Peskine449bd832023-01-11 14:50:10 +01008431 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008432#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008433 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008434 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008435 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008436#endif
8437#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008438 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008439 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008440 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008441#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008442 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008443 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008444 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008445
8446#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008447 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8448 mbedtls_ssl_recv_flight_completed(ssl);
8449 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008450#endif
8451
Gilles Peskine449bd832023-01-11 14:50:10 +01008452 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008453
8454exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008455 mbedtls_platform_zeroize(buf, hash_len);
8456 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008457}
8458
Jerry Yu392112c2022-02-17 14:34:10 +08008459#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8460/*
8461 * Helper to get TLS 1.2 PRF from ciphersuite
8462 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8463 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008464static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008465{
Jerry Yu392112c2022-02-17 14:34:10 +08008466 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008467 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01008468#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008469 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8470 return tls_prf_sha384;
8471 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008472#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01008473#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008474 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008475 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8476 return tls_prf_sha256;
8477 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008478 }
8479#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01008480#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01008481 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008482 (void) ciphersuite_info;
8483#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008484
Gilles Peskine449bd832023-01-11 14:50:10 +01008485 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008486}
8487#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008488
Gilles Peskine449bd832023-01-11 14:50:10 +01008489static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008490{
8491 ((void) tls_prf);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01008492#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008493 if (tls_prf == tls_prf_sha384) {
8494 return MBEDTLS_SSL_TLS_PRF_SHA384;
8495 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008496#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01008497#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008498 if (tls_prf == tls_prf_sha256) {
8499 return MBEDTLS_SSL_TLS_PRF_SHA256;
8500 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008501#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008502 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008503}
8504
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008505/*
8506 * Populate a transform structure with session keys and all the other
8507 * necessary information.
8508 *
8509 * Parameters:
8510 * - [in/out]: transform: structure to populate
8511 * [in] must be just initialised with mbedtls_ssl_transform_init()
8512 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8513 * - [in] ciphersuite
8514 * - [in] master
8515 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008516 * - [in] tls_prf: pointer to PRF to use for key derivation
8517 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008518 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008519 * - [in] endpoint: client or server
8520 * - [in] ssl: used for:
8521 * - ssl->conf->{f,p}_export_keys
8522 * [in] optionally used for:
8523 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8524 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008525MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008526static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8527 int ciphersuite,
8528 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008529#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008530 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008531#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008532 ssl_tls_prf_t tls_prf,
8533 const unsigned char randbytes[64],
8534 mbedtls_ssl_protocol_version tls_version,
8535 unsigned endpoint,
8536 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008537{
8538 int ret = 0;
8539 unsigned char keyblk[256];
8540 unsigned char *key1;
8541 unsigned char *key2;
8542 unsigned char *mac_enc;
8543 unsigned char *mac_dec;
8544 size_t mac_key_len = 0;
8545 size_t iv_copy_len;
8546 size_t keylen;
8547 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008548 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008549#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008550 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008551 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008552#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008553
8554#if defined(MBEDTLS_USE_PSA_CRYPTO)
8555 psa_key_type_t key_type;
8556 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8557 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008558 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008559 size_t key_bits;
8560 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8561#endif
8562
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008563 /*
8564 * Some data just needs copying into the structure
8565 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008566#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008567 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008568#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008569 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008570
8571#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008572 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008573#endif
8574
8575#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008576 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008577 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8578 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008579 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008580 }
8581#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8582
8583 /*
8584 * Get various info structures
8585 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008586 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8587 if (ciphersuite_info == NULL) {
8588 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8589 ciphersuite));
8590 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008591 }
8592
Neil Armstrongab555e02022-04-04 11:07:59 +02008593 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008594#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008595 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008596#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008597 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008598
Gilles Peskine449bd832023-01-11 14:50:10 +01008599 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008600 transform->taglen =
8601 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008602 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008603
8604#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008605 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008606 transform->taglen,
8607 &alg,
8608 &key_type,
8609 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008610 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008611 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008612 goto end;
8613 }
8614#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008615 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008616 if (cipher_info == NULL) {
8617 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8618 ciphersuite_info->cipher));
8619 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008620 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008621#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008622
Neil Armstronge4512952022-03-08 09:08:22 +01008623#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008624 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008625 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008626 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008627 (unsigned) ciphersuite_info->mac));
8628 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008629 }
8630#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008631 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008632 if (md_info == NULL) {
8633 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8634 (unsigned) ciphersuite_info->mac));
8635 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008636 }
Neil Armstronge4512952022-03-08 09:08:22 +01008637#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008638
8639#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8640 /* Copy own and peer's CID if the use of the CID
8641 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008642 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8643 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008644
8645 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008646 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8647 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8648 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008649
8650 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008651 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8652 ssl->handshake->peer_cid_len);
8653 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8654 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008655 }
8656#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8657
8658 /*
8659 * Compute key block using the PRF
8660 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008661 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8662 if (ret != 0) {
8663 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8664 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008665 }
8666
Gilles Peskine449bd832023-01-11 14:50:10 +01008667 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8668 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8669 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8670 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8671 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008672
8673 /*
8674 * Determine the appropriate key, IV and MAC length.
8675 */
8676
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008677#if defined(MBEDTLS_USE_PSA_CRYPTO)
8678 keylen = PSA_BITS_TO_BYTES(key_bits);
8679#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008680 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008681#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008682
Valerio Settie5707042023-10-11 11:54:42 +02008683#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008684 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008685 size_t explicit_ivlen;
8686
8687 transform->maclen = 0;
8688 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008689
8690 /* All modes haves 96-bit IVs, but the length of the static parts vary
8691 * with mode and version:
8692 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8693 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8694 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8695 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8696 * sequence number).
8697 */
8698 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008699
8700 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008701#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008702 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008703#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008704 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8705 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008706#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008707
Gilles Peskine449bd832023-01-11 14:50:10 +01008708 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008709 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008710 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008711 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008712 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008713
8714 /* Minimum length of encrypted record */
8715 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8716 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008717 } else
Valerio Settie5707042023-10-11 11:54:42 +02008718#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008719#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008720 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008721 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008722 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008723#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008724 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008725#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008726 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008727#endif /* MBEDTLS_USE_PSA_CRYPTO */
8728
8729#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008730 /* Get MAC length */
8731 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8732#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008733 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008734 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8735 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8736 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008737 goto end;
8738 }
8739
8740 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008741 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008742#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008743 transform->maclen = mac_key_len;
8744
8745 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008746#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008747 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008748#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008749 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008750#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008751
8752 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008753 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008754 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008755 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008756 /*
8757 * GenericBlockCipher:
8758 * 1. if EtM is in use: one block plus MAC
8759 * otherwise: * first multiple of blocklen greater than maclen
8760 * 2. IV
8761 */
8762#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008763 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008764 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008765 + block_size;
8766 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008767#endif
8768 {
8769 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008770 + block_size
8771 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008772 }
8773
Gilles Peskine449bd832023-01-11 14:50:10 +01008774 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008775 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008776 } else {
8777 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008778 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8779 goto end;
8780 }
8781 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008782 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008783#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8784 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008785 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8786 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008787 }
8788
Gilles Peskine449bd832023-01-11 14:50:10 +01008789 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8790 (unsigned) keylen,
8791 (unsigned) transform->minlen,
8792 (unsigned) transform->ivlen,
8793 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008794
8795 /*
8796 * Finally setup the cipher contexts, IVs and MAC secrets.
8797 */
8798#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008799 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008800 key1 = keyblk + mac_key_len * 2;
8801 key2 = keyblk + mac_key_len * 2 + keylen;
8802
8803 mac_enc = keyblk;
8804 mac_dec = keyblk + mac_key_len;
8805
Gilles Peskine449bd832023-01-11 14:50:10 +01008806 iv_copy_len = (transform->fixed_ivlen) ?
8807 transform->fixed_ivlen : transform->ivlen;
8808 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8809 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8810 iv_copy_len);
8811 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008812#endif /* MBEDTLS_SSL_CLI_C */
8813#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008814 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008815 key1 = keyblk + mac_key_len * 2 + keylen;
8816 key2 = keyblk + mac_key_len * 2;
8817
8818 mac_enc = keyblk + mac_key_len;
8819 mac_dec = keyblk;
8820
Gilles Peskine449bd832023-01-11 14:50:10 +01008821 iv_copy_len = (transform->fixed_ivlen) ?
8822 transform->fixed_ivlen : transform->ivlen;
8823 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8824 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8825 iv_copy_len);
8826 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008827#endif /* MBEDTLS_SSL_SRV_C */
8828 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008829 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008830 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8831 goto end;
8832 }
8833
Paul Elliott4fb19552023-10-18 12:15:30 +01008834 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008835 ssl->f_export_keys(ssl->p_export_keys,
8836 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8837 master, 48,
8838 randbytes + 32,
8839 randbytes,
8840 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008841 }
8842
8843#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008844 transform->psa_alg = alg;
8845
Gilles Peskine449bd832023-01-11 14:50:10 +01008846 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8847 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8848 psa_set_key_algorithm(&attributes, alg);
8849 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008850
Gilles Peskine449bd832023-01-11 14:50:10 +01008851 if ((status = psa_import_key(&attributes,
8852 key1,
8853 PSA_BITS_TO_BYTES(key_bits),
8854 &transform->psa_key_enc)) != PSA_SUCCESS) {
8855 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008856 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008857 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008858 goto end;
8859 }
8860
Gilles Peskine449bd832023-01-11 14:50:10 +01008861 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008862
Gilles Peskine449bd832023-01-11 14:50:10 +01008863 if ((status = psa_import_key(&attributes,
8864 key2,
8865 PSA_BITS_TO_BYTES(key_bits),
8866 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008867 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008868 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008869 goto end;
8870 }
8871 }
8872#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008873 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8874 cipher_info)) != 0) {
8875 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008876 goto end;
8877 }
8878
Gilles Peskine449bd832023-01-11 14:50:10 +01008879 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8880 cipher_info)) != 0) {
8881 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008882 goto end;
8883 }
8884
Gilles Peskine449bd832023-01-11 14:50:10 +01008885 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8886 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8887 MBEDTLS_ENCRYPT)) != 0) {
8888 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008889 goto end;
8890 }
8891
Gilles Peskine449bd832023-01-11 14:50:10 +01008892 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8893 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8894 MBEDTLS_DECRYPT)) != 0) {
8895 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008896 goto end;
8897 }
8898
8899#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008900 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8901 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8902 MBEDTLS_PADDING_NONE)) != 0) {
8903 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008904 goto end;
8905 }
8906
Gilles Peskine449bd832023-01-11 14:50:10 +01008907 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8908 MBEDTLS_PADDING_NONE)) != 0) {
8909 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008910 goto end;
8911 }
8912 }
8913#endif /* MBEDTLS_CIPHER_MODE_CBC */
8914#endif /* MBEDTLS_USE_PSA_CRYPTO */
8915
Neil Armstrong29c0c042022-03-17 17:47:28 +01008916#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8917 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8918 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008919 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008920#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008921 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008922
Gilles Peskine449bd832023-01-11 14:50:10 +01008923 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8924 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8925 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008926
Gilles Peskine449bd832023-01-11 14:50:10 +01008927 if ((status = psa_import_key(&attributes,
8928 mac_enc, mac_key_len,
8929 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008930 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008931 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008932 goto end;
8933 }
8934
Gilles Peskine449bd832023-01-11 14:50:10 +01008935 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8936 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008937#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008938 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008939#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008940 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008941 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008942 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8943 PSA_KEY_USAGE_VERIFY_HASH);
8944 } else {
8945 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8946 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008947
Gilles Peskine449bd832023-01-11 14:50:10 +01008948 if ((status = psa_import_key(&attributes,
8949 mac_dec, mac_key_len,
8950 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008951 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008952 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008953 goto end;
8954 }
8955#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008956 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8957 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008958 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008959 }
8960 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8961 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008962 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008963 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008964#endif /* MBEDTLS_USE_PSA_CRYPTO */
8965 }
8966#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8967
8968 ((void) mac_dec);
8969 ((void) mac_enc);
8970
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008971end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008972 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8973 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008974}
8975
Valerio Settia08b1a42022-11-17 15:10:02 +01008976#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8977 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008978int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008979 psa_pake_operation_t *pake_ctx,
8980 const unsigned char *buf,
8981 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008982{
8983 psa_status_t status;
8984 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008985 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008986 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8987 * At round two perform a single cycle
8988 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008989 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008990
Gilles Peskine449bd832023-01-11 14:50:10 +01008991 for (; remaining_steps > 0; remaining_steps--) {
8992 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008993 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008994 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008995 /* Length is stored at the first byte */
8996 size_t length = buf[input_offset];
8997 input_offset += 1;
8998
Gilles Peskine449bd832023-01-11 14:50:10 +01008999 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009000 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
9001 }
9002
Gilles Peskine449bd832023-01-11 14:50:10 +01009003 status = psa_pake_input(pake_ctx, step,
9004 buf + input_offset, length);
9005 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009006 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009007 }
9008
9009 input_offset += length;
9010 }
9011 }
9012
Gilles Peskine449bd832023-01-11 14:50:10 +01009013 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01009014 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01009015 }
Valerio Setti30ebe112022-11-17 16:23:34 +01009016
Gilles Peskine449bd832023-01-11 14:50:10 +01009017 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009018}
9019
Valerio Setti6b3dab02022-11-17 17:14:54 +01009020int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009021 psa_pake_operation_t *pake_ctx,
9022 unsigned char *buf,
9023 size_t len, size_t *olen,
9024 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009025{
9026 psa_status_t status;
9027 size_t output_offset = 0;
9028 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01009029 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009030 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9031 * At round two perform a single cycle
9032 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009033 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009034
Gilles Peskine449bd832023-01-11 14:50:10 +01009035 for (; remaining_steps > 0; remaining_steps--) {
9036 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
9037 step <= PSA_PAKE_STEP_ZK_PROOF;
9038 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009039 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01009040 * For each step, prepend 1 byte with the length of the data as
9041 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009042 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009043 status = psa_pake_output(pake_ctx, step,
9044 buf + output_offset + 1,
9045 len - output_offset - 1,
9046 &output_len);
9047 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009048 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009049 }
9050
Valerio Setti99d88c12022-11-22 16:03:43 +01009051 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009052
9053 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009054 }
9055 }
9056
9057 *olen = output_offset;
9058
Gilles Peskine449bd832023-01-11 14:50:10 +01009059 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009060}
Valerio Settia08b1a42022-11-17 15:10:02 +01009061#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
9062
Jerry Yuee40f9d2022-02-17 14:55:16 +08009063#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009064int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9065 unsigned char *hash, size_t *hashlen,
9066 unsigned char *data, size_t data_len,
9067 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009068{
9069 psa_status_t status;
9070 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02009071 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009072
Gilles Peskine449bd832023-01-11 14:50:10 +01009073 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009074
Gilles Peskine449bd832023-01-11 14:50:10 +01009075 if ((status = psa_hash_setup(&hash_operation,
9076 hash_alg)) != PSA_SUCCESS) {
9077 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009078 goto exit;
9079 }
9080
Gilles Peskine449bd832023-01-11 14:50:10 +01009081 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
9082 64)) != PSA_SUCCESS) {
9083 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009084 goto exit;
9085 }
9086
Gilles Peskine449bd832023-01-11 14:50:10 +01009087 if ((status = psa_hash_update(&hash_operation,
9088 data, data_len)) != PSA_SUCCESS) {
9089 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009090 goto exit;
9091 }
9092
Gilles Peskine449bd832023-01-11 14:50:10 +01009093 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
9094 hashlen)) != PSA_SUCCESS) {
9095 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
9096 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009097 }
9098
9099exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009100 if (status != PSA_SUCCESS) {
9101 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9102 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9103 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08009104 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01009105 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009106 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
9107 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01009108 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009109 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01009110 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009111 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01009112 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009113 }
9114 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009115 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009116}
9117
9118#else
9119
Gilles Peskine449bd832023-01-11 14:50:10 +01009120int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9121 unsigned char *hash, size_t *hashlen,
9122 unsigned char *data, size_t data_len,
9123 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009124{
9125 int ret = 0;
9126 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01009127 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
9128 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009129
Gilles Peskine449bd832023-01-11 14:50:10 +01009130 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009131
Gilles Peskine449bd832023-01-11 14:50:10 +01009132 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009133
9134 /*
9135 * digitally-signed struct {
9136 * opaque client_random[32];
9137 * opaque server_random[32];
9138 * ServerDHParams params;
9139 * };
9140 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009141 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
9142 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009143 goto exit;
9144 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009145 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
9146 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009147 goto exit;
9148 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009149 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
9150 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009151 goto exit;
9152 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009153 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
9154 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009155 goto exit;
9156 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009157 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
9158 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009159 goto exit;
9160 }
9161
9162exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009163 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009164
Gilles Peskine449bd832023-01-11 14:50:10 +01009165 if (ret != 0) {
9166 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9167 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9168 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08009169
Gilles Peskine449bd832023-01-11 14:50:10 +01009170 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009171}
9172#endif /* MBEDTLS_USE_PSA_CRYPTO */
9173
Jerry Yud9d91da2022-02-17 14:57:06 +08009174#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
9175
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009176/* Find the preferred hash for a given signature algorithm. */
9177unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01009178 mbedtls_ssl_context *ssl,
9179 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08009180{
Gabor Mezei078e8032022-04-27 21:17:56 +02009181 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009182 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02009183
Gilles Peskine449bd832023-01-11 14:50:10 +01009184 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
9185 return MBEDTLS_SSL_HASH_NONE;
9186 }
Gabor Mezei078e8032022-04-27 21:17:56 +02009187
Gilles Peskine449bd832023-01-11 14:50:10 +01009188 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009189 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009190 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
9191 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009192 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009193 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
9194 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009195
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009196 mbedtls_md_type_t md_alg =
9197 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
9198 if (md_alg == MBEDTLS_MD_NONE) {
9199 continue;
9200 }
9201
Gilles Peskine449bd832023-01-11 14:50:10 +01009202 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009203#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009204 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02009205 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009206 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009207
Gilles Peskine449bd832023-01-11 14:50:10 +01009208 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
9209 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9210 PSA_ALG_ECDSA(psa_hash_alg),
9211 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009212 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009213 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009214
Gilles Peskine449bd832023-01-11 14:50:10 +01009215 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
9216 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9217 PSA_ALG_RSA_PKCS1V15_SIGN(
9218 psa_hash_alg),
9219 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009220 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009221 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009222 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009223#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02009224
Gilles Peskine449bd832023-01-11 14:50:10 +01009225 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009226 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009227 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009228
Gilles Peskine449bd832023-01-11 14:50:10 +01009229 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08009230}
9231
9232#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
9233
Jerry Yudc7bd172022-02-17 13:44:15 +08009234#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9235
XiaokangQian75d40ef2022-04-20 11:05:24 +00009236int mbedtls_ssl_validate_ciphersuite(
9237 const mbedtls_ssl_context *ssl,
9238 const mbedtls_ssl_ciphersuite_t *suite_info,
9239 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009240 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009241{
9242 (void) ssl;
9243
Gilles Peskine449bd832023-01-11 14:50:10 +01009244 if (suite_info == NULL) {
9245 return -1;
9246 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009247
Gilles Peskine449bd832023-01-11 14:50:10 +01009248 if ((suite_info->min_tls_version > max_tls_version) ||
9249 (suite_info->max_tls_version < min_tls_version)) {
9250 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009251 }
9252
XiaokangQian060d8672022-04-21 09:24:56 +00009253#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009254#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009255#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009256 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9257 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009258#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009259 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9260 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009261#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009262 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009263 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009264 }
9265#endif
9266
9267 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9268#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009269 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9270 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9271 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009272 }
9273#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9274#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9275
Gilles Peskine449bd832023-01-11 14:50:10 +01009276 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009277}
9278
Ronald Crone68ab4f2022-10-05 12:46:29 +02009279#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009280/*
9281 * Function for writing a signature algorithm extension.
9282 *
9283 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9284 * value (TLS 1.3 RFC8446):
9285 * enum {
9286 * ....
9287 * ecdsa_secp256r1_sha256( 0x0403 ),
9288 * ecdsa_secp384r1_sha384( 0x0503 ),
9289 * ecdsa_secp521r1_sha512( 0x0603 ),
9290 * ....
9291 * } SignatureScheme;
9292 *
9293 * struct {
9294 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9295 * } SignatureSchemeList;
9296 *
9297 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9298 * value (TLS 1.2 RFC5246):
9299 * enum {
9300 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9301 * sha512(6), (255)
9302 * } HashAlgorithm;
9303 *
9304 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9305 * SignatureAlgorithm;
9306 *
9307 * struct {
9308 * HashAlgorithm hash;
9309 * SignatureAlgorithm signature;
9310 * } SignatureAndHashAlgorithm;
9311 *
9312 * SignatureAndHashAlgorithm
9313 * supported_signature_algorithms<2..2^16-2>;
9314 *
9315 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9316 * generalization of the TLS 1.2 signature algorithm extension.
9317 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9318 * `SignatureScheme` field of TLS 1.3
9319 *
9320 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009321int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9322 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009323{
9324 unsigned char *p = buf;
9325 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9326 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9327
9328 *out_len = 0;
9329
Gilles Peskine449bd832023-01-11 14:50:10 +01009330 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009331
9332 /* Check if we have space for header and length field:
9333 * - extension_type (2 bytes)
9334 * - extension_data_length (2 bytes)
9335 * - supported_signature_algorithms_length (2 bytes)
9336 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009337 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009338 p += 6;
9339
9340 /*
9341 * Write supported_signature_algorithms
9342 */
9343 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009344 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9345 if (sig_alg == NULL) {
9346 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9347 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009348
Gilles Peskine449bd832023-01-11 14:50:10 +01009349 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9350 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9351 *sig_alg,
9352 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9353 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009354 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009355 }
9356 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9357 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009358 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009359 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9360 *sig_alg,
9361 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009362 }
9363
9364 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009365 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009366 if (supported_sig_alg_len == 0) {
9367 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9368 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009369 }
9370
Gilles Peskine449bd832023-01-11 14:50:10 +01009371 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9372 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9373 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009374
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009375 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009376
9377#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009378 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009379#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009380
Gilles Peskine449bd832023-01-11 14:50:10 +01009381 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009382}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009383#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009384
XiaokangQian40a35232022-05-07 09:02:40 +00009385#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009386/*
9387 * mbedtls_ssl_parse_server_name_ext
9388 *
9389 * Structure of server_name extension:
9390 *
9391 * enum {
9392 * host_name(0), (255)
9393 * } NameType;
9394 * opaque HostName<1..2^16-1>;
9395 *
9396 * struct {
9397 * NameType name_type;
9398 * select (name_type) {
9399 * case host_name: HostName;
9400 * } name;
9401 * } ServerName;
9402 * struct {
9403 * ServerName server_name_list<1..2^16-1>
9404 * } ServerNameList;
9405 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009406MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009407int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9408 const unsigned char *buf,
9409 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009410{
9411 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9412 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009413 size_t server_name_list_len, hostname_len;
9414 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009415
Gilles Peskine449bd832023-01-11 14:50:10 +01009416 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009417
Gilles Peskine449bd832023-01-11 14:50:10 +01009418 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9419 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009420 p += 2;
9421
Gilles Peskine449bd832023-01-11 14:50:10 +01009422 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009423 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009424 while (p < server_name_list_end) {
9425 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9426 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9427 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9428 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009429
Gilles Peskine449bd832023-01-11 14:50:10 +01009430 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009431 /* sni_name is intended to be used only during the parsing of the
9432 * ClientHello message (it is reset to NULL before the end of
9433 * the message parsing). Thus it is ok to just point to the
9434 * reception buffer and not make a copy of it.
9435 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009436 ssl->handshake->sni_name = p + 3;
9437 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009438 if (ssl->conf->f_sni == NULL) {
9439 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009440 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009441 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9442 ssl, p + 3, hostname_len);
9443 if (ret != 0) {
9444 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9445 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9446 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9447 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9448 }
9449 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009450 }
9451
9452 p += hostname_len + 3;
9453 }
9454
Gilles Peskine449bd832023-01-11 14:50:10 +01009455 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009456}
9457#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9458
XiaokangQianacb39922022-06-17 10:18:48 +00009459#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009460MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009461int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9462 const unsigned char *buf,
9463 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009464{
9465 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009466 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009467 const unsigned char *protocol_name_list;
9468 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009469 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009470
9471 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009472 if (ssl->conf->alpn_list == NULL) {
9473 return 0;
9474 }
XiaokangQianacb39922022-06-17 10:18:48 +00009475
9476 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009477 * RFC7301, section 3.1
9478 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009479 *
XiaokangQianc7403452022-06-23 03:24:12 +00009480 * struct {
9481 * ProtocolName protocol_name_list<2..2^16-1>
9482 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009483 */
9484
XiaokangQianc7403452022-06-23 03:24:12 +00009485 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009486 * protocol_name_list_len 2 bytes
9487 * protocol_name_len 1 bytes
9488 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009489 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009490 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009491
Gilles Peskine449bd832023-01-11 14:50:10 +01009492 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009493 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009494 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009495 protocol_name_list = p;
9496 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009497
9498 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009499 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009500 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009501 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9502 protocol_name_len);
9503 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009504 MBEDTLS_SSL_PEND_FATAL_ALERT(
9505 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009506 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9507 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009508 }
9509
9510 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009511 }
9512
9513 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009514 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9515 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009516 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009517 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009518 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009519 if (protocol_name_len == alpn_len &&
9520 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009521 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009522 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009523 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009524
9525 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009526 }
9527 }
9528
XiaokangQian95d5f542022-06-24 02:29:26 +00009529 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009530 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009531 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9532 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9533 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009534}
9535
Gilles Peskine449bd832023-01-11 14:50:10 +01009536int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9537 unsigned char *buf,
9538 unsigned char *end,
9539 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009540{
9541 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009542 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009543 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009544
Gilles Peskine449bd832023-01-11 14:50:10 +01009545 if (ssl->alpn_chosen == NULL) {
9546 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009547 }
9548
Gilles Peskine449bd832023-01-11 14:50:10 +01009549 protocol_name_len = strlen(ssl->alpn_chosen);
9550 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009551
Gilles Peskine449bd832023-01-11 14:50:10 +01009552 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009553 /*
9554 * 0 . 1 ext identifier
9555 * 2 . 3 ext length
9556 * 4 . 5 protocol list length
9557 * 6 . 6 protocol name length
9558 * 7 . 7+n protocol name
9559 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009560 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009561
XiaokangQian95d5f542022-06-24 02:29:26 +00009562 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009563
Gilles Peskine449bd832023-01-11 14:50:10 +01009564 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9565 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009566 /* Note: the length of the chosen protocol has been checked to be less
9567 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9568 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009569 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009570
Gilles Peskine449bd832023-01-11 14:50:10 +01009571 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009572
9573#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009574 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009575#endif
9576
Gilles Peskine449bd832023-01-11 14:50:10 +01009577 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009578}
9579#endif /* MBEDTLS_SSL_ALPN */
9580
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009581#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009582 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009583 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009584 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009585int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9586 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009587{
9588 /* Initialize to suppress unnecessary compiler warning */
9589 size_t hostname_len = 0;
9590
9591 /* Check if new hostname is valid before
9592 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009593 if (hostname != NULL) {
9594 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009595
Gilles Peskine449bd832023-01-11 14:50:10 +01009596 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9597 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9598 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009599 }
9600
9601 /* Now it's clear that we will overwrite the old hostname,
9602 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009603 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009604 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009605 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009606 }
9607
9608 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009609 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009610 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009611 } else {
9612 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9613 if (session->hostname == NULL) {
9614 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9615 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009616
Gilles Peskine449bd832023-01-11 14:50:10 +01009617 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009618 }
9619
Gilles Peskine449bd832023-01-11 14:50:10 +01009620 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009621}
Xiaokang Qian03409292022-10-12 02:49:52 +00009622#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9623 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009624 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009625 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009626
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009627#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
9628 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009629int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
9630 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009631{
9632 size_t alpn_len = 0;
9633
9634 if (alpn != NULL) {
9635 alpn_len = strlen(alpn);
9636
9637 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
9638 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9639 }
9640 }
9641
9642 if (session->ticket_alpn != NULL) {
9643 mbedtls_zeroize_and_free(session->ticket_alpn,
9644 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009645 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009646 }
9647
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009648 if (alpn != NULL) {
9649 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009650 if (session->ticket_alpn == NULL) {
9651 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9652 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009653 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009654 }
9655
9656 return 0;
9657}
9658#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02009659
9660/*
9661 * The following functions are used by 1.2 and 1.3, client and server.
9662 */
9663#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
9664int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
9665 const mbedtls_ssl_ciphersuite_t *ciphersuite,
9666 int recv_endpoint,
9667 mbedtls_ssl_protocol_version tls_version,
9668 uint32_t *flags)
9669{
9670 int ret = 0;
9671 unsigned int usage = 0;
9672 const char *ext_oid;
9673 size_t ext_len;
9674
9675 /*
9676 * keyUsage
9677 */
9678
9679 /* Note: don't guard this with MBEDTLS_SSL_CLI_C because the server wants
9680 * to check what a compliant client will think while choosing which cert
9681 * to send to the client. */
9682#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
9683 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
9684 recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
9685 /* TLS 1.2 server part of the key exchange */
9686 switch (ciphersuite->key_exchange) {
9687 case MBEDTLS_KEY_EXCHANGE_RSA:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02009688 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
9689 break;
9690
9691 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
9692 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
9693 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
9694 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
9695 break;
9696
9697 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
9698 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
9699 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
9700 break;
9701
9702 /* Don't use default: we want warnings when adding new values */
9703 case MBEDTLS_KEY_EXCHANGE_NONE:
9704 case MBEDTLS_KEY_EXCHANGE_PSK:
9705 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
9706 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
9707 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
9708 usage = 0;
9709 }
9710 } else
9711#endif
9712 {
9713 /* This is either TLS 1.3 authentication, which always uses signatures,
9714 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
9715 * options we implement, both using signatures. */
9716 (void) tls_version;
9717 (void) ciphersuite;
9718 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
9719 }
9720
9721 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
9722 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
9723 ret = -1;
9724 }
9725
9726 /*
9727 * extKeyUsage
9728 */
9729
9730 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
9731 ext_oid = MBEDTLS_OID_SERVER_AUTH;
9732 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
9733 } else {
9734 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
9735 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
9736 }
9737
9738 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
9739 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
9740 ret = -1;
9741 }
9742
9743 return ret;
9744}
9745
9746int mbedtls_ssl_verify_certificate(mbedtls_ssl_context *ssl,
9747 int authmode,
9748 mbedtls_x509_crt *chain,
9749 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
9750 void *rs_ctx)
9751{
9752 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
9753 return 0;
9754 }
9755
9756 /*
9757 * Primary check: use the appropriate X.509 verification function
9758 */
9759 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
9760 void *p_vrfy;
9761 if (ssl->f_vrfy != NULL) {
9762 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
9763 f_vrfy = ssl->f_vrfy;
9764 p_vrfy = ssl->p_vrfy;
9765 } else {
9766 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
9767 f_vrfy = ssl->conf->f_vrfy;
9768 p_vrfy = ssl->conf->p_vrfy;
9769 }
9770
9771 int ret = 0;
9772 int have_ca_chain_or_callback = 0;
9773#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
9774 if (ssl->conf->f_ca_cb != NULL) {
9775 ((void) rs_ctx);
9776 have_ca_chain_or_callback = 1;
9777
9778 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
9779 ret = mbedtls_x509_crt_verify_with_ca_cb(
9780 chain,
9781 ssl->conf->f_ca_cb,
9782 ssl->conf->p_ca_cb,
9783 ssl->conf->cert_profile,
9784 ssl->hostname,
9785 &ssl->session_negotiate->verify_result,
9786 f_vrfy, p_vrfy);
9787 } else
9788#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
9789 {
9790 mbedtls_x509_crt *ca_chain;
9791 mbedtls_x509_crl *ca_crl;
9792#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
9793 if (ssl->handshake->sni_ca_chain != NULL) {
9794 ca_chain = ssl->handshake->sni_ca_chain;
9795 ca_crl = ssl->handshake->sni_ca_crl;
9796 } else
9797#endif
9798 {
9799 ca_chain = ssl->conf->ca_chain;
9800 ca_crl = ssl->conf->ca_crl;
9801 }
9802
9803 if (ca_chain != NULL) {
9804 have_ca_chain_or_callback = 1;
9805 }
9806
9807 ret = mbedtls_x509_crt_verify_restartable(
9808 chain,
9809 ca_chain, ca_crl,
9810 ssl->conf->cert_profile,
9811 ssl->hostname,
9812 &ssl->session_negotiate->verify_result,
9813 f_vrfy, p_vrfy, rs_ctx);
9814 }
9815
9816 if (ret != 0) {
9817 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
9818 }
9819
9820#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
9821 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
9822 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
9823 }
9824#endif
9825
9826 /*
9827 * Secondary checks: always done, but change 'ret' only if it was 0
9828 */
9829
9830 /* With TLS 1.2 and ECC certs, check that the curve used by the
9831 * certificate is on our list of acceptable curves.
9832 *
9833 * With TLS 1.3 this is not needed because the curve is part of the
9834 * signature algorithm (eg ecdsa_secp256r1_sha256) which is checked when
9835 * we validate the signature made with the key associated to this cert.
9836 */
9837#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
9838 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
9839 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
9840 mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY)) {
9841 if (mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
9842 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
9843 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
9844 if (ret == 0) {
9845 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
9846 }
9847 }
9848 }
9849#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
9850
9851 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
9852 if (mbedtls_ssl_check_cert_usage(chain,
9853 ciphersuite_info,
9854 ssl->conf->endpoint,
9855 ssl->tls_version,
9856 &ssl->session_negotiate->verify_result) != 0) {
9857 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
9858 if (ret == 0) {
9859 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
9860 }
9861 }
9862
9863 /* With authmode optional, we want to keep going if the certificate was
9864 * unacceptable, but still fail on other errors (out of memory etc),
9865 * including fatal errors from the f_vrfy callback.
9866 *
9867 * The only acceptable errors are:
9868 * - MBEDTLS_ERR_X509_CERT_VERIFY_FAILED: cert rejected by primary check;
9869 * - MBEDTLS_ERR_SSL_BAD_CERTIFICATE: cert rejected by secondary checks.
9870 * Anything else is a fatal error. */
9871 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
9872 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
9873 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
9874 ret = 0;
9875 }
9876
9877 /* Return a specific error as this is a user error: inconsistent
9878 * configuration - can't verify without trust anchors. */
9879 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
9880 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
9881 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
9882 }
9883
9884 if (ret != 0) {
9885 uint8_t alert;
9886
9887 /* The certificate may have been rejected for several reasons.
9888 Pick one and send the corresponding alert. Which alert to send
9889 may be a subject of debate in some cases. */
9890 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
9891 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
9892 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
9893 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
9894 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
9895 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9896 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
9897 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9898 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
9899 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9900 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
9901 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9902 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
9903 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
9904 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
9905 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
9906 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
9907 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
9908 } else {
9909 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
9910 }
9911 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9912 alert);
9913 }
9914
9915#if defined(MBEDTLS_DEBUG_C)
9916 if (ssl->session_negotiate->verify_result != 0) {
9917 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
9918 (unsigned int) ssl->session_negotiate->verify_result));
9919 } else {
9920 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
9921 }
9922#endif /* MBEDTLS_DEBUG_C */
9923
9924 return ret;
9925}
9926#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
9927
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009928#endif /* MBEDTLS_SSL_TLS_C */