blob: 39c7a2e3cb6d9a569d985bf051ba24514a01dceb [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;
346 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
347 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100348 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200349 written_in = ssl->in_msg - ssl->in_buf;
350 iv_offset_in = ssl->in_iv - ssl->in_buf;
351 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100352 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200353 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 ssl->in_buf_len < in_buf_new_len) {
355 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
356 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
357 } else {
358 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
359 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200360 modified = 1;
361 }
362 }
363 }
364
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200366 written_out = ssl->out_msg - ssl->out_buf;
367 iv_offset_out = ssl->out_iv - ssl->out_buf;
368 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100369 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200370 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100371 ssl->out_buf_len < out_buf_new_len) {
372 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
373 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
374 } else {
375 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
376 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200377 modified = 1;
378 }
379 }
380 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100381 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200382 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100383 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200384 /* Fields below might not be properly updated with record
385 * splitting or with CID, so they are manually updated here. */
386 ssl->out_msg = ssl->out_buf + written_out;
387 ssl->out_len = ssl->out_buf + len_offset_out;
388 ssl->out_iv = ssl->out_buf + iv_offset_out;
389
390 ssl->in_msg = ssl->in_buf + written_in;
391 ssl->in_len = ssl->in_buf + len_offset_in;
392 ssl->in_iv = ssl->in_buf + iv_offset_in;
393 }
394}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500395#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
396
Jerry Yudb8c48a2022-01-27 14:54:54 +0800397#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800398
399#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100400typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
401 const char *label,
402 const unsigned char *random, size_t rlen,
403 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800404
Gilles Peskine449bd832023-01-11 14:50:10 +0100405static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800406
407#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
408
409/* Type for the TLS PRF */
410typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
411 const unsigned char *, size_t,
412 unsigned char *, size_t);
413
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200414MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100415static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
416 int ciphersuite,
417 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200418#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100419 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200420#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100421 ssl_tls_prf_t tls_prf,
422 const unsigned char randbytes[64],
423 mbedtls_ssl_protocol_version tls_version,
424 unsigned endpoint,
425 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800426
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100427#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200428MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100429static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300430 const char *label,
431 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100432 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100433static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
434static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100435
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100436#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100437
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100438#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100439MBEDTLS_CHECK_RETURN_CRITICAL
440static int tls_prf_sha384(const unsigned char *secret, size_t slen,
441 const char *label,
442 const unsigned char *random, size_t rlen,
443 unsigned char *dstbuf, size_t dlen);
444
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100445static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
446static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100447#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100448
Gilles Peskine449bd832023-01-11 14:50:10 +0100449MBEDTLS_CHECK_RETURN_CRITICAL
450static int ssl_tls12_session_load(mbedtls_ssl_session *session,
451 const unsigned char *buf,
452 size_t len);
453#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
454
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100455static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100456
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100457#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100458static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100459#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100460
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100461#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100462static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100463#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100464
465int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
466 const unsigned char *secret, size_t slen,
467 const char *label,
468 const unsigned char *random, size_t rlen,
469 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300470{
471 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
472
Gilles Peskine449bd832023-01-11 14:50:10 +0100473 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300474#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100475#if defined(PSA_WANT_ALG_SHA_384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300476 case MBEDTLS_SSL_TLS_PRF_SHA384:
477 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100478 break;
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100479#endif /* PSA_WANT_ALG_SHA_384*/
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100480#if defined(PSA_WANT_ALG_SHA_256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300481 case MBEDTLS_SSL_TLS_PRF_SHA256:
482 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 break;
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100484#endif /* PSA_WANT_ALG_SHA_256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300485#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100486 default:
487 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300488 }
489
Gilles Peskine449bd832023-01-11 14:50:10 +0100490 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300491}
492
Jerry Yuc73c6182022-02-08 20:29:25 +0800493#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100494static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800495{
496#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100497 if (session->peer_cert != NULL) {
498 mbedtls_x509_crt_free(session->peer_cert);
499 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800500 session->peer_cert = NULL;
501 }
502#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100503 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800504 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100505 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800506 session->peer_cert_digest = NULL;
507 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
508 session->peer_cert_digest_len = 0;
509 }
510#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
511}
512#endif /* MBEDTLS_X509_CRT_PARSE_C */
513
Gilles Peskine449bd832023-01-11 14:50:10 +0100514uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800515{
Gilles Peskine449bd832023-01-11 14:50:10 +0100516 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800517 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100518 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800519
520 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100521 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800522
523 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100524 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800525
526 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100527 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800528
529 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100530 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800531
532 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100533 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800534
535 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100536 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800537
538 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100539 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800540
541 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100542 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800543
544 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100545 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800546
547 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100548 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800549
550 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100551 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800552
553 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100554 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800555
556 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100557 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800558
559 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100560 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800561
562 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100563 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800564
565 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100566 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800567
568 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100569 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800570
571 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100572 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800573
574 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100575 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800576
577 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100578 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800579
580 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100581 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800582
583 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100584 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800585
586 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100587 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800588
589 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100590 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800591
592 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100593 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800594
Jan Bruckner151f6422023-02-10 12:45:19 +0100595 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
596 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
597
Jerry Yu7a485c12022-10-31 13:08:18 +0800598 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100599 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800600
601 }
602
Gilles Peskine449bd832023-01-11 14:50:10 +0100603 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800604}
605
Gilles Peskine449bd832023-01-11 14:50:10 +0100606uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800607{
Gilles Peskine449bd832023-01-11 14:50:10 +0100608 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800609}
610
Jerry Yud25cab02022-10-31 12:48:30 +0800611#if defined(MBEDTLS_DEBUG_C)
612static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800613 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800614 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
615 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
616 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
617 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
618 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
619 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
620 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
621 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
622 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
623 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
624 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
625 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
626 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
627 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
628 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
629 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
630 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
631 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
632 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
633 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
634 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
635 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
636 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
637 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
638 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
639 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100640 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
641 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800642};
643
Chien Wong4e9683e2023-12-28 17:07:43 +0800644static const unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800645 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
646 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
647 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
648 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
649 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
650 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
651 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
652 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
653 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
654 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
655 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
656 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
657 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
658 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
659 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
660 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
661 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
662 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
663 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
664 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
665 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
666 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
667 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
668 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
669 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
670 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
671 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100672 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
673 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800674};
675
Gilles Peskine449bd832023-01-11 14:50:10 +0100676const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800677{
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 return extension_name_table[
679 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800680}
681
Gilles Peskine449bd832023-01-11 14:50:10 +0100682static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800683{
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800685 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800687 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100688 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800689 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100690 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800691 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800693 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100694 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800695 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800697 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100698 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800699 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100700 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800701}
702
Gilles Peskine449bd832023-01-11 14:50:10 +0100703void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
704 int level, const char *file, int line,
705 int hs_msg_type, unsigned int extension_type,
706 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800707{
708 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100709 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800710 mbedtls_debug_print_msg(
711 ssl, level, file, line,
712 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 ssl_tls13_get_hs_msg_name(hs_msg_type),
714 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800715 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100716 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800717 return;
718 }
719
720 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100721 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800722 mbedtls_debug_print_msg(
723 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100724 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
725 mbedtls_ssl_get_extension_name(extension_type), extension_type,
726 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800727 return;
728 }
729
730 mbedtls_debug_print_msg(
731 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100732 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
733 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800734}
735
Gilles Peskine449bd832023-01-11 14:50:10 +0100736void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
737 int level, const char *file, int line,
738 int hs_msg_type, uint32_t extensions_mask,
739 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800740{
741
Gilles Peskine449bd832023-01-11 14:50:10 +0100742 for (unsigned i = 0;
743 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
744 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800745 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800746 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100747 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800748 }
749}
750
Pengyu Lvee455c02023-01-12 14:37:24 +0800751#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800752static const char *ticket_flag_name_table[] =
753{
754 [0] = "ALLOW_PSK_RESUMPTION",
755 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
756 [3] = "ALLOW_EARLY_DATA",
757};
758
Pengyu Lv4938a562023-01-16 11:28:49 +0800759void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
760 int level, const char *file, int line,
761 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800762{
763 size_t i;
764
765 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800766 "print ticket_flags (0x%02x)", flags);
767
768 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800769
770 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800771 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800772 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
773 ticket_flag_name_table[i]);
774 }
775 }
776}
777#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
778
Jerry Yud25cab02022-10-31 12:48:30 +0800779#endif /* MBEDTLS_DEBUG_C */
780
Gilles Peskine449bd832023-01-11 14:50:10 +0100781void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
782 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800783{
784 ((void) ciphersuite_info);
785
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100786#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800788 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100789 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800790#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100791#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100792 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800793 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100794 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800795#endif
796 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100797 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800798 return;
799 }
800}
801
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100802int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100803 unsigned hs_type,
804 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100805{
806 unsigned char hs_hdr[4];
807
808 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100809 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
810 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
811 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
812 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100813
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100814 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100815}
816
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100817int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100818 unsigned hs_type,
819 unsigned char const *msg,
820 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100821{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100822 int ret;
823 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100824 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100825 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100826 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100827 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100828}
829
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100830int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800831{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100832#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100833 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100834#if defined(MBEDTLS_USE_PSA_CRYPTO)
835 psa_status_t status;
836#else
837 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
838#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100839#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800840 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100841#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100842#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800843#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100844 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
845 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200846 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100847 }
848 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
849 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200850 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100851 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800852#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100853 mbedtls_md_free(&ssl->handshake->fin_sha256);
854 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100855 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
856 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
857 0);
858 if (ret != 0) {
859 return ret;
860 }
861 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100862 if (ret != 0) {
863 return ret;
864 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800865#endif
866#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100867#if defined(PSA_WANT_ALG_SHA_384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800868#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100869 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
870 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200871 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100872 }
873 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
874 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200875 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100876 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800877#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100878 mbedtls_md_free(&ssl->handshake->fin_sha384);
879 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100880 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
881 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
882 if (ret != 0) {
883 return ret;
884 }
885 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100886 if (ret != 0) {
887 return ret;
888 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800889#endif
890#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100891 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800892}
893
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100894static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100895 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800896{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100897#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100898 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100899#if defined(MBEDTLS_USE_PSA_CRYPTO)
900 psa_status_t status;
901#else
902 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
903#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100904#else /* SHA-256 or SHA-384 */
905 ((void) ssl);
906 (void) buf;
907 (void) len;
908#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100909#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800910#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100911 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
912 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200913 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100914 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800915#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100916 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100917 if (ret != 0) {
918 return ret;
919 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800920#endif
921#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100922#if defined(PSA_WANT_ALG_SHA_384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800923#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100924 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
925 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200926 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100927 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800928#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100929 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100930 if (ret != 0) {
931 return ret;
932 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800933#endif
934#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100935 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800936}
937
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100938#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100939static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100940 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800941{
942#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200943 return mbedtls_md_error_from_psa(psa_hash_update(
944 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800945#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100946 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800947#endif
948}
949#endif
950
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100951#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100952static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100953 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800954{
955#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200956 return mbedtls_md_error_from_psa(psa_hash_update(
957 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800958#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100959 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800960#endif
961}
962#endif
963
Gilles Peskine449bd832023-01-11 14:50:10 +0100964static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200965{
Gilles Peskine449bd832023-01-11 14:50:10 +0100966 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200967
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100968#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500969#if defined(MBEDTLS_USE_PSA_CRYPTO)
970 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500971#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100972 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200973#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500974#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100975#if defined(PSA_WANT_ALG_SHA_384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500976#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500977 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500978#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100979 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200980#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500981#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200982
983 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100984
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200985#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100986 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200987#endif
Valerio Setti7aeec542023-07-05 18:57:21 +0200988#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +0200989 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200991#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200992#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200993#if defined(MBEDTLS_USE_PSA_CRYPTO)
994 handshake->psa_pake_ctx = psa_pake_operation_init();
995 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
996#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100997 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200998#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200999#if defined(MBEDTLS_SSL_CLI_C)
1000 handshake->ecjpake_cache = NULL;
1001 handshake->ecjpake_cache_len = 0;
1002#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02001003#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001004
Gilles Peskineeccd8882020-03-10 12:19:08 +01001005#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001006 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02001007#endif
1008
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001009#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1010 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1011#endif
Hanno Becker75173122019-02-06 16:18:31 +00001012
1013#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1014 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001015 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001016#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001017}
1018
Gilles Peskine449bd832023-01-11 14:50:10 +01001019void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001020{
Gilles Peskine449bd832023-01-11 14:50:10 +01001021 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001022
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001023#if defined(MBEDTLS_USE_PSA_CRYPTO)
1024 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1025 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001026#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001027 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1028 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001029#endif
1030
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001031#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001032#if defined(MBEDTLS_USE_PSA_CRYPTO)
1033 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1034 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001035#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001036 mbedtls_md_init(&transform->md_ctx_enc);
1037 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001038#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001039#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001040}
1041
Gilles Peskine449bd832023-01-11 14:50:10 +01001042void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001043{
Gilles Peskine449bd832023-01-11 14:50:10 +01001044 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001045}
1046
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001047MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001048static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001049{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001050 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1051
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001052 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001053#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001054 if (ssl->transform_negotiate) {
1055 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1056 }
Jerry Yu2e199812022-12-01 18:57:19 +08001057#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 if (ssl->session_negotiate) {
1059 mbedtls_ssl_session_free(ssl->session_negotiate);
1060 }
1061 if (ssl->handshake) {
1062 mbedtls_ssl_handshake_free(ssl);
1063 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001064
Jerry Yu2e199812022-12-01 18:57:19 +08001065#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001066 /*
1067 * Either the pointers are now NULL or cleared properly and can be freed.
1068 * Now allocate missing structures.
1069 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001070 if (ssl->transform_negotiate == NULL) {
1071 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001072 }
Jerry Yu2e199812022-12-01 18:57:19 +08001073#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001074
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 if (ssl->session_negotiate == NULL) {
1076 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001077 }
Paul Bakker48916f92012-09-16 19:57:18 +00001078
Gilles Peskine449bd832023-01-11 14:50:10 +01001079 if (ssl->handshake == NULL) {
1080 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001081 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001082#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1083 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001084
Gilles Peskine449bd832023-01-11 14:50:10 +01001085 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1086 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001087#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001088
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001089 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001091#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001092 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001093#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 ssl->session_negotiate == NULL) {
1095 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001096
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001098 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001099
1100#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001102 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001103#endif
1104
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001106 ssl->session_negotiate = NULL;
1107
Gilles Peskine449bd832023-01-11 14:50:10 +01001108 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001109 }
1110
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001111#if defined(MBEDTLS_SSL_EARLY_DATA)
1112#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001113 ssl->early_data_state = MBEDTLS_SSL_EARLY_DATA_STATE_IDLE;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001114#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001115#if defined(MBEDTLS_SSL_SRV_C)
1116 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1117#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001118 ssl->total_early_data_size = 0;
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001119#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001120
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001121 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001122 mbedtls_ssl_session_init(ssl->session_negotiate);
1123 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001124
Jerry Yu2e199812022-12-01 18:57:19 +08001125#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001127#endif
1128
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001129 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001130 ret = mbedtls_ssl_reset_checksum(ssl);
1131 if (ret != 0) {
1132 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1133 return ret;
1134 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001135
Jerry Yud0766ec2022-09-22 10:46:57 +08001136#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1137 defined(MBEDTLS_SSL_SRV_C) && \
1138 defined(MBEDTLS_SSL_SESSION_TICKETS)
1139 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001140 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001141#endif
1142
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001143#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001144 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001145 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001146
Gilles Peskine449bd832023-01-11 14:50:10 +01001147 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001148 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001149 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001150 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001152
Gilles Peskine449bd832023-01-11 14:50:10 +01001153 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001154 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001155#endif
1156
Brett Warrene0edc842021-08-17 09:53:13 +01001157/*
1158 * curve_list is translated to IANA TLS group identifiers here because
1159 * mbedtls_ssl_conf_curves returns void and so can't return
1160 * any error codes.
1161 */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001162#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001163#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1164 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001165 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001166 size_t length;
1167 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1168
Thomas Daubney850a0792023-05-22 12:05:03 +01001169 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 }
Brett Warrene0edc842021-08-17 09:53:13 +01001171
1172 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001173 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1174 if (group_list == NULL) {
1175 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1176 }
Brett Warrene0edc842021-08-17 09:53:13 +01001177
Gilles Peskine449bd832023-01-11 14:50:10 +01001178 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001179 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001180 curve_list[i]);
1181 if (tls_id == 0) {
1182 mbedtls_free(group_list);
1183 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001184 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001185 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001186 }
1187
1188 group_list[length] = 0;
1189
1190 ssl->handshake->group_list = group_list;
1191 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001192 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001193 ssl->handshake->group_list = ssl->conf->group_list;
1194 ssl->handshake->group_list_heap_allocated = 0;
1195 }
1196#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001197#endif /* MBEDTLS_ECP_C */
Brett Warrene0edc842021-08-17 09:53:13 +01001198
Ronald Crone68ab4f2022-10-05 12:46:29 +02001199#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001200#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001201#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001202 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1203 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001204 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1205 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001206 const int *md;
1207 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001208 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001209 uint16_t *p;
1210
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001211 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1212 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1213 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001214
Gilles Peskine449bd832023-01-11 14:50:10 +01001215 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1216 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001217 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001218 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001219#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001221#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001222
Jerry Yub476a442022-01-21 18:14:45 +08001223#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001224 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001225#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1227 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1228 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001229 }
1230
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1232 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1233 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001234
Gilles Peskine449bd832023-01-11 14:50:10 +01001235 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1236 sizeof(uint16_t));
1237 if (ssl->handshake->sig_algs == NULL) {
1238 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1239 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001240
Gilles Peskine449bd832023-01-11 14:50:10 +01001241 p = (uint16_t *) ssl->handshake->sig_algs;
1242 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1243 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1244 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001245 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001246 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001247#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001249 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001250#endif
1251#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001252 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001253 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001254#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001255 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001256 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001257 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001258 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001259#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001260 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001261 ssl->handshake->sig_algs_heap_allocated = 0;
1262 }
Jerry Yucc539102022-06-27 16:27:35 +08001263#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001264#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001265 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001266}
1267
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001268#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001269/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001270MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001271static int ssl_cookie_write_dummy(void *ctx,
1272 unsigned char **p, unsigned char *end,
1273 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001274{
1275 ((void) ctx);
1276 ((void) p);
1277 ((void) end);
1278 ((void) cli_id);
1279 ((void) cli_id_len);
1280
Gilles Peskine449bd832023-01-11 14:50:10 +01001281 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001282}
1283
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001284MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001285static int ssl_cookie_check_dummy(void *ctx,
1286 const unsigned char *cookie, size_t cookie_len,
1287 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001288{
1289 ((void) ctx);
1290 ((void) cookie);
1291 ((void) cookie_len);
1292 ((void) cli_id);
1293 ((void) cli_id_len);
1294
Gilles Peskine449bd832023-01-11 14:50:10 +01001295 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001296}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001297#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001298
Paul Bakker5121ce52009-01-03 21:22:43 +00001299/*
1300 * Initialize an SSL context
1301 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001302void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001303{
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001305}
1306
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001307MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001308static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001309{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001310 const mbedtls_ssl_config *conf = ssl->conf;
1311
Ronald Cron6f135e12021-12-08 16:57:54 +01001312#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001313 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1314 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1315 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1316 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001317 }
1318
Gilles Peskine449bd832023-01-11 14:50:10 +01001319 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1320 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001321 }
1322#endif
1323
1324#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001325 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1326 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1327 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001328 }
1329#endif
1330
Ronald Cron6f135e12021-12-08 16:57:54 +01001331#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001332 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1333 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1334 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1335 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001336 }
1337
Gilles Peskine449bd832023-01-11 14:50:10 +01001338 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1339 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001340 }
1341#endif
1342
Gilles Peskine449bd832023-01-11 14:50:10 +01001343 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1344 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001345}
1346
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001347MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001348static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1349{
1350 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001351 ret = ssl_conf_version_check(ssl);
1352 if (ret != 0) {
1353 return ret;
1354 }
Jerry Yu60835a82021-08-04 10:13:52 +08001355
Yanray Wangb422cab2023-12-01 16:18:10 +08001356 if (ssl->conf->f_rng == NULL) {
1357 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1358 return MBEDTLS_ERR_SSL_NO_RNG;
1359 }
1360
Jerry Yu60835a82021-08-04 10:13:52 +08001361 /* Space for further checks */
1362
Gilles Peskine449bd832023-01-11 14:50:10 +01001363 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001364}
1365
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001366/*
1367 * Setup an SSL context
1368 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001369
Gilles Peskine449bd832023-01-11 14:50:10 +01001370int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1371 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001372{
Janos Follath865b3eb2019-12-16 11:46:15 +00001373 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001374 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1375 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001376
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001377 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001378
Gilles Peskine449bd832023-01-11 14:50:10 +01001379 if ((ret = ssl_conf_check(ssl)) != 0) {
1380 return ret;
1381 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001382 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001383
Paul Bakker62f2dee2012-09-28 07:31:51 +00001384 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001385 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001386 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001387
1388 /* Set to NULL in case of an error condition */
1389 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001390
Darryl Greenb33cc762019-11-28 14:29:44 +00001391#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1392 ssl->in_buf_len = in_buf_len;
1393#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001394 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1395 if (ssl->in_buf == NULL) {
1396 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001397 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001398 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001399 }
1400
Darryl Greenb33cc762019-11-28 14:29:44 +00001401#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1402 ssl->out_buf_len = out_buf_len;
1403#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001404 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1405 if (ssl->out_buf == NULL) {
1406 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001407 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001408 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001409 }
1410
Gilles Peskine449bd832023-01-11 14:50:10 +01001411 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001412
Johan Pascalb62bb512015-12-03 21:56:45 +01001413#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001415#endif
1416
Gilles Peskine449bd832023-01-11 14:50:10 +01001417 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001418 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001420
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001422
1423error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 mbedtls_free(ssl->in_buf);
1425 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001426
1427 ssl->conf = NULL;
1428
Darryl Greenb33cc762019-11-28 14:29:44 +00001429#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1430 ssl->in_buf_len = 0;
1431 ssl->out_buf_len = 0;
1432#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001433 ssl->in_buf = NULL;
1434 ssl->out_buf = NULL;
1435
1436 ssl->in_hdr = NULL;
1437 ssl->in_ctr = NULL;
1438 ssl->in_len = NULL;
1439 ssl->in_iv = NULL;
1440 ssl->in_msg = NULL;
1441
1442 ssl->out_hdr = NULL;
1443 ssl->out_ctr = NULL;
1444 ssl->out_len = NULL;
1445 ssl->out_iv = NULL;
1446 ssl->out_msg = NULL;
1447
Gilles Peskine449bd832023-01-11 14:50:10 +01001448 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001449}
1450
1451/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001452 * Reset an initialized and used SSL context for re-use while retaining
1453 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001454 *
1455 * If partial is non-zero, keep data in the input buffer and client ID.
1456 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001457 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001458void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1459 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001460{
Darryl Greenb33cc762019-11-28 14:29:44 +00001461#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1462 size_t in_buf_len = ssl->in_buf_len;
1463 size_t out_buf_len = ssl->out_buf_len;
1464#else
1465 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1466 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1467#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001468
Hanno Beckerb0302c42021-08-03 09:39:42 +01001469#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1470 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001471#endif
1472
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001473 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001474 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001475
Gilles Peskine449bd832023-01-11 14:50:10 +01001476 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001477
1478 /* Reset incoming message parsing */
1479 ssl->in_offt = NULL;
1480 ssl->nb_zero = 0;
1481 ssl->in_msgtype = 0;
1482 ssl->in_msglen = 0;
1483 ssl->in_hslen = 0;
1484 ssl->keep_current_message = 0;
1485 ssl->transform_in = NULL;
1486
1487#if defined(MBEDTLS_SSL_PROTO_DTLS)
1488 ssl->next_record_offset = 0;
1489 ssl->in_epoch = 0;
1490#endif
1491
1492 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001493 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001494 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001495 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001496 }
1497
Ronald Cronad8c17b2022-06-10 17:18:09 +02001498 ssl->send_alert = 0;
1499
Hanno Beckerb0302c42021-08-03 09:39:42 +01001500 /* Reset outgoing message writing */
1501 ssl->out_msgtype = 0;
1502 ssl->out_msglen = 0;
1503 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001504 memset(ssl->out_buf, 0, out_buf_len);
1505 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001506 ssl->transform_out = NULL;
1507
1508#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001509 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001510#endif
1511
XiaokangQian2b01dc32022-01-21 02:53:13 +00001512#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001513 if (ssl->transform) {
1514 mbedtls_ssl_transform_free(ssl->transform);
1515 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001516 ssl->transform = NULL;
1517 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001518#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1519
XiaokangQian2b01dc32022-01-21 02:53:13 +00001520#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001521 mbedtls_ssl_transform_free(ssl->transform_application);
1522 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001523 ssl->transform_application = NULL;
1524
Gilles Peskine449bd832023-01-11 14:50:10 +01001525 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001526#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001527 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1528 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001529 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001530#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001531
Gilles Peskine449bd832023-01-11 14:50:10 +01001532 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1533 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001534 ssl->handshake->transform_handshake = NULL;
1535 }
1536
XiaokangQian2b01dc32022-01-21 02:53:13 +00001537#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001538}
1539
Gilles Peskine449bd832023-01-11 14:50:10 +01001540int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001541{
1542 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1543
1544 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001545 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001546
Gilles Peskine449bd832023-01-11 14:50:10 +01001547 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001548
1549 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001550#if defined(MBEDTLS_SSL_RENEGOTIATION)
1551 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001552 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001553
1554 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1556 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001557#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001558 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001559
Hanno Beckerb0302c42021-08-03 09:39:42 +01001560 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001561 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001562 if (ssl->session) {
1563 mbedtls_ssl_session_free(ssl->session);
1564 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001565 ssl->session = NULL;
1566 }
1567
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001568#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001569 ssl->alpn_chosen = NULL;
1570#endif
1571
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001572#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001573 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001574#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001575 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001576#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001577 if (free_cli_id) {
1578 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001579 ssl->cli_id = NULL;
1580 ssl->cli_id_len = 0;
1581 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001582#endif
1583
Gilles Peskine449bd832023-01-11 14:50:10 +01001584 if ((ret = ssl_handshake_init(ssl)) != 0) {
1585 return ret;
1586 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001587
Gilles Peskine449bd832023-01-11 14:50:10 +01001588 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001589}
1590
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001591/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001592 * Reset an initialized and used SSL context for re-use while retaining
1593 * all application-set variables, function pointers and data.
1594 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001595int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001596{
Gilles Peskine449bd832023-01-11 14:50:10 +01001597 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001598}
1599
1600/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001601 * SSL set accessors
1602 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001603void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001604{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001605 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001606}
1607
Gilles Peskine449bd832023-01-11 14:50:10 +01001608void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001609{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001610 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001611}
1612
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001613#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001614void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001615{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001616 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001617}
1618#endif
1619
Gilles Peskine449bd832023-01-11 14:50:10 +01001620void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001621{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001622 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001623}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001624
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001625#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001626
Gilles Peskine449bd832023-01-11 14:50:10 +01001627void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1628 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001629{
1630 ssl->disable_datagram_packing = !allow_packing;
1631}
1632
Gilles Peskine449bd832023-01-11 14:50:10 +01001633void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1634 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001635{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001636 conf->hs_timeout_min = min;
1637 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001638}
1639#endif
1640
Gilles Peskine449bd832023-01-11 14:50:10 +01001641void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001642{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001643 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001644}
1645
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001646#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001647void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1648 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1649 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001650{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001651 conf->f_vrfy = f_vrfy;
1652 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001653}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001654#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001655
Gilles Peskine449bd832023-01-11 14:50:10 +01001656void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1657 int (*f_rng)(void *, unsigned char *, size_t),
1658 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001659{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001660 conf->f_rng = f_rng;
1661 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001662}
1663
Gilles Peskine449bd832023-01-11 14:50:10 +01001664void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1665 void (*f_dbg)(void *, int, const char *, int, const char *),
1666 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001667{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001668 conf->f_dbg = f_dbg;
1669 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001670}
1671
Gilles Peskine449bd832023-01-11 14:50:10 +01001672void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1673 void *p_bio,
1674 mbedtls_ssl_send_t *f_send,
1675 mbedtls_ssl_recv_t *f_recv,
1676 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001677{
1678 ssl->p_bio = p_bio;
1679 ssl->f_send = f_send;
1680 ssl->f_recv = f_recv;
1681 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001682}
1683
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001684#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001685void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001686{
1687 ssl->mtu = mtu;
1688}
1689#endif
1690
Gilles Peskine449bd832023-01-11 14:50:10 +01001691void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001692{
1693 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001694}
1695
Gilles Peskine449bd832023-01-11 14:50:10 +01001696void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1697 void *p_timer,
1698 mbedtls_ssl_set_timer_t *f_set_timer,
1699 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001700{
1701 ssl->p_timer = p_timer;
1702 ssl->f_set_timer = f_set_timer;
1703 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001704
1705 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001706 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001707}
1708
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001709#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001710void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1711 void *p_cache,
1712 mbedtls_ssl_cache_get_t *f_get_cache,
1713 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001714{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001715 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001716 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001717 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001718}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001719#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001720
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001721#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001722int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001723{
Janos Follath865b3eb2019-12-16 11:46:15 +00001724 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001725
Gilles Peskine449bd832023-01-11 14:50:10 +01001726 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001727 session == NULL ||
1728 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1730 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001731 }
1732
Gilles Peskine449bd832023-01-11 14:50:10 +01001733 if (ssl->handshake->resume == 1) {
1734 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1735 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001736
Jerry Yu21092062022-10-10 21:21:31 +08001737#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron233fcaa2024-04-04 14:05:21 +02001739#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001740 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001742
Gilles Peskine449bd832023-01-11 14:50:10 +01001743 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001744 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001745 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1746 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1747 session->ciphersuite));
1748 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001749 }
Ronald Cron233fcaa2024-04-04 14:05:21 +02001750#else
1751 /*
1752 * If session tickets are not enabled, it is not possible to resume a
1753 * TLS 1.3 session, thus do not make any change to the SSL context in
1754 * the first place.
1755 */
1756 return 0;
1757#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001758 }
Jerry Yu21092062022-10-10 21:21:31 +08001759#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001760
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1762 session)) != 0) {
1763 return ret;
1764 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001765
Paul Bakker0a597072012-09-25 21:55:46 +00001766 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001767
Gilles Peskine449bd832023-01-11 14:50:10 +01001768 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001769}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001770#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001771
Gilles Peskine449bd832023-01-11 14:50:10 +01001772void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1773 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001774{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001775 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001776}
1777
Ronald Cron6f135e12021-12-08 16:57:54 +01001778#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001779void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1780 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001781{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001782 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001783}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001784
1785#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001786void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1787 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001788{
1789 conf->early_data_enabled = early_data_enabled;
1790}
Jerry Yucc4e0072022-11-22 17:22:22 +08001791
1792#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001793void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001794 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001795{
Jerry Yu39da9852022-12-06 16:58:36 +08001796 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001797}
1798#endif /* MBEDTLS_SSL_SRV_C */
1799
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001800#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001801#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001802
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001803#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001804void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1805 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001806{
1807 conf->cert_profile = profile;
1808}
1809
Gilles Peskine449bd832023-01-11 14:50:10 +01001810static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001811{
1812 mbedtls_ssl_key_cert *cur = key_cert, *next;
1813
Gilles Peskine449bd832023-01-11 14:50:10 +01001814 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001815 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001816 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001817 cur = next;
1818 }
1819}
1820
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001821/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001822MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001823static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1824 mbedtls_x509_crt *cert,
1825 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001826{
niisato8ee24222018-06-25 19:05:48 +09001827 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001828
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001830 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001832 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001833 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001834 }
1835
Gilles Peskine449bd832023-01-11 14:50:10 +01001836 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1837 if (new_cert == NULL) {
1838 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1839 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001840
niisato8ee24222018-06-25 19:05:48 +09001841 new_cert->cert = cert;
1842 new_cert->key = key;
1843 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001844
Glenn Strauss36872db2022-01-22 05:06:31 -05001845 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001846 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001847 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001849 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001850 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001851 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001852 }
niisato8ee24222018-06-25 19:05:48 +09001853 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001854 }
1855
Gilles Peskine449bd832023-01-11 14:50:10 +01001856 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001857}
1858
Gilles Peskine449bd832023-01-11 14:50:10 +01001859int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001860 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001862{
Gilles Peskine449bd832023-01-11 14:50:10 +01001863 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001864}
1865
Gilles Peskine449bd832023-01-11 14:50:10 +01001866void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001867 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001868 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001869{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001870 conf->ca_chain = ca_chain;
1871 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001872
1873#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1874 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1875 * cannot be used together. */
1876 conf->f_ca_cb = NULL;
1877 conf->p_ca_cb = NULL;
1878#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001879}
Hanno Becker5adaad92019-03-27 16:54:37 +00001880
1881#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001882void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1883 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1884 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001885{
1886 conf->f_ca_cb = f_ca_cb;
1887 conf->p_ca_cb = p_ca_cb;
1888
1889 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1890 * cannot be used together. */
1891 conf->ca_chain = NULL;
1892 conf->ca_crl = NULL;
1893}
1894#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001895#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001896
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001897#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001898const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1899 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001900{
1901 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001902 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001903}
1904
Gilles Peskine449bd832023-01-11 14:50:10 +01001905int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1906 mbedtls_x509_crt *own_cert,
1907 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001908{
Gilles Peskine449bd832023-01-11 14:50:10 +01001909 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1910 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001911}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001912
Gilles Peskine449bd832023-01-11 14:50:10 +01001913void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1914 mbedtls_x509_crt *ca_chain,
1915 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001916{
1917 ssl->handshake->sni_ca_chain = ca_chain;
1918 ssl->handshake->sni_ca_crl = ca_crl;
1919}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001920
Glenn Strauss999ef702022-03-11 01:37:23 -05001921#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001922void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1923 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001924{
1925 ssl->handshake->dn_hints = crt;
1926}
1927#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1928
Gilles Peskine449bd832023-01-11 14:50:10 +01001929void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1930 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001931{
1932 ssl->handshake->sni_authmode = authmode;
1933}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001934#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1935
Hanno Becker8927c832019-04-03 12:52:50 +01001936#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001937void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1938 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1939 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001940{
1941 ssl->f_vrfy = f_vrfy;
1942 ssl->p_vrfy = p_vrfy;
1943}
1944#endif
1945
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001946#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001947
Valerio Setti016f6822022-12-09 14:17:50 +01001948#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001949static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1950static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1951
Valerio Setti016f6822022-12-09 14:17:50 +01001952static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001953 mbedtls_ssl_context *ssl,
1954 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001955{
1956 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001957 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001958 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001959 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001960 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001961 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1963 psa_pake_cs_set_primitive(&cipher_suite,
1964 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1965 PSA_ECC_FAMILY_SECP_R1,
1966 256));
1967 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001968
Gilles Peskine449bd832023-01-11 14:50:10 +01001969 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1970 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001971 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001973
Gilles Peskine449bd832023-01-11 14:50:10 +01001974 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001975 user = jpake_server_id;
1976 user_len = sizeof(jpake_server_id);
1977 peer = jpake_client_id;
1978 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01001980 user = jpake_client_id;
1981 user_len = sizeof(jpake_client_id);
1982 peer = jpake_server_id;
1983 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02001985
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001986 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
1987 if (status != PSA_SUCCESS) {
1988 return status;
1989 }
1990
1991 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001993 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001994 }
Valerio Setti016f6822022-12-09 14:17:50 +01001995
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
1997 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001998 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001999 }
Valerio Setti016f6822022-12-09 14:17:50 +01002000
2001 ssl->handshake->psa_pake_ctx_is_ok = 1;
2002
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002004}
2005
Gilles Peskine449bd832023-01-11 14:50:10 +01002006int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2007 const unsigned char *pw,
2008 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002009{
2010 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2011 psa_status_t status;
2012
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 if (ssl->handshake == NULL || ssl->conf == NULL) {
2014 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002015 }
2016
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 /* Empty password is not valid */
2018 if ((pw == NULL) || (pw_len == 0)) {
2019 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2020 }
2021
2022 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2023 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2024 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2025
2026 status = psa_import_key(&attributes, pw, pw_len,
2027 &ssl->handshake->psa_pake_password);
2028 if (status != PSA_SUCCESS) {
2029 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2030 }
2031
2032 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2033 ssl->handshake->psa_pake_password);
2034 if (status != PSA_SUCCESS) {
2035 psa_destroy_key(ssl->handshake->psa_pake_password);
2036 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2037 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2038 }
2039
2040 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002041}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002042
Gilles Peskine449bd832023-01-11 14:50:10 +01002043int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2044 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002045{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002046 psa_status_t status;
2047
Gilles Peskine449bd832023-01-11 14:50:10 +01002048 if (ssl->handshake == NULL || ssl->conf == NULL) {
2049 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002050 }
2051
Gilles Peskine449bd832023-01-11 14:50:10 +01002052 if (mbedtls_svc_key_id_is_null(pwd)) {
2053 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2054 }
2055
2056 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2057 if (status != PSA_SUCCESS) {
2058 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2059 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2060 }
2061
2062 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002063}
2064#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002065int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2066 const unsigned char *pw,
2067 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002068{
2069 mbedtls_ecjpake_role role;
2070
Gilles Peskine449bd832023-01-11 14:50:10 +01002071 if (ssl->handshake == NULL || ssl->conf == NULL) {
2072 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2073 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002074
Valerio Settic689ed82022-12-07 14:40:38 +01002075 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 if ((pw == NULL) || (pw_len == 0)) {
2077 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2078 }
Valerio Settic689ed82022-12-07 14:40:38 +01002079
Gilles Peskine449bd832023-01-11 14:50:10 +01002080 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002081 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002083 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002085
Gilles Peskine449bd832023-01-11 14:50:10 +01002086 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2087 role,
2088 MBEDTLS_MD_SHA256,
2089 MBEDTLS_ECP_DP_SECP256R1,
2090 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002091}
Valerio Setti02c25b52022-11-15 14:08:42 +01002092#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002093#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002094
Ronald Cron73fe8df2022-10-05 14:31:43 +02002095#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002096int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002097{
Gilles Peskine449bd832023-01-11 14:50:10 +01002098 if (conf->psk_identity == NULL ||
2099 conf->psk_identity_len == 0) {
2100 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002101 }
2102
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002103#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2105 return 1;
2106 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002107#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002108
Gilles Peskine449bd832023-01-11 14:50:10 +01002109 if (conf->psk != NULL && conf->psk_len != 0) {
2110 return 1;
2111 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002112
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002114}
2115
Gilles Peskine449bd832023-01-11 14:50:10 +01002116static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002117{
2118 /* Remove reference to existing PSK, if any. */
2119#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002121 /* The maintenance of the PSK key slot is the
2122 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002123 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002124 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002125#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002127 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002128 conf->psk = NULL;
2129 conf->psk_len = 0;
2130 }
2131
2132 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 if (conf->psk_identity != NULL) {
2134 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002135 conf->psk_identity = NULL;
2136 conf->psk_identity_len = 0;
2137 }
2138}
2139
Hanno Becker7390c712018-11-15 13:33:04 +00002140/* This function assumes that PSK identity in the SSL config is unset.
2141 * It checks that the provided identity is well-formed and attempts
2142 * to make a copy of it in the SSL config.
2143 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002144MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002145static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2146 unsigned char const *psk_identity,
2147 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002148{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002149 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002151 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 (psk_identity_len >> 16) != 0 ||
2153 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2154 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002155 }
2156
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2158 if (conf->psk_identity == NULL) {
2159 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2160 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002161
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002162 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002164
Gilles Peskine449bd832023-01-11 14:50:10 +01002165 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002166}
2167
Gilles Peskine449bd832023-01-11 14:50:10 +01002168int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2169 const unsigned char *psk, size_t psk_len,
2170 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002171{
Janos Follath865b3eb2019-12-16 11:46:15 +00002172 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002173
2174 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002175 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2176 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2177 }
Hanno Becker7390c712018-11-15 13:33:04 +00002178
2179 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002180 if (psk == NULL) {
2181 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2182 }
2183 if (psk_len == 0) {
2184 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2185 }
2186 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2187 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2188 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002189
Gilles Peskine449bd832023-01-11 14:50:10 +01002190 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2191 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2192 }
Hanno Becker7390c712018-11-15 13:33:04 +00002193 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002194 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002195
2196 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002197 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2198 if (ret != 0) {
2199 ssl_conf_remove_psk(conf);
2200 }
Hanno Becker7390c712018-11-15 13:33:04 +00002201
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002203}
2204
Gilles Peskine449bd832023-01-11 14:50:10 +01002205static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002206{
2207#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002209 /* The maintenance of the external PSK key slot is the
2210 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 if (ssl->handshake->psk_opaque_is_internal) {
2212 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002213 ssl->handshake->psk_opaque_is_internal = 0;
2214 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002215 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002216 }
Neil Armstronge952a302022-05-03 10:22:14 +02002217#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002219 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002220 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002221 ssl->handshake->psk_len = 0;
lhuang0454adeab2024-06-10 12:16:29 -07002222 ssl->handshake->psk = NULL;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002223 }
Neil Armstronge952a302022-05-03 10:22:14 +02002224#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002225}
2226
Gilles Peskine449bd832023-01-11 14:50:10 +01002227int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2228 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002229{
Neil Armstrong501c9322022-05-03 09:35:09 +02002230#if defined(MBEDTLS_USE_PSA_CRYPTO)
2231 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002232 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002233 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002234 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002235#endif /* MBEDTLS_USE_PSA_CRYPTO */
2236
Gilles Peskine449bd832023-01-11 14:50:10 +01002237 if (psk == NULL || ssl->handshake == NULL) {
2238 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2239 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002240
Gilles Peskine449bd832023-01-11 14:50:10 +01002241 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2242 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2243 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002244
Gilles Peskine449bd832023-01-11 14:50:10 +01002245 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002246
Neil Armstrong501c9322022-05-03 09:35:09 +02002247#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002248#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002249 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2250 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2251 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2252 } else {
2253 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2254 }
2255 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002256 }
2257#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002258
Jerry Yu568ec252022-07-22 21:27:34 +08002259#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002260 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2261 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2262 psa_set_key_usage_flags(&key_attributes,
2263 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002264 }
2265#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2266
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 psa_set_key_algorithm(&key_attributes, alg);
2268 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002269
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2271 if (status != PSA_SUCCESS) {
2272 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2273 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002274
2275 /* Allow calling psa_destroy_key() on psk remove */
2276 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002278#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002279 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2280 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2281 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002282
2283 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002285
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002287#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002288}
2289
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002290#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002291int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2292 mbedtls_svc_key_id_t psk,
2293 const unsigned char *psk_identity,
2294 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002295{
Janos Follath865b3eb2019-12-16 11:46:15 +00002296 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002297
2298 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2300 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2301 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002302
Hanno Becker7390c712018-11-15 13:33:04 +00002303 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002304 if (mbedtls_svc_key_id_is_null(psk)) {
2305 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2306 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002307 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002308
2309 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2311 psk_identity_len);
2312 if (ret != 0) {
2313 ssl_conf_remove_psk(conf);
2314 }
Hanno Becker7390c712018-11-15 13:33:04 +00002315
Gilles Peskine449bd832023-01-11 14:50:10 +01002316 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002317}
2318
Gilles Peskine449bd832023-01-11 14:50:10 +01002319int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2320 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002321{
Gilles Peskine449bd832023-01-11 14:50:10 +01002322 if ((mbedtls_svc_key_id_is_null(psk)) ||
2323 (ssl->handshake == NULL)) {
2324 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2325 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002326
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002328 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002330}
2331#endif /* MBEDTLS_USE_PSA_CRYPTO */
2332
Jerry Yu8897c072022-08-12 13:56:53 +08002333#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002334void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2335 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2336 size_t),
2337 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002338{
2339 conf->f_psk = f_psk;
2340 conf->p_psk = p_psk;
2341}
Jerry Yu8897c072022-08-12 13:56:53 +08002342#endif /* MBEDTLS_SSL_SRV_C */
2343
Ronald Cron73fe8df2022-10-05 14:31:43 +02002344#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002345
2346#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002347static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002348 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002349{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002350#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002351 if (alg == PSA_ALG_CBC_NO_PADDING) {
2352 return MBEDTLS_SSL_MODE_CBC;
2353 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002354#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002355 if (PSA_ALG_IS_AEAD(alg)) {
2356 return MBEDTLS_SSL_MODE_AEAD;
2357 }
2358 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002359}
2360
2361#else /* MBEDTLS_USE_PSA_CRYPTO */
2362
2363static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002364 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002365{
2366#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002367 if (mode == MBEDTLS_MODE_CBC) {
2368 return MBEDTLS_SSL_MODE_CBC;
2369 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002370#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2371
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002372#if defined(MBEDTLS_GCM_C) || \
2373 defined(MBEDTLS_CCM_C) || \
2374 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002376 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 mode == MBEDTLS_MODE_CHACHAPOLY) {
2378 return MBEDTLS_SSL_MODE_AEAD;
2379 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002380#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002381
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002383}
Gilles Peskine301711e2022-04-26 16:57:05 +02002384#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002385
Gilles Peskinee108d982022-04-26 16:50:40 +02002386static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2387 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002389{
2390#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2392 base_mode == MBEDTLS_SSL_MODE_CBC) {
2393 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002394 }
2395#else
2396 (void) encrypt_then_mac;
2397#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002398 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002399}
2400
Neil Armstrongab555e02022-04-04 11:07:59 +02002401mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002402 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002403{
Gilles Peskinee108d982022-04-26 16:50:40 +02002404 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002405#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002407#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002409#endif
2410 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002411
Gilles Peskinee108d982022-04-26 16:50:40 +02002412 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002413#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002414 encrypt_then_mac = transform->encrypt_then_mac;
2415#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002416 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002417}
2418
Neil Armstrongab555e02022-04-04 11:07:59 +02002419mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002420#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002421 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002422#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002423 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002424{
Gilles Peskinee108d982022-04-26 16:50:40 +02002425 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2426
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002427#if defined(MBEDTLS_USE_PSA_CRYPTO)
2428 psa_status_t status;
2429 psa_algorithm_t alg;
2430 psa_key_type_t type;
2431 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002432 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2433 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 if (status == PSA_SUCCESS) {
2435 base_mode = mbedtls_ssl_get_base_mode(alg);
2436 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002437#else
2438 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002439 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002441 base_mode =
2442 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002444 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002445#endif /* MBEDTLS_USE_PSA_CRYPTO */
2446
Gilles Peskinee108d982022-04-26 16:50:40 +02002447#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2448 int encrypt_then_mac = 0;
2449#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002450 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002451}
2452
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002453#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002454
Gilles Peskine449bd832023-01-11 14:50:10 +01002455psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2456 size_t taglen,
2457 psa_algorithm_t *alg,
2458 psa_key_type_t *key_type,
2459 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002460{
Elena Uziunaitec2561722024-07-05 11:37:33 +01002461#if !defined(PSA_WANT_ALG_CCM)
Yanray Wang19e4dc82023-11-16 18:02:05 +08002462 (void) taglen;
2463#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 switch (mbedtls_cipher_type) {
Elena Uziunaite74342c72024-07-05 11:31:29 +01002465#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002466 case MBEDTLS_CIPHER_AES_128_CBC:
2467 *alg = PSA_ALG_CBC_NO_PADDING;
2468 *key_type = PSA_KEY_TYPE_AES;
2469 *key_size = 128;
2470 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002471#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002472#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002473 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002475 *key_type = PSA_KEY_TYPE_AES;
2476 *key_size = 128;
2477 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002478#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002479#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002480 case MBEDTLS_CIPHER_AES_128_GCM:
2481 *alg = PSA_ALG_GCM;
2482 *key_type = PSA_KEY_TYPE_AES;
2483 *key_size = 128;
2484 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002485#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002486#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002487 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002488 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002489 *key_type = PSA_KEY_TYPE_AES;
2490 *key_size = 192;
2491 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002492#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002493#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002494 case MBEDTLS_CIPHER_AES_192_GCM:
2495 *alg = PSA_ALG_GCM;
2496 *key_type = PSA_KEY_TYPE_AES;
2497 *key_size = 192;
2498 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002499#endif
Elena Uziunaite74342c72024-07-05 11:31:29 +01002500#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002501 case MBEDTLS_CIPHER_AES_256_CBC:
2502 *alg = PSA_ALG_CBC_NO_PADDING;
2503 *key_type = PSA_KEY_TYPE_AES;
2504 *key_size = 256;
2505 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002506#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002507#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002508 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002510 *key_type = PSA_KEY_TYPE_AES;
2511 *key_size = 256;
2512 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002513#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002514#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002515 case MBEDTLS_CIPHER_AES_256_GCM:
2516 *alg = PSA_ALG_GCM;
2517 *key_type = PSA_KEY_TYPE_AES;
2518 *key_size = 256;
2519 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002520#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002521#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002522 case MBEDTLS_CIPHER_ARIA_128_CBC:
2523 *alg = PSA_ALG_CBC_NO_PADDING;
2524 *key_type = PSA_KEY_TYPE_ARIA;
2525 *key_size = 128;
2526 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002527#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002528#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002529 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002530 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002531 *key_type = PSA_KEY_TYPE_ARIA;
2532 *key_size = 128;
2533 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002534#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002535#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002536 case MBEDTLS_CIPHER_ARIA_128_GCM:
2537 *alg = PSA_ALG_GCM;
2538 *key_type = PSA_KEY_TYPE_ARIA;
2539 *key_size = 128;
2540 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002541#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002542#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002543 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002544 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002545 *key_type = PSA_KEY_TYPE_ARIA;
2546 *key_size = 192;
2547 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002548#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002549#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002550 case MBEDTLS_CIPHER_ARIA_192_GCM:
2551 *alg = PSA_ALG_GCM;
2552 *key_type = PSA_KEY_TYPE_ARIA;
2553 *key_size = 192;
2554 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002555#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002556#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002557 case MBEDTLS_CIPHER_ARIA_256_CBC:
2558 *alg = PSA_ALG_CBC_NO_PADDING;
2559 *key_type = PSA_KEY_TYPE_ARIA;
2560 *key_size = 256;
2561 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002562#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002563#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002564 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002566 *key_type = PSA_KEY_TYPE_ARIA;
2567 *key_size = 256;
2568 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002569#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002570#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002571 case MBEDTLS_CIPHER_ARIA_256_GCM:
2572 *alg = PSA_ALG_GCM;
2573 *key_type = PSA_KEY_TYPE_ARIA;
2574 *key_size = 256;
2575 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002576#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002577#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002578 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2579 *alg = PSA_ALG_CBC_NO_PADDING;
2580 *key_type = PSA_KEY_TYPE_CAMELLIA;
2581 *key_size = 128;
2582 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002583#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002584#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002585 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002587 *key_type = PSA_KEY_TYPE_CAMELLIA;
2588 *key_size = 128;
2589 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002590#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002591#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002592 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2593 *alg = PSA_ALG_GCM;
2594 *key_type = PSA_KEY_TYPE_CAMELLIA;
2595 *key_size = 128;
2596 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002597#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002598#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002599 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002600 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002601 *key_type = PSA_KEY_TYPE_CAMELLIA;
2602 *key_size = 192;
2603 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002604#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002605#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002606 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2607 *alg = PSA_ALG_GCM;
2608 *key_type = PSA_KEY_TYPE_CAMELLIA;
2609 *key_size = 192;
2610 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002611#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002612#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002613 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2614 *alg = PSA_ALG_CBC_NO_PADDING;
2615 *key_type = PSA_KEY_TYPE_CAMELLIA;
2616 *key_size = 256;
2617 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002618#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002619#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002620 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002621 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002622 *key_type = PSA_KEY_TYPE_CAMELLIA;
2623 *key_size = 256;
2624 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002625#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002626#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002627 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2628 *alg = PSA_ALG_GCM;
2629 *key_type = PSA_KEY_TYPE_CAMELLIA;
2630 *key_size = 256;
2631 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002632#endif
Elena Uziunaite5c70c302024-07-05 11:44:44 +01002633#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002634 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2635 *alg = PSA_ALG_CHACHA20_POLY1305;
2636 *key_type = PSA_KEY_TYPE_CHACHA20;
2637 *key_size = 256;
2638 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002639#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002640 case MBEDTLS_CIPHER_NULL:
2641 *alg = MBEDTLS_SSL_NULL_CIPHER;
2642 *key_type = 0;
2643 *key_size = 0;
2644 break;
2645 default:
2646 return PSA_ERROR_NOT_SUPPORTED;
2647 }
2648
2649 return PSA_SUCCESS;
2650}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002651#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002652
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002653#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002654int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2655 const unsigned char *dhm_P, size_t P_len,
2656 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002657{
Janos Follath865b3eb2019-12-16 11:46:15 +00002658 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002659
Gilles Peskine449bd832023-01-11 14:50:10 +01002660 mbedtls_mpi_free(&conf->dhm_P);
2661 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002662
Gilles Peskine449bd832023-01-11 14:50:10 +01002663 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2664 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2665 mbedtls_mpi_free(&conf->dhm_P);
2666 mbedtls_mpi_free(&conf->dhm_G);
2667 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002668 }
2669
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002671}
Paul Bakker5121ce52009-01-03 21:22:43 +00002672
Gilles Peskine449bd832023-01-11 14:50:10 +01002673int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002674{
Janos Follath865b3eb2019-12-16 11:46:15 +00002675 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002676
Gilles Peskine449bd832023-01-11 14:50:10 +01002677 mbedtls_mpi_free(&conf->dhm_P);
2678 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002679
Gilles Peskine449bd832023-01-11 14:50:10 +01002680 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2681 &conf->dhm_P)) != 0 ||
2682 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2683 &conf->dhm_G)) != 0) {
2684 mbedtls_mpi_free(&conf->dhm_P);
2685 mbedtls_mpi_free(&conf->dhm_G);
2686 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002687 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002688
Gilles Peskine449bd832023-01-11 14:50:10 +01002689 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002690}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002691#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002692
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002693#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2694/*
2695 * Set the minimum length for Diffie-Hellman parameters
2696 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002697void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2698 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002699{
2700 conf->dhm_min_bitlen = bitlen;
2701}
2702#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2703
Ronald Crone68ab4f2022-10-05 12:46:29 +02002704#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002705#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002706/*
2707 * Set allowed/preferred hashes for handshake signatures
2708 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002709void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2710 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002711{
2712 conf->sig_hashes = hashes;
2713}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002714#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002715
Jerry Yuf017ee42022-01-12 15:49:48 +08002716/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002717void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2718 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002719{
Jerry Yuf017ee42022-01-12 15:49:48 +08002720#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2721 conf->sig_hashes = NULL;
2722#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2723 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002724}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002725#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002726
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002727#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002728#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002729/*
2730 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002731 *
2732 * mbedtls_ssl_setup() takes the provided list
2733 * and translates it to a list of IANA TLS group identifiers,
2734 * stored in ssl->handshake->group_list.
2735 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002736 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002737void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2738 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002739{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002740 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002741 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002742}
Brett Warrene0edc842021-08-17 09:53:13 +01002743#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002744#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002745
Brett Warrene0edc842021-08-17 09:53:13 +01002746/*
2747 * Set the allowed groups
2748 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002749void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2750 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002751{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002752#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002753 conf->curve_list = NULL;
2754#endif
2755 conf->group_list = group_list;
2756}
2757
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002758#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002759int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002760{
Hanno Becker947194e2017-04-07 13:25:49 +01002761 /* Initialize to suppress unnecessary compiler warning */
2762 size_t hostname_len = 0;
2763
2764 /* Check if new hostname is valid before
2765 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002766 if (hostname != NULL) {
2767 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002768
Gilles Peskine449bd832023-01-11 14:50:10 +01002769 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2770 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2771 }
Hanno Becker947194e2017-04-07 13:25:49 +01002772 }
2773
2774 /* Now it's clear that we will overwrite the old hostname,
2775 * so we can free it safely */
2776
Gilles Peskine449bd832023-01-11 14:50:10 +01002777 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002778 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002779 }
2780
2781 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002782
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002784 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002785 } else {
2786 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2787 if (ssl->hostname == NULL) {
2788 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2789 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002790
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002792
Hanno Becker947194e2017-04-07 13:25:49 +01002793 ssl->hostname[hostname_len] = '\0';
2794 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002795
Gilles Peskine449bd832023-01-11 14:50:10 +01002796 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002797}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002798#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002799
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002800#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002801void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2802 int (*f_sni)(void *, mbedtls_ssl_context *,
2803 const unsigned char *, size_t),
2804 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002805{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002806 conf->f_sni = f_sni;
2807 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002808}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002809#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002810
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002811#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002812int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002813{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002814 size_t cur_len, tot_len;
2815 const char **p;
2816
2817 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002818 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2819 * MUST NOT be truncated."
2820 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002821 */
2822 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 for (p = protos; *p != NULL; p++) {
2824 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002825 tot_len += cur_len;
2826
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 if ((cur_len == 0) ||
2828 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2829 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2830 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2831 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002832 }
2833
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002834 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002835
Gilles Peskine449bd832023-01-11 14:50:10 +01002836 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002837}
2838
Gilles Peskine449bd832023-01-11 14:50:10 +01002839const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002840{
Gilles Peskine449bd832023-01-11 14:50:10 +01002841 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002842}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002843#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002844
Johan Pascalb62bb512015-12-03 21:56:45 +01002845#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002846void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2847 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002848{
2849 conf->dtls_srtp_mki_support = support_mki_value;
2850}
2851
Gilles Peskine449bd832023-01-11 14:50:10 +01002852int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2853 unsigned char *mki_value,
2854 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002855{
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2857 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002858 }
Ron Eldor591f1622018-01-22 12:30:04 +02002859
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2861 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002862 }
Ron Eldor591f1622018-01-22 12:30:04 +02002863
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002865 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002866 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002867}
2868
Gilles Peskine449bd832023-01-11 14:50:10 +01002869int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2870 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002871{
Johan Pascal253d0262020-09-22 13:04:45 +02002872 const mbedtls_ssl_srtp_profile *p;
2873 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002874
Johan Pascal253d0262020-09-22 13:04:45 +02002875 /* check the profiles list: all entry must be valid,
2876 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2878 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2879 p++) {
2880 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002881 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002882 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002883 /* unsupported value, stop parsing and set the size to an error value */
2884 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002885 }
2886 }
2887
Gilles Peskine449bd832023-01-11 14:50:10 +01002888 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2889 conf->dtls_srtp_profile_list = NULL;
2890 conf->dtls_srtp_profile_list_len = 0;
2891 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002892 }
2893
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002894 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002895 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002896
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002898}
2899
Gilles Peskine449bd832023-01-11 14:50:10 +01002900void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2901 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002902{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002903 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2904 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002906 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002907 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002908 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002909 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2910 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002911 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002912}
Johan Pascalb62bb512015-12-03 21:56:45 +01002913#endif /* MBEDTLS_SSL_DTLS_SRTP */
2914
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302915#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002916void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002917{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002918 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002919}
2920
Gilles Peskine449bd832023-01-11 14:50:10 +01002921void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002922{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002923 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002924}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302925#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002926
Janos Follath088ce432017-04-10 12:42:31 +01002927#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002928void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2929 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002930{
2931 conf->cert_req_ca_list = cert_req_ca_list;
2932}
2933#endif
2934
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002935#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002936void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002937{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002938 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002939}
2940#endif
2941
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002942#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002943void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002944{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002945 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002946}
2947#endif
2948
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002949#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002950int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002951{
Gilles Peskine449bd832023-01-11 14:50:10 +01002952 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2953 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2954 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002955 }
2956
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002957 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002958
Gilles Peskine449bd832023-01-11 14:50:10 +01002959 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002960}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002961#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002962
Gilles Peskine449bd832023-01-11 14:50:10 +01002963void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002964{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002965 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002966}
2967
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002968#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002969void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002970{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002971 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002972}
2973
Gilles Peskine449bd832023-01-11 14:50:10 +01002974void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002975{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002976 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002977}
2978
Gilles Peskine449bd832023-01-11 14:50:10 +01002979void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2980 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002981{
Gilles Peskine449bd832023-01-11 14:50:10 +01002982 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002983}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002984#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002986#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002987#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002988void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002989{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002990 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002991}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002992#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02002993
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002994#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002995
Jerry Yud0766ec2022-09-22 10:46:57 +08002996#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01002997void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
2998 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08002999{
Jerry Yud0766ec2022-09-22 10:46:57 +08003000 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003001}
3002#endif
3003
Gilles Peskine449bd832023-01-11 14:50:10 +01003004void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3005 mbedtls_ssl_ticket_write_t *f_ticket_write,
3006 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3007 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003008{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003009 conf->f_ticket_write = f_ticket_write;
3010 conf->f_ticket_parse = f_ticket_parse;
3011 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003012}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003013#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003014#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003015
Gilles Peskine449bd832023-01-11 14:50:10 +01003016void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3017 mbedtls_ssl_export_keys_t *f_export_keys,
3018 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003019{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003020 ssl->f_export_keys = f_export_keys;
3021 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003022}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003023
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003024#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003025void mbedtls_ssl_conf_async_private_cb(
3026 mbedtls_ssl_config *conf,
3027 mbedtls_ssl_async_sign_t *f_async_sign,
3028 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3029 mbedtls_ssl_async_resume_t *f_async_resume,
3030 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003032{
3033 conf->f_async_sign_start = f_async_sign;
3034 conf->f_async_decrypt_start = f_async_decrypt;
3035 conf->f_async_resume = f_async_resume;
3036 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003037 conf->p_async_config_data = async_config_data;
3038}
3039
Gilles Peskine449bd832023-01-11 14:50:10 +01003040void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003041{
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003043}
3044
Gilles Peskine449bd832023-01-11 14:50:10 +01003045void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003046{
Gilles Peskine449bd832023-01-11 14:50:10 +01003047 if (ssl->handshake == NULL) {
3048 return NULL;
3049 } else {
3050 return ssl->handshake->user_async_ctx;
3051 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003052}
3053
Gilles Peskine449bd832023-01-11 14:50:10 +01003054void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3055 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003056{
Gilles Peskine449bd832023-01-11 14:50:10 +01003057 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003058 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003059 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003060}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003061#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003062
Paul Bakker5121ce52009-01-03 21:22:43 +00003063/*
3064 * SSL get accessors
3065 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003066uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003067{
Gilles Peskine449bd832023-01-11 14:50:10 +01003068 if (ssl->session != NULL) {
3069 return ssl->session->verify_result;
3070 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003071
Gilles Peskine449bd832023-01-11 14:50:10 +01003072 if (ssl->session_negotiate != NULL) {
3073 return ssl->session_negotiate->verify_result;
3074 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003075
Gilles Peskine449bd832023-01-11 14:50:10 +01003076 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003077}
3078
Gilles Peskine449bd832023-01-11 14:50:10 +01003079int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003080{
Gilles Peskine449bd832023-01-11 14:50:10 +01003081 if (ssl == NULL || ssl->session == NULL) {
3082 return 0;
3083 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003084
Gilles Peskine449bd832023-01-11 14:50:10 +01003085 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003086}
3087
Gilles Peskine449bd832023-01-11 14:50:10 +01003088const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003089{
Gilles Peskine449bd832023-01-11 14:50:10 +01003090 if (ssl == NULL || ssl->session == NULL) {
3091 return NULL;
3092 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003093
Gilles Peskine449bd832023-01-11 14:50:10 +01003094 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003095}
3096
Gilles Peskine449bd832023-01-11 14:50:10 +01003097const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003098{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003099#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003100 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3101 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003102 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003103 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003104 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003105 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003106 }
3107 }
3108#endif
3109
Gilles Peskine449bd832023-01-11 14:50:10 +01003110 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003111 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003112 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003113 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003114 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003115 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003116 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003117 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003118}
3119
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003120#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3121
3122size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3123{
3124 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3125 size_t record_size_limit = max_len;
3126
3127 if (ssl->session != NULL &&
3128 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3129 ssl->session->record_size_limit < max_len) {
3130 record_size_limit = ssl->session->record_size_limit;
3131 }
3132
3133 // TODO: this is currently untested
3134 /* During a handshake, use the value being negotiated */
3135 if (ssl->session_negotiate != NULL &&
3136 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3137 ssl->session_negotiate->record_size_limit < max_len) {
3138 record_size_limit = ssl->session_negotiate->record_size_limit;
3139 }
3140
3141 return record_size_limit;
3142}
3143#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3144
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003145#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003146size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003147{
David Horstmann95d516f2021-05-04 18:36:56 +01003148 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003149 size_t read_mfl;
3150
Jerry Yuddda0502022-12-01 19:43:12 +08003151#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003152 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003153 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3154 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3155 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003156 }
Jerry Yuddda0502022-12-01 19:43:12 +08003157#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003158
3159 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003160 if (ssl->session_out != NULL) {
3161 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3162 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003163 max_len = read_mfl;
3164 }
3165 }
3166
Jerry Yuddda0502022-12-01 19:43:12 +08003167 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003168 if (ssl->session_negotiate != NULL) {
3169 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3170 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003171 max_len = read_mfl;
3172 }
3173 }
3174
Gilles Peskine449bd832023-01-11 14:50:10 +01003175 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003176}
3177
Gilles Peskine449bd832023-01-11 14:50:10 +01003178size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003179{
3180 size_t max_len;
3181
3182 /*
3183 * Assume mfl_code is correct since it was checked when set
3184 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003185 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003186
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003187 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003188 if (ssl->session_out != NULL &&
3189 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3190 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003191 }
3192
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003193 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003194 if (ssl->session_negotiate != NULL &&
3195 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3196 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003197 }
3198
Gilles Peskine449bd832023-01-11 14:50:10 +01003199 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003200}
3201#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3202
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003203#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003204size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003205{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003206 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003207 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3208 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3209 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3210 return 0;
3211 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003212
Gilles Peskine449bd832023-01-11 14:50:10 +01003213 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3214 return ssl->mtu;
3215 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003216
Gilles Peskine449bd832023-01-11 14:50:10 +01003217 if (ssl->mtu == 0) {
3218 return ssl->handshake->mtu;
3219 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003220
Gilles Peskine449bd832023-01-11 14:50:10 +01003221 return ssl->mtu < ssl->handshake->mtu ?
3222 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003223}
3224#endif /* MBEDTLS_SSL_PROTO_DTLS */
3225
Gilles Peskine449bd832023-01-11 14:50:10 +01003226int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003227{
3228 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3229
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003230#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003231 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003232 !defined(MBEDTLS_SSL_PROTO_DTLS)
3233 (void) ssl;
3234#endif
3235
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003236#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003237 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003238
Gilles Peskine449bd832023-01-11 14:50:10 +01003239 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003240 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003241 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003242#endif
3243
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003244#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3245 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3246
3247 if (max_len > record_size_limit) {
3248 max_len = record_size_limit;
3249 }
3250#endif
3251
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003252 if (ssl->transform_out != NULL &&
3253 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003254 /*
3255 * In TLS 1.3 case, when records are protected, `max_len` as computed
3256 * above is the maximum length of the TLSInnerPlaintext structure that
3257 * along the plaintext payload contains the inner content type (one byte)
3258 * and some zero padding. Given the algorithm used for padding
3259 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3260 * the plaintext payload. Round down to a multiple of
3261 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3262 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003263 */
3264 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3265 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3266 }
3267
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003268#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003269 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3270 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3271 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003272 const size_t overhead = (size_t) ret;
3273
Gilles Peskine449bd832023-01-11 14:50:10 +01003274 if (ret < 0) {
3275 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003276 }
3277
Gilles Peskine449bd832023-01-11 14:50:10 +01003278 if (mtu <= overhead) {
3279 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3280 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3281 }
3282
3283 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003284 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003285 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003286 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003287#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003288
Hanno Becker0defedb2018-08-10 12:35:02 +01003289#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003290 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3291 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003292 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003293#endif
3294
Gilles Peskine449bd832023-01-11 14:50:10 +01003295 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003296}
3297
Gilles Peskine449bd832023-01-11 14:50:10 +01003298int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003299{
3300 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3301
3302#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3303 (void) ssl;
3304#endif
3305
3306#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003307 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003308
Gilles Peskine449bd832023-01-11 14:50:10 +01003309 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003310 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003311 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003312#endif
3313
Gilles Peskine449bd832023-01-11 14:50:10 +01003314 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003315}
3316
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003317#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003318const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003319{
Gilles Peskine449bd832023-01-11 14:50:10 +01003320 if (ssl == NULL || ssl->session == NULL) {
3321 return NULL;
3322 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003323
Hanno Beckere6824572019-02-07 13:18:46 +00003324#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003325 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003326#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003327 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003328#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003329}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003330#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003331
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003332#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003333int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3334 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003335{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003336 int ret;
3337
Gilles Peskine449bd832023-01-11 14:50:10 +01003338 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003339 dst == NULL ||
3340 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003341 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3342 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003343 }
3344
Hanno Beckere810bbc2021-05-14 16:01:05 +01003345 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3346 * idempotent: Each session can only be exported once.
3347 *
3348 * (This is in preparation for TLS 1.3 support where we will
3349 * need the ability to export multiple sessions (aka tickets),
3350 * which will be achieved by calling mbedtls_ssl_get_session()
3351 * multiple times until it fails.)
3352 *
3353 * Check whether we have already exported the current session,
3354 * and fail if so.
3355 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003356 if (ssl->session->exported == 1) {
3357 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3358 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003359
Gilles Peskine449bd832023-01-11 14:50:10 +01003360 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3361 if (ret != 0) {
3362 return ret;
3363 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003364
3365 /* Remember that we've exported the session. */
3366 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003367 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003368}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003369#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003370
David Horstmanncb01b362024-02-29 17:31:46 +00003371#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3372
3373/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003374 *
David Horstmanncb01b362024-02-29 17:31:46 +00003375 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003376 */
3377static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3378 unsigned char *buf,
3379 size_t buf_len)
3380{
3381 unsigned char *p = buf;
3382 size_t used = 0;
3383
3384#if defined(MBEDTLS_HAVE_TIME)
3385 uint64_t start;
3386#endif
3387#if defined(MBEDTLS_X509_CRT_PARSE_C)
3388#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3389 size_t cert_len;
3390#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3391#endif /* MBEDTLS_X509_CRT_PARSE_C */
3392
3393 /*
3394 * Time
3395 */
3396#if defined(MBEDTLS_HAVE_TIME)
3397 used += 8;
3398
3399 if (used <= buf_len) {
3400 start = (uint64_t) session->start;
3401
3402 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3403 p += 8;
3404 }
3405#endif /* MBEDTLS_HAVE_TIME */
3406
3407 /*
3408 * Basic mandatory fields
3409 */
3410 used += 1 /* id_len */
3411 + sizeof(session->id)
3412 + sizeof(session->master)
3413 + 4; /* verify_result */
3414
3415 if (used <= buf_len) {
3416 *p++ = MBEDTLS_BYTE_0(session->id_len);
3417 memcpy(p, session->id, 32);
3418 p += 32;
3419
3420 memcpy(p, session->master, 48);
3421 p += 48;
3422
3423 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3424 p += 4;
3425 }
3426
3427 /*
3428 * Peer's end-entity certificate
3429 */
3430#if defined(MBEDTLS_X509_CRT_PARSE_C)
3431#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3432 if (session->peer_cert == NULL) {
3433 cert_len = 0;
3434 } else {
3435 cert_len = session->peer_cert->raw.len;
3436 }
3437
3438 used += 3 + cert_len;
3439
3440 if (used <= buf_len) {
3441 *p++ = MBEDTLS_BYTE_2(cert_len);
3442 *p++ = MBEDTLS_BYTE_1(cert_len);
3443 *p++ = MBEDTLS_BYTE_0(cert_len);
3444
3445 if (session->peer_cert != NULL) {
3446 memcpy(p, session->peer_cert->raw.p, cert_len);
3447 p += cert_len;
3448 }
3449 }
3450#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3451 if (session->peer_cert_digest != NULL) {
3452 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3453 if (used <= buf_len) {
3454 *p++ = (unsigned char) session->peer_cert_digest_type;
3455 *p++ = (unsigned char) session->peer_cert_digest_len;
3456 memcpy(p, session->peer_cert_digest,
3457 session->peer_cert_digest_len);
3458 p += session->peer_cert_digest_len;
3459 }
3460 } else {
3461 used += 2;
3462 if (used <= buf_len) {
3463 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3464 *p++ = 0;
3465 }
3466 }
3467#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3468#endif /* MBEDTLS_X509_CRT_PARSE_C */
3469
3470 /*
3471 * Session ticket if any, plus associated data
3472 */
3473#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3474#if defined(MBEDTLS_SSL_CLI_C)
3475 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3476 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3477
3478 if (used <= buf_len) {
3479 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3480 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3481 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3482
3483 if (session->ticket != NULL) {
3484 memcpy(p, session->ticket, session->ticket_len);
3485 p += session->ticket_len;
3486 }
3487
3488 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3489 p += 4;
3490 }
3491 }
3492#endif /* MBEDTLS_SSL_CLI_C */
3493#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3494 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3495 used += 8;
3496
3497 if (used <= buf_len) {
3498 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3499 p += 8;
3500 }
3501 }
3502#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3503#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3504
3505 /*
3506 * Misc extension-related info
3507 */
3508#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3509 used += 1;
3510
3511 if (used <= buf_len) {
3512 *p++ = session->mfl_code;
3513 }
3514#endif
3515
3516#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3517 used += 1;
3518
3519 if (used <= buf_len) {
3520 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3521 }
3522#endif
3523
3524 return used;
3525}
3526
3527MBEDTLS_CHECK_RETURN_CRITICAL
3528static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3529 const unsigned char *buf,
3530 size_t len)
3531{
3532#if defined(MBEDTLS_HAVE_TIME)
3533 uint64_t start;
3534#endif
3535#if defined(MBEDTLS_X509_CRT_PARSE_C)
3536#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3537 size_t cert_len;
3538#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3539#endif /* MBEDTLS_X509_CRT_PARSE_C */
3540
3541 const unsigned char *p = buf;
3542 const unsigned char * const end = buf + len;
3543
3544 /*
3545 * Time
3546 */
3547#if defined(MBEDTLS_HAVE_TIME)
3548 if (8 > (size_t) (end - p)) {
3549 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3550 }
3551
3552 start = MBEDTLS_GET_UINT64_BE(p, 0);
3553 p += 8;
3554
3555 session->start = (time_t) start;
3556#endif /* MBEDTLS_HAVE_TIME */
3557
3558 /*
3559 * Basic mandatory fields
3560 */
3561 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3562 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3563 }
3564
3565 session->id_len = *p++;
3566 memcpy(session->id, p, 32);
3567 p += 32;
3568
3569 memcpy(session->master, p, 48);
3570 p += 48;
3571
3572 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3573 p += 4;
3574
3575 /* Immediately clear invalid pointer values that have been read, in case
3576 * we exit early before we replaced them with valid ones. */
3577#if defined(MBEDTLS_X509_CRT_PARSE_C)
3578#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3579 session->peer_cert = NULL;
3580#else
3581 session->peer_cert_digest = NULL;
3582#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3583#endif /* MBEDTLS_X509_CRT_PARSE_C */
3584#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3585 session->ticket = NULL;
3586#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3587
3588 /*
3589 * Peer certificate
3590 */
3591#if defined(MBEDTLS_X509_CRT_PARSE_C)
3592#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3593 /* Deserialize CRT from the end of the ticket. */
3594 if (3 > (size_t) (end - p)) {
3595 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3596 }
3597
3598 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3599 p += 3;
3600
3601 if (cert_len != 0) {
3602 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3603
3604 if (cert_len > (size_t) (end - p)) {
3605 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3606 }
3607
3608 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3609
3610 if (session->peer_cert == NULL) {
3611 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3612 }
3613
3614 mbedtls_x509_crt_init(session->peer_cert);
3615
3616 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3617 p, cert_len)) != 0) {
3618 mbedtls_x509_crt_free(session->peer_cert);
3619 mbedtls_free(session->peer_cert);
3620 session->peer_cert = NULL;
3621 return ret;
3622 }
3623
3624 p += cert_len;
3625 }
3626#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3627 /* Deserialize CRT digest from the end of the ticket. */
3628 if (2 > (size_t) (end - p)) {
3629 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3630 }
3631
3632 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3633 session->peer_cert_digest_len = (size_t) *p++;
3634
3635 if (session->peer_cert_digest_len != 0) {
3636 const mbedtls_md_info_t *md_info =
3637 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3638 if (md_info == NULL) {
3639 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3640 }
3641 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3642 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3643 }
3644
3645 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3646 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3647 }
3648
3649 session->peer_cert_digest =
3650 mbedtls_calloc(1, session->peer_cert_digest_len);
3651 if (session->peer_cert_digest == NULL) {
3652 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3653 }
3654
3655 memcpy(session->peer_cert_digest, p,
3656 session->peer_cert_digest_len);
3657 p += session->peer_cert_digest_len;
3658 }
3659#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3660#endif /* MBEDTLS_X509_CRT_PARSE_C */
3661
3662 /*
3663 * Session ticket and associated data
3664 */
3665#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3666#if defined(MBEDTLS_SSL_CLI_C)
3667 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3668 if (3 > (size_t) (end - p)) {
3669 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3670 }
3671
3672 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3673 p += 3;
3674
3675 if (session->ticket_len != 0) {
3676 if (session->ticket_len > (size_t) (end - p)) {
3677 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3678 }
3679
3680 session->ticket = mbedtls_calloc(1, session->ticket_len);
3681 if (session->ticket == NULL) {
3682 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3683 }
3684
3685 memcpy(session->ticket, p, session->ticket_len);
3686 p += session->ticket_len;
3687 }
3688
3689 if (4 > (size_t) (end - p)) {
3690 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3691 }
3692
3693 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3694 p += 4;
3695 }
3696#endif /* MBEDTLS_SSL_CLI_C */
3697#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3698 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3699 if (8 > (size_t) (end - p)) {
3700 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3701 }
3702 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3703 p += 8;
3704 }
3705#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3706#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3707
3708 /*
3709 * Misc extension-related info
3710 */
3711#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3712 if (1 > (size_t) (end - p)) {
3713 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3714 }
3715
3716 session->mfl_code = *p++;
3717#endif
3718
3719#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3720 if (1 > (size_t) (end - p)) {
3721 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3722 }
3723
3724 session->encrypt_then_mac = *p++;
3725#endif
3726
3727 /* Done, should have consumed entire buffer */
3728 if (p != end) {
3729 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3730 }
3731
3732 return 0;
3733}
3734
3735#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3736
3737#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3738/* Serialization of TLS 1.3 sessions:
3739 *
David Horstmanncb01b362024-02-29 17:31:46 +00003740 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003741 */
3742#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3743MBEDTLS_CHECK_RETURN_CRITICAL
3744static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3745 unsigned char *buf,
3746 size_t buf_len,
3747 size_t *olen)
3748{
3749 unsigned char *p = buf;
3750#if defined(MBEDTLS_SSL_CLI_C) && \
3751 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3752 size_t hostname_len = (session->hostname == NULL) ?
3753 0 : strlen(session->hostname) + 1;
3754#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003755
3756#if defined(MBEDTLS_SSL_SRV_C) && \
3757 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003758 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003759 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003760#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003761 size_t needed = 4 /* ticket_age_add */
3762 + 1 /* ticket_flags */
3763 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003764
David Horstmanne59f9702024-02-29 16:08:57 +00003765 *olen = 0;
3766
3767 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3768 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3769 }
3770 needed += session->resumption_key_len; /* resumption_key */
3771
3772#if defined(MBEDTLS_SSL_EARLY_DATA)
3773 needed += 4; /* max_early_data_size */
3774#endif
3775#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3776 needed += 2; /* record_size_limit */
3777#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3778
3779#if defined(MBEDTLS_HAVE_TIME)
3780 needed += 8; /* ticket_creation_time or ticket_reception_time */
3781#endif
3782
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003783#if defined(MBEDTLS_SSL_SRV_C)
3784 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3785#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003786 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003787 + alpn_len; /* alpn */
3788#endif
3789 }
3790#endif /* MBEDTLS_SSL_SRV_C */
3791
David Horstmanne59f9702024-02-29 16:08:57 +00003792#if defined(MBEDTLS_SSL_CLI_C)
3793 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3794#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3795 needed += 2 /* hostname_len */
3796 + hostname_len; /* hostname */
3797#endif
3798
3799 needed += 4 /* ticket_lifetime */
3800 + 2; /* ticket_len */
3801
3802 /* Check size_t overflow */
3803 if (session->ticket_len > SIZE_MAX - needed) {
3804 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3805 }
3806
3807 needed += session->ticket_len; /* ticket */
3808 }
3809#endif /* MBEDTLS_SSL_CLI_C */
3810
3811 *olen = needed;
3812 if (needed > buf_len) {
3813 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3814 }
3815
3816 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3817 p[4] = session->ticket_flags;
3818
3819 /* save resumption_key */
3820 p[5] = session->resumption_key_len;
3821 p += 6;
3822 memcpy(p, session->resumption_key, session->resumption_key_len);
3823 p += session->resumption_key_len;
3824
3825#if defined(MBEDTLS_SSL_EARLY_DATA)
3826 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3827 p += 4;
3828#endif
3829#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3830 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3831 p += 2;
3832#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3833
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003834#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003835 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003836#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003837 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3838 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003839#endif /* MBEDTLS_HAVE_TIME */
3840
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003841#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003842 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3843 p += 2;
3844
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003845 if (alpn_len > 0) {
3846 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003847 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003848 p += alpn_len;
3849 }
3850#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3851 }
3852#endif /* MBEDTLS_SSL_SRV_C */
3853
David Horstmanne59f9702024-02-29 16:08:57 +00003854#if defined(MBEDTLS_SSL_CLI_C)
3855 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3856#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3857 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3858 p += 2;
3859 if (hostname_len > 0) {
3860 /* save host name */
3861 memcpy(p, session->hostname, hostname_len);
3862 p += hostname_len;
3863 }
3864#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3865
3866#if defined(MBEDTLS_HAVE_TIME)
3867 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3868 p += 8;
3869#endif
3870 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3871 p += 4;
3872
3873 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3874 p += 2;
3875
3876 if (session->ticket != NULL && session->ticket_len > 0) {
3877 memcpy(p, session->ticket, session->ticket_len);
3878 p += session->ticket_len;
3879 }
3880 }
3881#endif /* MBEDTLS_SSL_CLI_C */
3882 return 0;
3883}
3884
3885MBEDTLS_CHECK_RETURN_CRITICAL
3886static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3887 const unsigned char *buf,
3888 size_t len)
3889{
3890 const unsigned char *p = buf;
3891 const unsigned char *end = buf + len;
3892
3893 if (end - p < 6) {
3894 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3895 }
3896 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3897 session->ticket_flags = p[4];
3898
3899 /* load resumption_key */
3900 session->resumption_key_len = p[5];
3901 p += 6;
3902
3903 if (end - p < session->resumption_key_len) {
3904 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3905 }
3906
3907 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3908 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3909 }
3910 memcpy(session->resumption_key, p, session->resumption_key_len);
3911 p += session->resumption_key_len;
3912
3913#if defined(MBEDTLS_SSL_EARLY_DATA)
3914 if (end - p < 4) {
3915 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3916 }
3917 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3918 p += 4;
3919#endif
3920#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3921 if (end - p < 2) {
3922 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3923 }
3924 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3925 p += 2;
3926#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3927
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003928#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003929 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003930#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003931 if (end - p < 8) {
3932 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3933 }
3934 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3935 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003936#endif /* MBEDTLS_HAVE_TIME */
3937
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003938#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003939 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003940
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003941 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003942 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3943 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003944
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003945 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3946 p += 2;
3947
3948 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003949 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3950 }
3951
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003952 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003953 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3954 if (ret != 0) {
3955 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003956 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003957 p += alpn_len;
3958 }
3959#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3960 }
3961#endif /* MBEDTLS_SSL_SRV_C */
3962
David Horstmanne59f9702024-02-29 16:08:57 +00003963#if defined(MBEDTLS_SSL_CLI_C)
3964 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3965#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3966 size_t hostname_len;
3967 /* load host name */
3968 if (end - p < 2) {
3969 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3970 }
3971 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3972 p += 2;
3973
3974 if (end - p < (long int) hostname_len) {
3975 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3976 }
3977 if (hostname_len > 0) {
3978 session->hostname = mbedtls_calloc(1, hostname_len);
3979 if (session->hostname == NULL) {
3980 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3981 }
3982 memcpy(session->hostname, p, hostname_len);
3983 p += hostname_len;
3984 }
3985#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3986
3987#if defined(MBEDTLS_HAVE_TIME)
3988 if (end - p < 8) {
3989 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3990 }
3991 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
3992 p += 8;
3993#endif
3994 if (end - p < 4) {
3995 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3996 }
3997 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3998 p += 4;
3999
4000 if (end - p < 2) {
4001 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4002 }
4003 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
4004 p += 2;
4005
4006 if (end - p < (long int) session->ticket_len) {
4007 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4008 }
4009 if (session->ticket_len > 0) {
4010 session->ticket = mbedtls_calloc(1, session->ticket_len);
4011 if (session->ticket == NULL) {
4012 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4013 }
4014 memcpy(session->ticket, p, session->ticket_len);
4015 p += session->ticket_len;
4016 }
4017 }
4018#endif /* MBEDTLS_SSL_CLI_C */
4019
4020 return 0;
4021
4022}
4023#else /* MBEDTLS_SSL_SESSION_TICKETS */
4024MBEDTLS_CHECK_RETURN_CRITICAL
4025static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
4026 unsigned char *buf,
4027 size_t buf_len,
4028 size_t *olen)
4029{
4030 ((void) session);
4031 ((void) buf);
4032 ((void) buf_len);
4033 *olen = 0;
4034 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4035}
4036
4037static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01004038 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00004039 size_t buf_len)
4040{
4041 ((void) session);
4042 ((void) buf);
4043 ((void) buf_len);
4044 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4045}
4046#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
4047#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4048
Paul Bakker5121ce52009-01-03 21:22:43 +00004049/*
Hanno Beckera835da52019-05-16 12:39:07 +01004050 * Define ticket header determining Mbed TLS version
4051 * and structure of the ticket.
4052 */
4053
Hanno Becker94ef3b32019-05-16 12:50:45 +01004054/*
Hanno Becker50b59662019-05-28 14:30:45 +01004055 * Define bitflag determining compile-time settings influencing
4056 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01004057 */
4058
Hanno Becker50b59662019-05-28 14:30:45 +01004059#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01004060#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01004061#else
Hanno Becker3e088662019-05-29 11:10:18 +01004062#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004063#endif /* MBEDTLS_HAVE_TIME */
4064
4065#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004066#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004067#else
Hanno Becker3e088662019-05-29 11:10:18 +01004068#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004069#endif /* MBEDTLS_X509_CRT_PARSE_C */
4070
David Horstmann5c5a32f2024-02-13 17:53:35 +00004071#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00004072#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00004073#else
David Horstmannf686f1d2024-03-01 11:20:32 +00004074#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00004075#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4076
Hanno Becker94ef3b32019-05-16 12:50:45 +01004077#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004078#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004079#else
Hanno Becker3e088662019-05-29 11:10:18 +01004080#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004081#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4082
4083#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004084#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004085#else
Hanno Becker3e088662019-05-29 11:10:18 +01004086#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004087#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4088
Hanno Becker94ef3b32019-05-16 12:50:45 +01004089#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004090#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004091#else
Hanno Becker3e088662019-05-29 11:10:18 +01004092#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004093#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4094
Hanno Becker94ef3b32019-05-16 12:50:45 +01004095#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4096#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4097#else
4098#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4099#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4100
David Horstmann92b258b2024-02-13 17:23:34 +00004101#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4102#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
4103#else
4104#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
4105#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4106
4107#if defined(MBEDTLS_SSL_EARLY_DATA)
4108#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
4109#else
4110#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
4111#endif /* MBEDTLS_SSL_EARLY_DATA */
4112
4113#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4114#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
4115#else
4116#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
4117#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
4118
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004119#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
4120 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00004121#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
4122#else
4123#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
4124#endif /* MBEDTLS_SSL_ALPN */
4125
Hanno Becker3e088662019-05-29 11:10:18 +01004126#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4127#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4128#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4129#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004130#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4131#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00004132#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00004133#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
4134#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
4135#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00004136#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01004137
Hanno Becker50b59662019-05-28 14:30:45 +01004138#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004139 ((uint16_t) ( \
4140 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
4141 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
4142 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
4143 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
4144 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
4145 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00004146 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00004147 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
4148 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00004149 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
4150 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
4151 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
4152 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004153 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00004154 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004155 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01004156
Chien Wong4e9683e2023-12-28 17:07:43 +08004157static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004158 MBEDTLS_VERSION_MAJOR,
4159 MBEDTLS_VERSION_MINOR,
4160 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004161 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4162 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01004163};
Hanno Beckera835da52019-05-16 12:39:07 +01004164
4165/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004166 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004167 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004168 *
David Horstmanncb01b362024-02-29 17:31:46 +00004169 * TLS 1.2 session:
4170 *
4171 * struct {
4172 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
4173 * opaque ticket<0..2^24-1>; // length 0 means no ticket
4174 * uint32 ticket_lifetime;
4175 * #endif
4176 * } ClientOnlyData;
4177 *
4178 * struct {
4179 * #if defined(MBEDTLS_HAVE_TIME)
4180 * uint64 start_time;
4181 * #endif
4182 * uint8 session_id_len; // at most 32
4183 * opaque session_id[32];
4184 * opaque master[48]; // fixed length in the standard
4185 * uint32 verify_result;
4186 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
4187 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
4188 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00004189 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00004190 * opaque peer_cert_digest<0..2^8-1>
4191 * #endif
4192 * select (endpoint) {
4193 * case client: ClientOnlyData;
4194 * case server: uint64 ticket_creation_time;
4195 * };
4196 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4197 * uint8 mfl_code; // up to 255 according to standard
4198 * #endif
4199 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4200 * uint8 encrypt_then_mac; // 0 or 1
4201 * #endif
4202 * } serialized_session_tls12;
4203 *
4204 *
4205 * TLS 1.3 Session:
4206 *
4207 * struct {
4208 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4209 * opaque hostname<0..2^16-1>;
4210 * #endif
4211 * #if defined(MBEDTLS_HAVE_TIME)
4212 * uint64 ticket_reception_time;
4213 * #endif
4214 * uint32 ticket_lifetime;
4215 * opaque ticket<1..2^16-1>;
4216 * } ClientOnlyData;
4217 *
4218 * struct {
4219 * uint32 ticket_age_add;
4220 * uint8 ticket_flags;
4221 * opaque resumption_key<0..255>;
4222 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4223 * uint32 max_early_data_size;
4224 * #endif
4225 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4226 * uint16 record_size_limit;
4227 * #endif
4228 * select ( endpoint ) {
4229 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004230 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00004231 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004232 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00004233 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004234 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004235 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00004236 * #endif
4237 * };
4238 * } serialized_session_tls13;
4239 *
4240 *
4241 * SSL session:
4242 *
4243 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004244 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004245 * opaque mbedtls_version[3]; // library version: major, minor, patch
4246 * opaque session_format[2]; // library-version specific 16-bit field
4247 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004248 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004249 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004250 * Note: When updating the format, remember to keep
4251 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004252 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004253 * // In this version, `session_format` determines
4254 * // the setting of those compile-time
4255 * // configuration options which influence
4256 * // the structure of mbedtls_ssl_session.
4257 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004258 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004259 * // - TLS 1.2 (0x0303)
4260 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004261 * uint8_t endpoint;
4262 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004263 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004264 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004265 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004266 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004267 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004268 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004269 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004270 *
4271 * };
4272 *
4273 * } serialized_session;
4274 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004275 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004276
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004277MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004278static int ssl_session_save(const mbedtls_ssl_session *session,
4279 unsigned char omit_header,
4280 unsigned char *buf,
4281 size_t buf_len,
4282 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004283{
4284 unsigned char *p = buf;
4285 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004286 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004287#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4288 size_t out_len;
4289 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4290#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004291 if (session == NULL) {
4292 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4293 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004294
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004296 /*
4297 * Add Mbed TLS version identifier
4298 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004299 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004300
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 if (used <= buf_len) {
4302 memcpy(p, ssl_serialized_session_header,
4303 sizeof(ssl_serialized_session_header));
4304 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004305 }
4306 }
4307
4308 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004309 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004310 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004311 used += 1 /* TLS version */
4312 + 1 /* endpoint */
4313 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004314 if (used <= buf_len) {
4315 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004316 *p++ = session->endpoint;
4317 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4318 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004319 }
4320
4321 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004322 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004324#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004325 case MBEDTLS_SSL_VERSION_TLS1_2:
4326 used += ssl_tls12_session_save(session, p, remaining_len);
4327 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004328#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4329
Jerry Yu251a12e2022-07-13 15:15:48 +08004330#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004331 case MBEDTLS_SSL_VERSION_TLS1_3:
4332 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4333 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4334 return ret;
4335 }
4336 used += out_len;
4337 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004338#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4339
Gilles Peskine449bd832023-01-11 14:50:10 +01004340 default:
4341 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004342 }
4343
4344 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004345 if (used > buf_len) {
4346 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4347 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004348
Gilles Peskine449bd832023-01-11 14:50:10 +01004349 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004350}
4351
4352/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004353 * Public wrapper for ssl_session_save()
4354 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004355int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4356 unsigned char *buf,
4357 size_t buf_len,
4358 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004359{
Gilles Peskine449bd832023-01-11 14:50:10 +01004360 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004361}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004362
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004363/*
4364 * Deserialize session, see mbedtls_ssl_session_save() for format.
4365 *
4366 * This internal version is wrapped by a public function that cleans up in
4367 * case of error, and has an extra option omit_header.
4368 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004369MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004370static int ssl_session_load(mbedtls_ssl_session *session,
4371 unsigned char omit_header,
4372 const unsigned char *buf,
4373 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004374{
4375 const unsigned char *p = buf;
4376 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004377 size_t remaining_len;
4378
4379
Gilles Peskine449bd832023-01-11 14:50:10 +01004380 if (session == NULL) {
4381 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4382 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004383
Gilles Peskine449bd832023-01-11 14:50:10 +01004384 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004385 /*
4386 * Check Mbed TLS version identifier
4387 */
4388
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4390 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004391 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004392
4393 if (memcmp(p, ssl_serialized_session_header,
4394 sizeof(ssl_serialized_session_header)) != 0) {
4395 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4396 }
4397 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004398 }
4399
4400 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004401 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004402 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004403 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004404 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4405 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004406 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004407 session->endpoint = *p++;
4408 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4409 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004410
4411 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004412 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004414#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004415 case MBEDTLS_SSL_VERSION_TLS1_2:
4416 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004417#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4418
Jerry Yu438ddd82022-07-07 06:55:50 +00004419#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004420 case MBEDTLS_SSL_VERSION_TLS1_3:
4421 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004422#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4423
Gilles Peskine449bd832023-01-11 14:50:10 +01004424 default:
4425 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004426 }
4427}
4428
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004429/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004430 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004431 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004432int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4433 const unsigned char *buf,
4434 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004435{
Gilles Peskine449bd832023-01-11 14:50:10 +01004436 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004437
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 if (ret != 0) {
4439 mbedtls_ssl_session_free(session);
4440 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004441
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004443}
4444
4445/*
Paul Bakker1961b702013-01-25 14:49:24 +01004446 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004447 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004448MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004449static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004450{
4451 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4452
Ronald Cron66dbf912022-02-02 15:33:46 +01004453 /*
4454 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004455 * that were written into the output buffer by the previous handshake step,
4456 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004457 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4458 * We proceed to the next handshake step only when all data from the
4459 * previous one have been sent to the peer, thus we make sure that this is
4460 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4461 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4462 * we have to wait before to go ahead.
4463 * In the case of TLS 1.3, handshake step handlers do not send data to the
4464 * peer. Data are only sent here and through
4465 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004466 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004467 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004468 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4469 return ret;
4470 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004471
4472#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4474 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4475 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4476 return ret;
4477 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004478 }
4479#endif /* MBEDTLS_SSL_PROTO_DTLS */
4480
Gilles Peskine449bd832023-01-11 14:50:10 +01004481 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004482}
4483
Gilles Peskine449bd832023-01-11 14:50:10 +01004484int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004485{
Hanno Becker41934dd2021-08-07 19:13:43 +01004486 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004487
Gilles Peskine449bd832023-01-11 14:50:10 +01004488 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004489 ssl->conf == NULL ||
4490 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004491 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4492 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004493 }
4494
Gilles Peskine449bd832023-01-11 14:50:10 +01004495 ret = ssl_prepare_handshake_step(ssl);
4496 if (ret != 0) {
4497 return ret;
4498 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004499
Gilles Peskine449bd832023-01-11 14:50:10 +01004500 ret = mbedtls_ssl_handle_pending_alert(ssl);
4501 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004502 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 }
Jerry Yue7047812021-09-13 19:26:39 +08004504
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004505 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4506 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4507 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4508
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004509#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004510 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4511 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004512 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004513
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004515 case MBEDTLS_SSL_HELLO_REQUEST:
4516 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004517 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004518 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004519
Ronald Cron9f0fba32022-02-10 16:45:15 +01004520 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004522 break;
4523
4524 default:
4525#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004526 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4527 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4528 } else {
4529 ret = mbedtls_ssl_handshake_client_step(ssl);
4530 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004531#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004533#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004535#endif
4536 }
Jerry Yub9930e72021-08-06 17:11:51 +08004537 }
Ronald Cron6291b232023-03-08 15:51:25 +01004538#endif /* MBEDTLS_SSL_CLI_C */
4539
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004540#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004541 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004542#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4543 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004545 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004546 ret = mbedtls_ssl_handshake_server_step(ssl);
4547 }
Ronald Cron6291b232023-03-08 15:51:25 +01004548#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4549 ret = mbedtls_ssl_handshake_server_step(ssl);
4550#else
4551 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004552#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004553 }
4554#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004555
Gilles Peskine449bd832023-01-11 14:50:10 +01004556 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004557 /* handshake_step return error. And it is same
4558 * with alert_reason.
4559 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004560 if (ssl->send_alert) {
4561 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004562 goto cleanup;
4563 }
4564 }
4565
4566cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004568}
4569
4570/*
4571 * Perform the SSL handshake
4572 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004573int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004574{
4575 int ret = 0;
4576
Hanno Beckera817ea42020-10-20 15:20:23 +01004577 /* Sanity checks */
4578
Gilles Peskine449bd832023-01-11 14:50:10 +01004579 if (ssl == NULL || ssl->conf == NULL) {
4580 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4581 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004582
Hanno Beckera817ea42020-10-20 15:20:23 +01004583#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4585 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4586 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4587 "mbedtls_ssl_set_timer_cb() for DTLS"));
4588 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004589 }
4590#endif /* MBEDTLS_SSL_PROTO_DTLS */
4591
Gilles Peskine449bd832023-01-11 14:50:10 +01004592 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004593
Hanno Beckera817ea42020-10-20 15:20:23 +01004594 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4596 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004597
Gilles Peskine449bd832023-01-11 14:50:10 +01004598 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004599 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004600 }
Paul Bakker1961b702013-01-25 14:49:24 +01004601 }
4602
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004604
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004606}
4607
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004608#if defined(MBEDTLS_SSL_RENEGOTIATION)
4609#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004610/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004611 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004612 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004613MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004614static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004615{
Janos Follath865b3eb2019-12-16 11:46:15 +00004616 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004617
Gilles Peskine449bd832023-01-11 14:50:10 +01004618 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004619
4620 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004621 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4622 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004623
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4625 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4626 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004627 }
4628
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004630
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004632}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004633#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004634
4635/*
4636 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004637 * - any side: calling mbedtls_ssl_renegotiate(),
4638 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4639 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004640 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004641 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004642 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004643 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004644int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004645{
Janos Follath865b3eb2019-12-16 11:46:15 +00004646 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004647
Gilles Peskine449bd832023-01-11 14:50:10 +01004648 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004649
Gilles Peskine449bd832023-01-11 14:50:10 +01004650 if ((ret = ssl_handshake_init(ssl)) != 0) {
4651 return ret;
4652 }
Paul Bakker48916f92012-09-16 19:57:18 +00004653
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004654 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4655 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004656#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4658 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4659 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004660 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004662 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004663 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004664 }
4665#endif
4666
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004667 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4668 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004669
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4671 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4672 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004673 }
4674
Gilles Peskine449bd832023-01-11 14:50:10 +01004675 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004676
Gilles Peskine449bd832023-01-11 14:50:10 +01004677 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004678}
4679
4680/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004681 * Renegotiate current connection on client,
4682 * or request renegotiation on server
4683 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004684int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004685{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004686 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004687
Gilles Peskine449bd832023-01-11 14:50:10 +01004688 if (ssl == NULL || ssl->conf == NULL) {
4689 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4690 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004691
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004692#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004693 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004694 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4695 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4696 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4697 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004698
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004699 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004700
4701 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004702 if (ssl->out_left != 0) {
4703 return mbedtls_ssl_flush_output(ssl);
4704 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004705
Gilles Peskine449bd832023-01-11 14:50:10 +01004706 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004707 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004708#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004709
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004710#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004711 /*
4712 * On client, either start the renegotiation process or,
4713 * if already in progress, continue the handshake
4714 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004715 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4716 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4717 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004718 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004719
4720 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4721 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4722 return ret;
4723 }
4724 } else {
4725 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4726 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4727 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004728 }
4729 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004730#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004731
Gilles Peskine449bd832023-01-11 14:50:10 +01004732 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004733}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004734#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004735
Gilles Peskine449bd832023-01-11 14:50:10 +01004736void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004737{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004738 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4739
Gilles Peskine449bd832023-01-11 14:50:10 +01004740 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004741 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004742 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004743
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004744#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Brett Warrene0edc842021-08-17 09:53:13 +01004745#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004746 if (ssl->handshake->group_list_heap_allocated) {
4747 mbedtls_free((void *) handshake->group_list);
4748 }
Brett Warrene0edc842021-08-17 09:53:13 +01004749 handshake->group_list = NULL;
4750#endif /* MBEDTLS_DEPRECATED_REMOVED */
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004751#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Brett Warrene0edc842021-08-17 09:53:13 +01004752
Ronald Crone68ab4f2022-10-05 12:46:29 +02004753#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004754#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 if (ssl->handshake->sig_algs_heap_allocated) {
4756 mbedtls_free((void *) handshake->sig_algs);
4757 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004758 handshake->sig_algs = NULL;
4759#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004760#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004761 if (ssl->handshake->certificate_request_context) {
4762 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004763 }
4764#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004765#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004766
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004767#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004768 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4769 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004770 handshake->async_in_progress = 0;
4771 }
4772#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4773
Elena Uziunaite0916cd72024-05-23 17:01:07 +01004774#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004775#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004776 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004777#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004778 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004779#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004780#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01004781#if defined(PSA_WANT_ALG_SHA_384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004782#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004783 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004784#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004785 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004786#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004787#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004788
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004789#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004790 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004791#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004792#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004793 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004795#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004796
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004797#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004798#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004800 /*
4801 * Opaque keys are not stored in the handshake's data and it's the user
4802 * responsibility to destroy them. Clear ones, instead, are created by
4803 * the TLS library and should be destroyed at the same level
4804 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4806 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004807 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004808 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4809#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004811#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004812#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004814 handshake->ecjpake_cache = NULL;
4815 handshake->ecjpake_cache_len = 0;
4816#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004817#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004818
Valerio Setti7aeec542023-07-05 18:57:21 +02004819#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004820 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004821 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004822 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004824#endif
4825
Ronald Cron73fe8df2022-10-05 14:31:43 +02004826#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004827#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004828 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004829 /* The maintenance of the external PSK key slot is the
4830 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 if (ssl->handshake->psk_opaque_is_internal) {
4832 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004833 ssl->handshake->psk_opaque_is_internal = 0;
4834 }
4835 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4836 }
Neil Armstronge952a302022-05-03 10:22:14 +02004837#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004838 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004839 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004840 }
Neil Armstronge952a302022-05-03 10:22:14 +02004841#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004842#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004843
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004844#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4845 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004846 /*
4847 * Free only the linked list wrapper, not the keys themselves
4848 * since the belong to the SNI callback
4849 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004851#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004852
Gilles Peskineeccd8882020-03-10 12:19:08 +01004853#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4855 if (handshake->ecrs_peer_cert != NULL) {
4856 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4857 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004858 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004859#endif
4860
Hanno Becker75173122019-02-06 16:18:31 +00004861#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4862 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004863 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004864#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4865
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004866#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004867 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4868 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004869#endif /* MBEDTLS_SSL_CLI_C &&
4870 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004871
4872#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 mbedtls_ssl_flight_free(handshake->flight);
4874 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004875#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004876
Valerio Settiea59c432023-07-25 11:14:03 +02004877#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004878 if (handshake->xxdh_psa_privkey_is_external == 0) {
4879 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004880 }
Valerio Settiea59c432023-07-25 11:14:03 +02004881#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004882
Ronald Cron6f135e12021-12-08 16:57:54 +01004883#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004884 mbedtls_ssl_transform_free(handshake->transform_handshake);
4885 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004886#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4888 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004889#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004890#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004891
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004892
4893#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4894 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4895 * processes datagrams and the fact that a datagram is allowed to have
4896 * several records in it, it is possible that the I/O buffers are not
4897 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004898 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4899 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004900#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004901
Jerry Yuba9c7272021-10-30 11:54:10 +08004902 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004903 mbedtls_platform_zeroize(handshake,
4904 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004905}
4906
Gilles Peskine449bd832023-01-11 14:50:10 +01004907void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004908{
Gilles Peskine449bd832023-01-11 14:50:10 +01004909 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004910 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004911 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004912
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004913#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004914 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004915#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004916
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004917#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004918#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4919 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004920 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004921#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004922 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004923#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004924
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004925#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4926 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004927 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004928#endif
4929
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004931}
4932
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004933#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004934
4935#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4936#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4937#else
4938#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4939#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4940
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004941#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004942
4943#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4944#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4945#else
4946#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4947#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4948
4949#if defined(MBEDTLS_SSL_ALPN)
4950#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4951#else
4952#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4953#endif /* MBEDTLS_SSL_ALPN */
4954
4955#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4956#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4957#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4958#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4959
4960#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004961 ((uint32_t) ( \
4962 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4963 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4964 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4965 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4966 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4967 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4968 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4969 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004970
Chien Wong4e9683e2023-12-28 17:07:43 +08004971static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004972 MBEDTLS_VERSION_MAJOR,
4973 MBEDTLS_VERSION_MINOR,
4974 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004975 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4976 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4977 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4978 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4979 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004980};
4981
Paul Bakker5121ce52009-01-03 21:22:43 +00004982/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004983 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004984 *
4985 * The format of the serialized data is:
4986 * (in the presentation language of TLS, RFC 8446 section 3)
4987 *
4988 * // header
4989 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004990 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004991 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004992 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004993 * Note: When updating the format, remember to keep these
4994 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004995 *
4996 * // session sub-structure
4997 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
4998 * // transform sub-structure
4999 * uint8 random[64]; // ServerHello.random+ClientHello.random
5000 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
5001 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
5002 * // fields from ssl_context
5003 * uint32 badmac_seen; // DTLS: number of records with failing MAC
5004 * uint64 in_window_top; // DTLS: last validated record seq_num
5005 * uint64 in_window; // DTLS: bitmask for replay protection
5006 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
5007 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
5008 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
5009 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
5010 *
5011 * Note that many fields of the ssl_context or sub-structures are not
5012 * serialized, as they fall in one of the following categories:
5013 *
5014 * 1. forced value (eg in_left must be 0)
5015 * 2. pointer to dynamically-allocated memory (eg session, transform)
5016 * 3. value can be re-derived from other data (eg session keys from MS)
5017 * 4. value was temporary (eg content of input buffer)
5018 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005019 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005020int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5021 unsigned char *buf,
5022 size_t buf_len,
5023 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005024{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005025 unsigned char *p = buf;
5026 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005027 size_t session_len;
5028 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005029
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005030 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005031 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
5032 * this function's documentation.
5033 *
5034 * These are due to assumptions/limitations in the implementation. Some of
5035 * them are likely to stay (no handshake in progress) some might go away
5036 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005037 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005038 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01005039 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
5040 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
5041 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005042 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005043 if (ssl->handshake != NULL) {
5044 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
5045 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005046 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005047 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01005048 if (ssl->transform == NULL || ssl->session == NULL) {
5049 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
5050 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005051 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005052 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01005053 if (mbedtls_ssl_check_pending(ssl) != 0) {
5054 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
5055 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005056 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005057 if (ssl->out_left != 0) {
5058 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
5059 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005060 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00005061 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5063 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
5064 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005065 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005066 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005067 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
5068 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
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 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01005072 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
5073 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
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 /* Renegotiation must not be enabled */
5077#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005078 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5079 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
5080 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005081 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005082#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005083
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005084 /*
5085 * Version and format identifier
5086 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005087 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005088
Gilles Peskine449bd832023-01-11 14:50:10 +01005089 if (used <= buf_len) {
5090 memcpy(p, ssl_serialized_context_header,
5091 sizeof(ssl_serialized_context_header));
5092 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005093 }
5094
5095 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005096 * Session (length + data)
5097 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005098 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
5099 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
5100 return ret;
5101 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005102
5103 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005104 if (used <= buf_len) {
5105 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005106 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005107
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 ret = ssl_session_save(ssl->session, 1,
5109 p, session_len, &session_len);
5110 if (ret != 0) {
5111 return ret;
5112 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005113
5114 p += session_len;
5115 }
5116
5117 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005118 * Transform
5119 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005120 used += sizeof(ssl->transform->randbytes);
5121 if (used <= buf_len) {
5122 memcpy(p, ssl->transform->randbytes,
5123 sizeof(ssl->transform->randbytes));
5124 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005125 }
5126
5127#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005128 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005129 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005130 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005131 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005132 p += ssl->transform->in_cid_len;
5133
5134 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005135 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005136 p += ssl->transform->out_cid_len;
5137 }
5138#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5139
5140 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005141 * Saved fields from top-level ssl_context structure
5142 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005143 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 if (used <= buf_len) {
5145 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005146 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005147 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005148
5149#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5150 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01005151 if (used <= buf_len) {
5152 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005153 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005154
Gilles Peskine449bd832023-01-11 14:50:10 +01005155 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005156 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005157 }
5158#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5159
5160#if defined(MBEDTLS_SSL_PROTO_DTLS)
5161 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005163 *p++ = ssl->disable_datagram_packing;
5164 }
5165#endif /* MBEDTLS_SSL_PROTO_DTLS */
5166
Jerry Yuae0b2e22021-10-08 15:21:19 +08005167 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 if (used <= buf_len) {
5169 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08005170 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005171 }
5172
5173#if defined(MBEDTLS_SSL_PROTO_DTLS)
5174 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 if (used <= buf_len) {
5176 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005177 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005178 }
5179#endif /* MBEDTLS_SSL_PROTO_DTLS */
5180
5181#if defined(MBEDTLS_SSL_ALPN)
5182 {
5183 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01005184 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005185 : 0;
5186
5187 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005188 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005189 *p++ = alpn_len;
5190
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 if (ssl->alpn_chosen != NULL) {
5192 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005193 p += alpn_len;
5194 }
5195 }
5196 }
5197#endif /* MBEDTLS_SSL_ALPN */
5198
5199 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005200 * Done
5201 */
5202 *olen = used;
5203
Gilles Peskine449bd832023-01-11 14:50:10 +01005204 if (used > buf_len) {
5205 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
5206 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005207
Gilles Peskine449bd832023-01-11 14:50:10 +01005208 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005209
Gilles Peskine449bd832023-01-11 14:50:10 +01005210 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005211}
5212
5213/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005214 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005215 *
5216 * This internal version is wrapped by a public function that cleans up in
5217 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005218 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005219MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005220static int ssl_context_load(mbedtls_ssl_context *ssl,
5221 const unsigned char *buf,
5222 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005223{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005224 const unsigned char *p = buf;
5225 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005226 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005227 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005228#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04005229 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005230#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005231
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005232 /*
5233 * The context should have been freshly setup or reset.
5234 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005235 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005236 * renegotiating, or if the user mistakenly loaded a session first.)
5237 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005238 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5239 ssl->session != NULL) {
5240 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005241 }
5242
5243 /*
5244 * We can't check that the config matches the initial one, but we can at
5245 * least check it matches the requirements for serializing.
5246 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005247 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005248#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005249 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005250#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005251 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5252 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5253 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5254 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005255 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005256 }
5257
Gilles Peskine449bd832023-01-11 14:50:10 +01005258 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005259
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005260 /*
5261 * Check version identifier
5262 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005263 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5264 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005265 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005266
5267 if (memcmp(p, ssl_serialized_context_header,
5268 sizeof(ssl_serialized_context_header)) != 0) {
5269 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5270 }
5271 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005272
5273 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005274 * Session
5275 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005276 if ((size_t) (end - p) < 4) {
5277 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5278 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005279
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005280 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005281 p += 4;
5282
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005283 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005284 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005285 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005286 ssl->session_in = ssl->session;
5287 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005288 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005289
Gilles Peskine449bd832023-01-11 14:50:10 +01005290 if ((size_t) (end - p) < session_len) {
5291 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5292 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005293
Gilles Peskine449bd832023-01-11 14:50:10 +01005294 ret = ssl_session_load(ssl->session, 1, p, session_len);
5295 if (ret != 0) {
5296 mbedtls_ssl_session_free(ssl->session);
5297 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005298 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005299
5300 p += session_len;
5301
5302 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005303 * Transform
5304 */
5305
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005306 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005307 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005308#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005309 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005310 ssl->transform_in = ssl->transform;
5311 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005312 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005313#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005314
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005315#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005316 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5317 if (prf_func == NULL) {
5318 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5319 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005320
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005321 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005322 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5323 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5324 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005325
Gilles Peskine449bd832023-01-11 14:50:10 +01005326 ret = ssl_tls12_populate_transform(ssl->transform,
5327 ssl->session->ciphersuite,
5328 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005329#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005330 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005331#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005332 prf_func,
5333 p, /* currently pointing to randbytes */
5334 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5335 ssl->conf->endpoint,
5336 ssl);
5337 if (ret != 0) {
5338 return ret;
5339 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005340#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005341 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005342
5343#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5344 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005345 if ((size_t) (end - p) < 1) {
5346 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5347 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005348
5349 ssl->transform->in_cid_len = *p++;
5350
Gilles Peskine449bd832023-01-11 14:50:10 +01005351 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5352 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5353 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005354
Gilles Peskine449bd832023-01-11 14:50:10 +01005355 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005356 p += ssl->transform->in_cid_len;
5357
5358 ssl->transform->out_cid_len = *p++;
5359
Gilles Peskine449bd832023-01-11 14:50:10 +01005360 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5361 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5362 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005363
Gilles Peskine449bd832023-01-11 14:50:10 +01005364 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005365 p += ssl->transform->out_cid_len;
5366#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5367
5368 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005369 * Saved fields from top-level ssl_context structure
5370 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005371 if ((size_t) (end - p) < 4) {
5372 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5373 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005374
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005375 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005376 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005377
5378#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005379 if ((size_t) (end - p) < 16) {
5380 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5381 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005382
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005383 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005384 p += 8;
5385
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005386 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005387 p += 8;
5388#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5389
5390#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005391 if ((size_t) (end - p) < 1) {
5392 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5393 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005394
5395 ssl->disable_datagram_packing = *p++;
5396#endif /* MBEDTLS_SSL_PROTO_DTLS */
5397
Gilles Peskine449bd832023-01-11 14:50:10 +01005398 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5399 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5400 }
5401 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5402 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005403
5404#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 if ((size_t) (end - p) < 2) {
5406 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5407 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005408
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005409 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005410 p += 2;
5411#endif /* MBEDTLS_SSL_PROTO_DTLS */
5412
5413#if defined(MBEDTLS_SSL_ALPN)
5414 {
5415 uint8_t alpn_len;
5416 const char **cur;
5417
Gilles Peskine449bd832023-01-11 14:50:10 +01005418 if ((size_t) (end - p) < 1) {
5419 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5420 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005421
5422 alpn_len = *p++;
5423
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005425 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005426 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5427 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005428 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005429 ssl->alpn_chosen = *cur;
5430 break;
5431 }
5432 }
5433 }
5434
5435 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005436 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5437 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5438 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005439
5440 p += alpn_len;
5441 }
5442#endif /* MBEDTLS_SSL_ALPN */
5443
5444 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005445 * Forced fields from top-level ssl_context structure
5446 *
5447 * Most of them already set to the correct value by mbedtls_ssl_init() and
5448 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5449 */
5450 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005451 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005452
Hanno Becker361b10d2019-08-30 10:42:49 +01005453 /* Adjust pointers for header fields of outgoing records to
5454 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005455 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005456
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005457#if defined(MBEDTLS_SSL_PROTO_DTLS)
5458 ssl->in_epoch = 1;
5459#endif
5460
5461 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5462 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005463 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5464 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005465 if (ssl->handshake != NULL) {
5466 mbedtls_ssl_handshake_free(ssl);
5467 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005468 ssl->handshake = NULL;
5469 }
5470
5471 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005472 * Done - should have consumed entire buffer
5473 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005474 if (p != end) {
5475 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5476 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005477
Gilles Peskine449bd832023-01-11 14:50:10 +01005478 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005479}
5480
5481/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005482 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005483 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005484int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5485 const unsigned char *buf,
5486 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005487{
Gilles Peskine449bd832023-01-11 14:50:10 +01005488 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005489
Gilles Peskine449bd832023-01-11 14:50:10 +01005490 if (ret != 0) {
5491 mbedtls_ssl_free(context);
5492 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005493
Gilles Peskine449bd832023-01-11 14:50:10 +01005494 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005495}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005496#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005497
5498/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005499 * Free an SSL context
5500 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005501void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005502{
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005504 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005505 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005506
Gilles Peskine449bd832023-01-11 14:50:10 +01005507 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005508
Gilles Peskine449bd832023-01-11 14:50:10 +01005509 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005510#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5511 size_t out_buf_len = ssl->out_buf_len;
5512#else
5513 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5514#endif
5515
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005516 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005517 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005518 }
5519
Gilles Peskine449bd832023-01-11 14:50:10 +01005520 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005521#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5522 size_t in_buf_len = ssl->in_buf_len;
5523#else
5524 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5525#endif
5526
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005527 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005528 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005529 }
5530
Gilles Peskine449bd832023-01-11 14:50:10 +01005531 if (ssl->transform) {
5532 mbedtls_ssl_transform_free(ssl->transform);
5533 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005534 }
5535
Gilles Peskine449bd832023-01-11 14:50:10 +01005536 if (ssl->handshake) {
5537 mbedtls_ssl_handshake_free(ssl);
5538 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005539
5540#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005541 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5542 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005543#endif
5544
Gilles Peskine449bd832023-01-11 14:50:10 +01005545 mbedtls_ssl_session_free(ssl->session_negotiate);
5546 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005547 }
5548
Ronald Cron6f135e12021-12-08 16:57:54 +01005549#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005550 mbedtls_ssl_transform_free(ssl->transform_application);
5551 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005552#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005553
Gilles Peskine449bd832023-01-11 14:50:10 +01005554 if (ssl->session) {
5555 mbedtls_ssl_session_free(ssl->session);
5556 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005557 }
5558
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005559#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005560 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005561 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005562 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005563#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005564
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005565#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005566 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005567#endif
5568
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005570
Paul Bakker86f04f42013-02-14 11:20:09 +01005571 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005572 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005573}
5574
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005575/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005576 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005577 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005578void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005579{
Gilles Peskine449bd832023-01-11 14:50:10 +01005580 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005581}
5582
Gilles Peskineae270bf2021-06-02 00:05:29 +02005583/* The selection should be the same as mbedtls_x509_crt_profile_default in
5584 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005585 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005586 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005587 * about this list.
5588 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005589static const uint16_t ssl_preset_default_groups[] = {
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005590#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Brett Warrene0edc842021-08-17 09:53:13 +01005591 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005592#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005593#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005594 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005595#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005596#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005597 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005598#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005599#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Brett Warrene0edc842021-08-17 09:53:13 +01005600 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005601#endif
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005602#if defined(PSA_WANT_ECC_SECP_R1_521)
Brett Warrene0edc842021-08-17 09:53:13 +01005603 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005604#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005605#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005606 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005607#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005608#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005609 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005610#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005611#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Brett Warrene0edc842021-08-17 09:53:13 +01005612 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005613#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005614#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005615 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5616 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5617 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5618 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5619 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5620#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005621 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005622};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005623
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005624static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005625 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5626 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5627 0
5628};
5629
Ronald Crone68ab4f2022-10-05 12:46:29 +02005630#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005631
Jerry Yu909df7b2022-01-22 11:56:27 +08005632/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005633 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005634 * rules SHOULD be upheld.
5635 * - No duplicate entries.
5636 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005637 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005638 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005639 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005640static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005641
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005642#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005643 defined(PSA_WANT_ALG_SHA_256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005644 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005645 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005646 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5647#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005648
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005649#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005650 defined(PSA_WANT_ALG_SHA_384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005651 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005652 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005653 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5654#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005655
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005656#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Gabor Mezeic15ef932024-06-13 12:53:54 +02005657 defined(PSA_WANT_ALG_SHA_512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005658 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005659 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005660 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5661#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005662
Gabor Mezeic15ef932024-06-13 12:53:54 +02005663#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005664 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005665#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005666
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005667#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005668 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005669#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005670
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005671#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005672 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005673#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005674
Gabor Mezeic15ef932024-06-13 12:53:54 +02005675#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005676 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Gabor Mezeic15ef932024-06-13 12:53:54 +02005677#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005678
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005679#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005680 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005681#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005682
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005683#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005684 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005685#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005686
Gabor Mezei15b95a62022-05-09 16:37:58 +02005687 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005688};
5689
5690/* NOTICE: see above */
5691#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5692static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005693
Gabor Mezeic15ef932024-06-13 12:53:54 +02005694#if defined(PSA_WANT_ALG_SHA_512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005695#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005696 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005697#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005698#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5699 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005700#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005701#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005702 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005703#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005704#endif /* PSA_WANT_ALG_SHA_512 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005705
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005706#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005707#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005708 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005709#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005710#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5711 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005712#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005713#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005714 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005715#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005716#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005717
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005718#if defined(PSA_WANT_ALG_SHA_256)
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_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +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_SHA256,
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_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005727#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005728#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005729
Gabor Mezei15b95a62022-05-09 16:37:58 +02005730 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005731};
5732#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005733
Jerry Yu909df7b2022-01-22 11:56:27 +08005734/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005735static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005736
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005737#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005738 defined(PSA_WANT_ALG_SHA_256) && \
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005739 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005740 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005741 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5742#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005743
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005744#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005745 defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005746 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu53037892022-01-25 11:02:06 +08005747 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005748 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5749#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005750
Gabor Mezei15b95a62022-05-09 16:37:58 +02005751 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005752};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005753
Jerry Yu909df7b2022-01-22 11:56:27 +08005754/* NOTICE: see above */
5755#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5756static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005757
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005758#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005759#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005760 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005761#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005762#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005763
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005764#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005765#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005766 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005767#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005768#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005769
Gabor Mezei15b95a62022-05-09 16:37:58 +02005770 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005771};
Jerry Yu909df7b2022-01-22 11:56:27 +08005772#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5773
Ronald Crone68ab4f2022-10-05 12:46:29 +02005774#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005775
Chien Wong4e9683e2023-12-28 17:07:43 +08005776static const uint16_t ssl_preset_suiteb_groups[] = {
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005777#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005778 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005779#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005780#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005781 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005782#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005783 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005784};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005785
Ronald Crone68ab4f2022-10-05 12:46:29 +02005786#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005787/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005788 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005789MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005790static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005791{
5792 size_t i, j;
5793 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005794
Gilles Peskine449bd832023-01-11 14:50:10 +01005795 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5796 for (j = 0; j < i; j++) {
5797 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005798 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005799 }
5800 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5801 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5802 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005803 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005804 }
5805 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005806 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005807}
5808
Ronald Crone68ab4f2022-10-05 12:46:29 +02005809#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005810
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005811/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005812 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005813 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005814int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5815 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005816{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005817#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005818 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005819#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005820
Ronald Crone68ab4f2022-10-05 12:46:29 +02005821#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005822 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5823 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5824 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005825 }
5826
Gilles Peskine449bd832023-01-11 14:50:10 +01005827 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5828 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5829 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005830 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005831
5832#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005833 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5834 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5835 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005836 }
5837
Gilles Peskine449bd832023-01-11 14:50:10 +01005838 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5839 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5840 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005841 }
5842#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005843#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005844
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005845 /* Use the functions here so that they are covered in tests,
5846 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005847 mbedtls_ssl_conf_endpoint(conf, endpoint);
5848 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005849
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005850 /*
5851 * Things that are common to all presets
5852 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005853#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005854 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005855 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5856#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5857 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5858#endif
5859 }
5860#endif
5861
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005862#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5863 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5864#endif
5865
5866#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5867 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5868#endif
5869
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005870#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005871 conf->f_cookie_write = ssl_cookie_write_dummy;
5872 conf->f_cookie_check = ssl_cookie_check_dummy;
5873#endif
5874
5875#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5876 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5877#endif
5878
Janos Follath088ce432017-04-10 12:42:31 +01005879#if defined(MBEDTLS_SSL_SRV_C)
5880 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005881 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005882#endif
5883
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005884#if defined(MBEDTLS_SSL_PROTO_DTLS)
5885 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5886 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5887#endif
5888
5889#if defined(MBEDTLS_SSL_RENEGOTIATION)
5890 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005891 memset(conf->renego_period, 0x00, 2);
5892 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005893#endif
5894
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005895#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005896 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005897 const unsigned char dhm_p[] =
5898 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5899 const unsigned char dhm_g[] =
5900 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005901
Gilles Peskine449bd832023-01-11 14:50:10 +01005902 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5903 dhm_p, sizeof(dhm_p),
5904 dhm_g, sizeof(dhm_g))) != 0) {
5905 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005906 }
5907 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005908#endif
5909
Ronald Cron6f135e12021-12-08 16:57:54 +01005910#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005911
5912#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005913 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005914#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005915 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005916#endif
5917#endif /* MBEDTLS_SSL_EARLY_DATA */
5918
Jerry Yud0766ec2022-09-22 10:46:57 +08005919#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005920 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005921 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005922#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005923 /*
5924 * Allow all TLS 1.3 key exchange modes by default.
5925 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005926 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005927#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005928
Gilles Peskine449bd832023-01-11 14:50:10 +01005929 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005930#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005931 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005932 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005933#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005934 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005935#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005936 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005937#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005938 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5939 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005940#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5941 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5942 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5943#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5944 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5945 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5946#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005947 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005948#endif
5949 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005950
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005951 /*
5952 * Preset-specific defaults
5953 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005954 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005955 /*
5956 * NSA Suite B
5957 */
5958 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005959
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005960 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005961
5962#if defined(MBEDTLS_X509_CRT_PARSE_C)
5963 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005964#endif
5965
Ronald Crone68ab4f2022-10-05 12:46:29 +02005966#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005967#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005968 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005969 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005970 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005971#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005972 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005973#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005974
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005975#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005976 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005977#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005978 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005979 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005980
5981 /*
5982 * Default
5983 */
5984 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005985
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005986 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005987
5988#if defined(MBEDTLS_X509_CRT_PARSE_C)
5989 conf->cert_profile = &mbedtls_x509_crt_profile_default;
5990#endif
5991
Ronald Crone68ab4f2022-10-05 12:46:29 +02005992#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005993#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005995 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005997#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005998 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005999#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006000
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02006001#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006002 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006003#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006004 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006005
6006#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
6007 conf->dhm_min_bitlen = 1024;
6008#endif
6009 }
6010
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006012}
6013
6014/*
6015 * Free mbedtls_ssl_config
6016 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006017void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006018{
Troy-Butlerda73abc2024-04-02 13:37:31 -04006019 if (conf == NULL) {
6020 return;
6021 }
6022
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006023#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006024 mbedtls_mpi_free(&conf->dhm_P);
6025 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006026#endif
6027
Ronald Cron73fe8df2022-10-05 14:31:43 +02006028#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02006029#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006030 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02006031 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
6032 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02006033#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006035 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006036 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006037 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09006038 }
6039
Gilles Peskine449bd832023-01-11 14:50:10 +01006040 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006041 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006042 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006043 conf->psk_identity_len = 0;
6044 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02006045#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006046
6047#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006048 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006049#endif
6050
Gilles Peskine449bd832023-01-11 14:50:10 +01006051 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006052}
6053
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02006054#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02006055 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006056/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006057 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006058 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006059unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006060{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006061#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006062 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
6063 return MBEDTLS_SSL_SIG_RSA;
6064 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006065#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006066#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006067 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
6068 return MBEDTLS_SSL_SIG_ECDSA;
6069 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006070#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006071 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006072}
6073
Gilles Peskine449bd832023-01-11 14:50:10 +01006074unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01006075{
Gilles Peskine449bd832023-01-11 14:50:10 +01006076 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01006077 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006078 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006079 case MBEDTLS_PK_ECDSA:
6080 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01006081 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006082 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006083 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006084 }
6085}
6086
Gilles Peskine449bd832023-01-11 14:50:10 +01006087mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006088{
Gilles Peskine449bd832023-01-11 14:50:10 +01006089 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006090#if defined(MBEDTLS_RSA_C)
6091 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006093#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006094#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006095 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006096 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006097#endif
6098 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006100 }
6101}
Valerio Settie9646ec2023-08-02 20:02:28 +02006102#endif /* MBEDTLS_PK_C &&
6103 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006104
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006105/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006106 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006107 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006108mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006109{
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 switch (hash) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01006111#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006112 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006114#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01006115#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006116 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006117 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006118#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01006119#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006120 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006121 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006122#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006123#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006124 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006125 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006126#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006127#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006128 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006129 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006130#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02006131#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006132 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006133 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006134#endif
6135 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006136 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006137 }
6138}
6139
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006140/*
6141 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6142 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006143unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006144{
Gilles Peskine449bd832023-01-11 14:50:10 +01006145 switch (md) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01006146#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006147 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006148 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006149#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01006150#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006151 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006152 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006153#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01006154#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006155 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006156 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006157#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006158#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006159 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006160 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006161#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006162#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006163 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006164 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006165#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02006166#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006167 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006168 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006169#endif
6170 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006171 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006172 }
6173}
6174
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006175/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006176 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006177 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006178 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006179int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006180{
Gilles Peskine449bd832023-01-11 14:50:10 +01006181 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006182
Gilles Peskine449bd832023-01-11 14:50:10 +01006183 if (group_list == NULL) {
6184 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01006185 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006186
Gilles Peskine449bd832023-01-11 14:50:10 +01006187 for (; *group_list != 0; group_list++) {
6188 if (*group_list == tls_id) {
6189 return 0;
6190 }
6191 }
6192
6193 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006194}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006195
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01006196#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006197/*
6198 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6199 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006200int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006201{
Gilles Peskine449bd832023-01-11 14:50:10 +01006202 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006203
Gilles Peskine449bd832023-01-11 14:50:10 +01006204 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006205 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006206 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006207
Gilles Peskine449bd832023-01-11 14:50:10 +01006208 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006209}
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01006210#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Valerio Setti67419f02023-01-04 16:12:42 +01006211
Valerio Setti18c9fed2022-12-30 17:44:24 +01006212static const struct {
6213 uint16_t tls_id;
6214 mbedtls_ecp_group_id ecp_group_id;
6215 psa_ecc_family_t psa_family;
6216 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01006217} tls_id_match_table[] =
6218{
Elena Uziunaite24e24f22024-07-04 17:53:40 +01006219#if defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02006220 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006221#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01006222#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02006223 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006224#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01006225#if defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02006226 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006227#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01006228#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02006229 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006230#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01006231#if defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02006232 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006233#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01006234#if defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02006235 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006236#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01006237#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02006238 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006239#endif
Elena Uziunaiteeaa0cf02024-07-04 17:41:25 +01006240#if defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02006241 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006242#endif
Elena Uziunaite63cb13e2024-09-05 12:43:14 +01006243#if defined(PSA_WANT_ECC_SECP_K1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02006244 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006245#endif
Elena Uziunaitea3632862024-07-04 13:52:43 +01006246#if defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02006247 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006248#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01006249#if defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02006250 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006251#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01006252#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02006253 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006254#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01006255#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006256 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006257#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006258 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006259};
6260
Gilles Peskine449bd832023-01-11 14:50:10 +01006261int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006262 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006264{
Gilles Peskine449bd832023-01-11 14:50:10 +01006265 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6266 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006267 if (type != NULL) {
6268 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006269 }
6270 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006271 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006272 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006273 return PSA_SUCCESS;
6274 }
6275 }
6276
6277 return PSA_ERROR_NOT_SUPPORTED;
6278}
6279
Gilles Peskine449bd832023-01-11 14:50:10 +01006280mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006281{
Gilles Peskine449bd832023-01-11 14:50:10 +01006282 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6283 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006284 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006285 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006286 }
6287
6288 return MBEDTLS_ECP_DP_NONE;
6289}
6290
Gilles Peskine449bd832023-01-11 14:50:10 +01006291uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006292{
Gilles Peskine449bd832023-01-11 14:50:10 +01006293 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6294 i++) {
6295 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006296 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006297 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006298 }
6299
6300 return 0;
6301}
6302
Valerio Setti67419f02023-01-04 16:12:42 +01006303#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006304static const struct {
6305 uint16_t tls_id;
6306 const char *name;
6307} tls_id_curve_name_table[] =
6308{
Valerio Setti54e23792023-07-07 10:49:27 +02006309 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6310 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6311 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6312 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6313 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6314 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6315 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6316 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6317 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6318 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6319 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6320 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6321 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006322 { 0, NULL },
6323};
6324
Gilles Peskine449bd832023-01-11 14:50:10 +01006325const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006326{
Valerio Settiacd32c02023-06-29 18:06:29 +02006327 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6328 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6329 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006330 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006331 }
6332
6333 return NULL;
6334}
Valerio Setti67419f02023-01-04 16:12:42 +01006335#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006336
Jerry Yu148165c2021-09-24 23:20:59 +08006337#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006338int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6339 const mbedtls_md_type_t md,
6340 unsigned char *dst,
6341 size_t dst_len,
6342 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006343{
Ronald Cronf6893e12022-01-07 22:09:01 +01006344 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6345 psa_hash_operation_t *hash_operation_to_clone;
6346 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6347
Jerry Yu148165c2021-09-24 23:20:59 +08006348 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006349
Gilles Peskine449bd832023-01-11 14:50:10 +01006350 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006351#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006352 case MBEDTLS_MD_SHA384:
6353 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6354 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006355#endif
6356
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006357#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006358 case MBEDTLS_MD_SHA256:
6359 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6360 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006361#endif
6362
Gilles Peskine449bd832023-01-11 14:50:10 +01006363 default:
6364 goto exit;
6365 }
6366
6367 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6368 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006369 goto exit;
6370 }
6371
Gilles Peskine449bd832023-01-11 14:50:10 +01006372 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6373 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006374 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006375 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006376
6377exit:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006378#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006379 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006380 (void) ssl;
6381#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006382 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006383}
6384#else /* MBEDTLS_USE_PSA_CRYPTO */
6385
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006386#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006387MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006388static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
6389 unsigned char *dst,
6390 size_t dst_len,
6391 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006392{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006393 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006394 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006395
Gilles Peskine449bd832023-01-11 14:50:10 +01006396 if (dst_len < 48) {
6397 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6398 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006399
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006400 mbedtls_md_init(&sha384);
6401 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006402 if (ret != 0) {
6403 goto exit;
6404 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006405 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006406 if (ret != 0) {
6407 goto exit;
6408 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006409
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006410 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006411 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006412 goto exit;
6413 }
6414
6415 *olen = 48;
6416
6417exit:
6418
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006419 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006420 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006421}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006422#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006423
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006424#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006425MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006426static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
6427 unsigned char *dst,
6428 size_t dst_len,
6429 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006430{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006431 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006432 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006433
Gilles Peskine449bd832023-01-11 14:50:10 +01006434 if (dst_len < 32) {
6435 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6436 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006437
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006438 mbedtls_md_init(&sha256);
6439 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6440 if (ret != 0) {
6441 goto exit;
6442 }
6443 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6444 if (ret != 0) {
6445 goto exit;
6446 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006447
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006448 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
6449 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006450 goto exit;
6451 }
6452
6453 *olen = 32;
6454
6455exit:
6456
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006457 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006458 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006459}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006460#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006461
Gilles Peskine449bd832023-01-11 14:50:10 +01006462int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6463 const mbedtls_md_type_t md,
6464 unsigned char *dst,
6465 size_t dst_len,
6466 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006467{
Gilles Peskine449bd832023-01-11 14:50:10 +01006468 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006469
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006470#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006471 case MBEDTLS_MD_SHA384:
6472 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006473#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006474
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006475#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006476 case MBEDTLS_MD_SHA256:
6477 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006478#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006479
Gilles Peskine449bd832023-01-11 14:50:10 +01006480 default:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006481#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006482 !defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006483 (void) ssl;
6484 (void) dst;
6485 (void) dst_len;
6486 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006487#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006488 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006489 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006490 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006491}
XiaokangQian647719a2021-12-07 09:16:29 +00006492
Jerry Yu148165c2021-09-24 23:20:59 +08006493#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006494
Ronald Crone68ab4f2022-10-05 12:46:29 +02006495#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006496/* mbedtls_ssl_parse_sig_alg_ext()
6497 *
6498 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6499 * value (TLS 1.3 RFC8446):
6500 * enum {
6501 * ....
6502 * ecdsa_secp256r1_sha256( 0x0403 ),
6503 * ecdsa_secp384r1_sha384( 0x0503 ),
6504 * ecdsa_secp521r1_sha512( 0x0603 ),
6505 * ....
6506 * } SignatureScheme;
6507 *
6508 * struct {
6509 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6510 * } SignatureSchemeList;
6511 *
6512 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6513 * value (TLS 1.2 RFC5246):
6514 * enum {
6515 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6516 * sha512(6), (255)
6517 * } HashAlgorithm;
6518 *
6519 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6520 * SignatureAlgorithm;
6521 *
6522 * struct {
6523 * HashAlgorithm hash;
6524 * SignatureAlgorithm signature;
6525 * } SignatureAndHashAlgorithm;
6526 *
6527 * SignatureAndHashAlgorithm
6528 * supported_signature_algorithms<2..2^16-2>;
6529 *
6530 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6531 * generalization of the TLS 1.2 signature algorithm extension.
6532 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6533 * `SignatureScheme` field of TLS 1.3
6534 *
6535 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006536int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6537 const unsigned char *buf,
6538 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006539{
6540 const unsigned char *p = buf;
6541 size_t supported_sig_algs_len = 0;
6542 const unsigned char *supported_sig_algs_end;
6543 uint16_t sig_alg;
6544 uint32_t common_idx = 0;
6545
Gilles Peskine449bd832023-01-11 14:50:10 +01006546 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6547 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006548 p += 2;
6549
Gilles Peskine449bd832023-01-11 14:50:10 +01006550 memset(ssl->handshake->received_sig_algs, 0,
6551 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006552
Gilles Peskine449bd832023-01-11 14:50:10 +01006553 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006554 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006555 while (p < supported_sig_algs_end) {
6556 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6557 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006558 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006559 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6560 sig_alg,
6561 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006562#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006563 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6564 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6565 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006566 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006567 }
6568#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006569
Gilles Peskine449bd832023-01-11 14:50:10 +01006570 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6571 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006572
Gilles Peskine449bd832023-01-11 14:50:10 +01006573 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006574 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6575 common_idx += 1;
6576 }
6577 }
6578 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006579 if (p != end) {
6580 MBEDTLS_SSL_DEBUG_MSG(1,
6581 ("Signature algorithms extension length misaligned"));
6582 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6583 MBEDTLS_ERR_SSL_DECODE_ERROR);
6584 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006585 }
6586
Gilles Peskine449bd832023-01-11 14:50:10 +01006587 if (common_idx == 0) {
6588 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6589 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6590 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6591 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006592 }
6593
Gabor Mezei15b95a62022-05-09 16:37:58 +02006594 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006595 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006596}
6597
Ronald Crone68ab4f2022-10-05 12:46:29 +02006598#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006599
Jerry Yudc7bd172022-02-17 13:44:15 +08006600#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6601
6602#if defined(MBEDTLS_USE_PSA_CRYPTO)
6603
Gilles Peskine449bd832023-01-11 14:50:10 +01006604static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6605 mbedtls_svc_key_id_t key,
6606 psa_algorithm_t alg,
6607 const unsigned char *raw_psk, size_t raw_psk_length,
6608 const unsigned char *seed, size_t seed_length,
6609 const unsigned char *label, size_t label_length,
6610 const unsigned char *other_secret,
6611 size_t other_secret_length,
6612 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006613{
6614 psa_status_t status;
6615
Gilles Peskine449bd832023-01-11 14:50:10 +01006616 status = psa_key_derivation_setup(derivation, alg);
6617 if (status != PSA_SUCCESS) {
6618 return status;
6619 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006620
Gilles Peskine449bd832023-01-11 14:50:10 +01006621 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6622 status = psa_key_derivation_input_bytes(derivation,
6623 PSA_KEY_DERIVATION_INPUT_SEED,
6624 seed, seed_length);
6625 if (status != PSA_SUCCESS) {
6626 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006627 }
6628
Gilles Peskine449bd832023-01-11 14:50:10 +01006629 if (other_secret != NULL) {
6630 status = psa_key_derivation_input_bytes(derivation,
6631 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6632 other_secret, other_secret_length);
6633 if (status != PSA_SUCCESS) {
6634 return status;
6635 }
6636 }
6637
6638 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006639 status = psa_key_derivation_input_bytes(
6640 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006641 raw_psk, raw_psk_length);
6642 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006643 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006644 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006645 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006646 if (status != PSA_SUCCESS) {
6647 return status;
6648 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006649
Gilles Peskine449bd832023-01-11 14:50:10 +01006650 status = psa_key_derivation_input_bytes(derivation,
6651 PSA_KEY_DERIVATION_INPUT_LABEL,
6652 label, label_length);
6653 if (status != PSA_SUCCESS) {
6654 return status;
6655 }
6656 } else {
6657 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006658 }
6659
Gilles Peskine449bd832023-01-11 14:50:10 +01006660 status = psa_key_derivation_set_capacity(derivation, capacity);
6661 if (status != PSA_SUCCESS) {
6662 return status;
6663 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006664
Gilles Peskine449bd832023-01-11 14:50:10 +01006665 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006666}
6667
Andrzej Kurek57d10632022-10-24 10:32:01 -04006668#if defined(PSA_WANT_ALG_SHA_384) || \
6669 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006670MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006671static int tls_prf_generic(mbedtls_md_type_t md_type,
6672 const unsigned char *secret, size_t slen,
6673 const char *label,
6674 const unsigned char *random, size_t rlen,
6675 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006676{
6677 psa_status_t status;
6678 psa_algorithm_t alg;
6679 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6680 psa_key_derivation_operation_t derivation =
6681 PSA_KEY_DERIVATION_OPERATION_INIT;
6682
Gilles Peskine449bd832023-01-11 14:50:10 +01006683 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006684 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006685 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006686 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006687 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006688
6689 /* Normally a "secret" should be long enough to be impossible to
6690 * find by brute force, and in particular should not be empty. But
6691 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6692 * and for this use case it makes sense to have a 0-length "secret".
6693 * Since the key API doesn't allow importing a key of length 0,
6694 * keep master_key=0, which setup_psa_key_derivation() understands
6695 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006696 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006697 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006698 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6699 psa_set_key_algorithm(&key_attributes, alg);
6700 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006701
Gilles Peskine449bd832023-01-11 14:50:10 +01006702 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6703 if (status != PSA_SUCCESS) {
6704 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6705 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006706 }
6707
Gilles Peskine449bd832023-01-11 14:50:10 +01006708 status = setup_psa_key_derivation(&derivation,
6709 master_key, alg,
6710 NULL, 0,
6711 random, rlen,
6712 (unsigned char const *) label,
6713 (size_t) strlen(label),
6714 NULL, 0,
6715 dlen);
6716 if (status != PSA_SUCCESS) {
6717 psa_key_derivation_abort(&derivation);
6718 psa_destroy_key(master_key);
6719 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006720 }
6721
Gilles Peskine449bd832023-01-11 14:50:10 +01006722 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6723 if (status != PSA_SUCCESS) {
6724 psa_key_derivation_abort(&derivation);
6725 psa_destroy_key(master_key);
6726 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006727 }
6728
Gilles Peskine449bd832023-01-11 14:50:10 +01006729 status = psa_key_derivation_abort(&derivation);
6730 if (status != PSA_SUCCESS) {
6731 psa_destroy_key(master_key);
6732 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006733 }
6734
Gilles Peskine449bd832023-01-11 14:50:10 +01006735 if (!mbedtls_svc_key_id_is_null(master_key)) {
6736 status = psa_destroy_key(master_key);
6737 }
6738 if (status != PSA_SUCCESS) {
6739 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6740 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006741
Gilles Peskine449bd832023-01-11 14:50:10 +01006742 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006743}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006744#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006745#else /* MBEDTLS_USE_PSA_CRYPTO */
6746
Andrzej Kurek57d10632022-10-24 10:32:01 -04006747#if defined(MBEDTLS_MD_C) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006748 (defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006749 defined(PSA_WANT_ALG_SHA_384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006750MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006751static int tls_prf_generic(mbedtls_md_type_t md_type,
6752 const unsigned char *secret, size_t slen,
6753 const char *label,
6754 const unsigned char *random, size_t rlen,
6755 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006756{
6757 size_t nb;
6758 size_t i, j, k, md_len;
6759 unsigned char *tmp;
6760 size_t tmp_len = 0;
6761 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6762 const mbedtls_md_info_t *md_info;
6763 mbedtls_md_context_t md_ctx;
6764 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6765
Gilles Peskine449bd832023-01-11 14:50:10 +01006766 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006767
Gilles Peskine449bd832023-01-11 14:50:10 +01006768 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6769 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6770 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006771
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006773
Gilles Peskine449bd832023-01-11 14:50:10 +01006774 tmp_len = md_len + strlen(label) + rlen;
6775 tmp = mbedtls_calloc(1, tmp_len);
6776 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006777 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6778 goto exit;
6779 }
6780
Gilles Peskine449bd832023-01-11 14:50:10 +01006781 nb = strlen(label);
6782 memcpy(tmp + md_len, label, nb);
6783 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006784 nb += rlen;
6785
6786 /*
6787 * Compute P_<hash>(secret, label + random)[0..dlen]
6788 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006789 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006790 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006791 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006792
Gilles Peskine449bd832023-01-11 14:50:10 +01006793 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6794 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006795 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006796 }
6797 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6798 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006799 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006800 }
6801 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6802 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006803 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006804 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006805
Gilles Peskine449bd832023-01-11 14:50:10 +01006806 for (i = 0; i < dlen; i += md_len) {
6807 ret = mbedtls_md_hmac_reset(&md_ctx);
6808 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006809 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006810 }
6811 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6812 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006813 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006814 }
6815 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6816 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006817 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006818 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006819
Gilles Peskine449bd832023-01-11 14:50:10 +01006820 ret = mbedtls_md_hmac_reset(&md_ctx);
6821 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006822 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006823 }
6824 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6825 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006826 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006827 }
6828 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6829 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006830 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006831 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006832
Gilles Peskine449bd832023-01-11 14:50:10 +01006833 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006834
Gilles Peskine449bd832023-01-11 14:50:10 +01006835 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006836 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006837 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006838 }
6839
6840exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006841 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006842
Gilles Peskine449bd832023-01-11 14:50:10 +01006843 if (tmp != NULL) {
6844 mbedtls_platform_zeroize(tmp, tmp_len);
6845 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006846
Gilles Peskine449bd832023-01-11 14:50:10 +01006847 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006848
Gilles Peskine449bd832023-01-11 14:50:10 +01006849 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006850
Gilles Peskine449bd832023-01-11 14:50:10 +01006851 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006852}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006853#endif /* MBEDTLS_MD_C && ( PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006854#endif /* MBEDTLS_USE_PSA_CRYPTO */
6855
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006856#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006857MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006858static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6859 const char *label,
6860 const unsigned char *random, size_t rlen,
6861 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006862{
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6864 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006865}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006866#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006867
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006868#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006869MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006870static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6871 const char *label,
6872 const unsigned char *random, size_t rlen,
6873 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006874{
Gilles Peskine449bd832023-01-11 14:50:10 +01006875 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6876 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006877}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006878#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006879
Jerry Yuf009d862022-02-17 14:01:37 +08006880/*
6881 * Set appropriate PRF function and other SSL / TLS1.2 functions
6882 *
6883 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006884 * - hash associated with the ciphersuite (only used by TLS 1.2)
6885 *
6886 * Outputs:
6887 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6888 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006889MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006890static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6891 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006892{
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006893#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006894 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006895 handshake->tls_prf = tls_prf_sha384;
6896 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6897 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006898 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006899#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006900#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuf009d862022-02-17 14:01:37 +08006901 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006902 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006903 handshake->tls_prf = tls_prf_sha256;
6904 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6905 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6906 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006907#else
Jerry Yuf009d862022-02-17 14:01:37 +08006908 {
Jerry Yuf009d862022-02-17 14:01:37 +08006909 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006910 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006911 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006912 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006913#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006914
Gilles Peskine449bd832023-01-11 14:50:10 +01006915 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006916}
Jerry Yud6ab2352022-02-17 14:03:43 +08006917
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006918/*
6919 * Compute master secret if needed
6920 *
6921 * Parameters:
6922 * [in/out] handshake
6923 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6924 * (PSA-PSK) ciphersuite_info, psk_opaque
6925 * [out] premaster (cleared)
6926 * [out] master
6927 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6928 * debug: conf->f_dbg, conf->p_dbg
6929 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006930 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006931 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006932MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006933static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6934 unsigned char *master,
6935 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006936{
6937 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6938
6939 /* cf. RFC 5246, Section 8.1:
6940 * "The master secret is always exactly 48 bytes in length." */
6941 size_t const master_secret_len = 48;
6942
6943#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6944 unsigned char session_hash[48];
6945#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6946
6947 /* The label for the KDF used for key expansion.
6948 * This is either "master secret" or "extended master secret"
6949 * depending on whether the Extended Master Secret extension
6950 * is used. */
6951 char const *lbl = "master secret";
6952
Przemek Stekielae4ed302022-04-05 17:15:55 +02006953 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006954 * - If the Extended Master Secret extension is not used,
6955 * this is ClientHello.Random + ServerHello.Random
6956 * (see Sect. 8.1 in RFC 5246).
6957 * - If the Extended Master Secret extension is used,
6958 * this is the transcript of the handshake so far.
6959 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006960 unsigned char const *seed = handshake->randbytes;
6961 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006962
6963#if !defined(MBEDTLS_DEBUG_C) && \
6964 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6965 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006966 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006967 ssl = NULL; /* make sure we don't use it except for those cases */
6968 (void) ssl;
6969#endif
6970
Gilles Peskine449bd832023-01-11 14:50:10 +01006971 if (handshake->resume != 0) {
6972 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6973 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006974 }
6975
6976#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006977 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006978 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006979 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006980 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6981 if (ret != 0) {
6982 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6983 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006984
Gilles Peskine449bd832023-01-11 14:50:10 +01006985 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6986 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006987 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006988#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006989
Przemek Stekiel99114f32022-04-22 11:20:09 +02006990#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006991 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006992 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006993 /* Perform PSK-to-MS expansion in a single step. */
6994 psa_status_t status;
6995 psa_algorithm_t alg;
6996 mbedtls_svc_key_id_t psk;
6997 psa_key_derivation_operation_t derivation =
6998 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01006999 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007000
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007002
Gilles Peskine449bd832023-01-11 14:50:10 +01007003 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007004
Gilles Peskine449bd832023-01-11 14:50:10 +01007005 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007006 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01007007 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007008 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01007009 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007010
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007011 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007012 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02007013
Gilles Peskine449bd832023-01-11 14:50:10 +01007014 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007015 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007016 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007017 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02007018 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007019 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007020 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007021 other_secret_len = 48;
7022 other_secret = handshake->premaster + 2;
7023 break;
7024 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007025 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007026 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
7027 other_secret = handshake->premaster + 2;
7028 break;
7029 default:
7030 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02007031 }
7032
Gilles Peskine449bd832023-01-11 14:50:10 +01007033 status = setup_psa_key_derivation(&derivation, psk, alg,
7034 ssl->conf->psk, ssl->conf->psk_len,
7035 seed, seed_len,
7036 (unsigned char const *) lbl,
7037 (size_t) strlen(lbl),
7038 other_secret, other_secret_len,
7039 master_secret_len);
7040 if (status != PSA_SUCCESS) {
7041 psa_key_derivation_abort(&derivation);
7042 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007043 }
7044
Gilles Peskine449bd832023-01-11 14:50:10 +01007045 status = psa_key_derivation_output_bytes(&derivation,
7046 master,
7047 master_secret_len);
7048 if (status != PSA_SUCCESS) {
7049 psa_key_derivation_abort(&derivation);
7050 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007051 }
7052
Gilles Peskine449bd832023-01-11 14:50:10 +01007053 status = psa_key_derivation_abort(&derivation);
7054 if (status != PSA_SUCCESS) {
7055 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7056 }
7057 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007058#endif
7059 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007060#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007061 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7062 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007063 psa_status_t status;
7064 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
7065 psa_key_derivation_operation_t derivation =
7066 PSA_KEY_DERIVATION_OPERATION_INIT;
7067
Gilles Peskine449bd832023-01-11 14:50:10 +01007068 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02007069
7070 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
7071
Gilles Peskine449bd832023-01-11 14:50:10 +01007072 status = psa_key_derivation_setup(&derivation, alg);
7073 if (status != PSA_SUCCESS) {
7074 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007075 }
7076
Gilles Peskine449bd832023-01-11 14:50:10 +01007077 status = psa_key_derivation_set_capacity(&derivation,
7078 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
7079 if (status != PSA_SUCCESS) {
7080 psa_key_derivation_abort(&derivation);
7081 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007082 }
7083
Gilles Peskine449bd832023-01-11 14:50:10 +01007084 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
7085 &derivation);
7086 if (status != PSA_SUCCESS) {
7087 psa_key_derivation_abort(&derivation);
7088 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007089 }
7090
Gilles Peskine449bd832023-01-11 14:50:10 +01007091 status = psa_key_derivation_output_bytes(&derivation,
7092 handshake->premaster,
7093 handshake->pmslen);
7094 if (status != PSA_SUCCESS) {
7095 psa_key_derivation_abort(&derivation);
7096 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7097 }
7098
7099 status = psa_key_derivation_abort(&derivation);
7100 if (status != PSA_SUCCESS) {
7101 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007102 }
7103 }
7104#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007105 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
7106 lbl, seed, seed_len,
7107 master,
7108 master_secret_len);
7109 if (ret != 0) {
7110 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7111 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007112 }
7113
Gilles Peskine449bd832023-01-11 14:50:10 +01007114 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
7115 handshake->premaster,
7116 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007117
Gilles Peskine449bd832023-01-11 14:50:10 +01007118 mbedtls_platform_zeroize(handshake->premaster,
7119 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007120 }
7121
Gilles Peskine449bd832023-01-11 14:50:10 +01007122 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007123}
7124
Gilles Peskine449bd832023-01-11 14:50:10 +01007125int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08007126{
7127 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7128 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7129 ssl->handshake->ciphersuite_info;
7130
Gilles Peskine449bd832023-01-11 14:50:10 +01007131 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007132
7133 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007134 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01007135 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007136 if (ret != 0) {
7137 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
7138 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007139 }
7140
7141 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01007142 ret = ssl_compute_master(ssl->handshake,
7143 ssl->session_negotiate->master,
7144 ssl);
7145 if (ret != 0) {
7146 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
7147 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007148 }
7149
7150 /* Swap the client and server random values:
7151 * - MS derivation wanted client+server (RFC 5246 8.1)
7152 * - key derivation wants server+client (RFC 5246 6.3) */
7153 {
7154 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01007155 memcpy(tmp, ssl->handshake->randbytes, 64);
7156 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
7157 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
7158 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08007159 }
7160
7161 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01007162 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
7163 ssl->session_negotiate->ciphersuite,
7164 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007165#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007166 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007167#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007168 ssl->handshake->tls_prf,
7169 ssl->handshake->randbytes,
7170 ssl->tls_version,
7171 ssl->conf->endpoint,
7172 ssl);
7173 if (ret != 0) {
7174 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
7175 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007176 }
7177
7178 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01007179 mbedtls_platform_zeroize(ssl->handshake->randbytes,
7180 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08007181
Gilles Peskine449bd832023-01-11 14:50:10 +01007182 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007183
Gilles Peskine449bd832023-01-11 14:50:10 +01007184 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08007185}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007186
Gilles Peskine449bd832023-01-11 14:50:10 +01007187int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007188{
Gilles Peskine449bd832023-01-11 14:50:10 +01007189 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007190#if defined(PSA_WANT_ALG_SHA_384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007191 case MBEDTLS_SSL_HASH_SHA384:
7192 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
7193 break;
7194#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007195#if defined(PSA_WANT_ALG_SHA_256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007196 case MBEDTLS_SSL_HASH_SHA256:
7197 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
7198 break;
7199#endif
7200 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007201 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007202 }
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007203#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007204 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007205 (void) ssl;
7206#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007207 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007208}
7209
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007210#if defined(MBEDTLS_USE_PSA_CRYPTO)
7211static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
7212 const psa_hash_operation_t *hs_op,
7213 size_t buffer_size,
7214 unsigned char *hash,
7215 size_t *hlen)
7216{
7217 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007218 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007219
7220#if !defined(MBEDTLS_DEBUG_C)
7221 (void) ssl;
7222#endif
7223 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007224 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007225 if (status != PSA_SUCCESS) {
7226 goto exit;
7227 }
7228
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007229 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007230 if (status != PSA_SUCCESS) {
7231 goto exit;
7232 }
7233
7234 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
7235 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
7236
7237exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007238 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007239 return mbedtls_md_error_from_psa(status);
7240}
7241#else
7242static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
7243 const mbedtls_md_context_t *hs_ctx,
7244 unsigned char *hash,
7245 size_t *hlen)
7246{
7247 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007248 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007249
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007250 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007251
7252#if !defined(MBEDTLS_DEBUG_C)
7253 (void) ssl;
7254#endif
7255 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
7256
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007257 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007258 if (ret != 0) {
7259 goto exit;
7260 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007261 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007262 if (ret != 0) {
7263 goto exit;
7264 }
7265
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007266 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007267 if (ret != 0) {
7268 goto exit;
7269 }
7270
7271 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
7272
7273 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
7274 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
7275
7276exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007277 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007278 return ret;
7279}
7280#endif /* MBEDTLS_USE_PSA_CRYPTO */
7281
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007282#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007283int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
7284 unsigned char *hash,
7285 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08007286{
7287#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007288 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
7289 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007290#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007291 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
7292 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007293#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007294}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007295#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007296
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007297#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007298int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
7299 unsigned char *hash,
7300 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08007301{
7302#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007303 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
7304 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007305#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007306 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
7307 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007308#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007309}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007310#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007311
Neil Armstrong80f6f322022-05-03 17:56:38 +02007312#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
7313 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007314int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08007315{
7316 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01007317 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007318 const unsigned char *psk = NULL;
7319 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007320 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007321
Gilles Peskine449bd832023-01-11 14:50:10 +01007322 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007323 /*
7324 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007325 * checked before calling this function.
7326 *
7327 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007328 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08007329 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007330 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
7331 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7332 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007333 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007334 }
7335
7336 /*
7337 * PMS = struct {
7338 * opaque other_secret<0..2^16-1>;
7339 * opaque psk<0..2^16-1>;
7340 * };
7341 * with "other_secret" depending on the particular key exchange
7342 */
7343#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007344 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
7345 if (end - p < 2) {
7346 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7347 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007348
Gilles Peskine449bd832023-01-11 14:50:10 +01007349 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007350 p += 2;
7351
Gilles Peskine449bd832023-01-11 14:50:10 +01007352 if (end < p || (size_t) (end - p) < psk_len) {
7353 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7354 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007355
Gilles Peskine449bd832023-01-11 14:50:10 +01007356 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007357 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007358 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007359#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
7360#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007361 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007362 /*
7363 * other_secret already set by the ClientKeyExchange message,
7364 * and is 48 bytes long
7365 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007366 if (end - p < 2) {
7367 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7368 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007369
7370 *p++ = 0;
7371 *p++ = 48;
7372 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01007373 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007374#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
7375#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007376 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007377 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7378 size_t len;
7379
7380 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01007381 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007382 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01007383 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7384 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
7385 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007386 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007387 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007388 p += 2 + len;
7389
Gilles Peskine449bd832023-01-11 14:50:10 +01007390 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
7391 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007392#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02007393#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007394 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007395 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7396 size_t zlen;
7397
Gilles Peskine449bd832023-01-11 14:50:10 +01007398 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007399 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01007400 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7401 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
7402 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007403 }
7404
Gilles Peskine449bd832023-01-11 14:50:10 +01007405 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007406 p += 2 + zlen;
7407
Gilles Peskine449bd832023-01-11 14:50:10 +01007408 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
7409 MBEDTLS_DEBUG_ECDH_Z);
7410 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02007411#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007412 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007413 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7414 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08007415 }
7416
7417 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01007418 if (end - p < 2) {
7419 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7420 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007421
Gilles Peskine449bd832023-01-11 14:50:10 +01007422 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007423 p += 2;
7424
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 if (end < p || (size_t) (end - p) < psk_len) {
7426 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7427 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007428
Gilles Peskine449bd832023-01-11 14:50:10 +01007429 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007430 p += psk_len;
7431
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007432 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007433
Gilles Peskine449bd832023-01-11 14:50:10 +01007434 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08007435}
Neil Armstrong80f6f322022-05-03 17:56:38 +02007436#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007437
7438#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007439MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007440static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007441
7442#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007443int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08007444{
7445 /* If renegotiation is not enforced, retransmit until we would reach max
7446 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007448 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7449 unsigned char doublings = 1;
7450
Gilles Peskine449bd832023-01-11 14:50:10 +01007451 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007452 ++doublings;
7453 ratio >>= 1;
7454 }
7455
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 if (++ssl->renego_records_seen > doublings) {
7457 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
7458 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08007459 }
7460 }
7461
Gilles Peskine449bd832023-01-11 14:50:10 +01007462 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007463}
7464#endif
7465#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007466
Jerry Yud9526692022-02-17 14:23:47 +08007467/*
7468 * Handshake functions
7469 */
7470#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7471/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007472int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007473{
7474 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7475 ssl->handshake->ciphersuite_info;
7476
Gilles Peskine449bd832023-01-11 14:50:10 +01007477 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007478
Gilles Peskine449bd832023-01-11 14:50:10 +01007479 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7480 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007481 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007482 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007483 }
7484
Gilles Peskine449bd832023-01-11 14:50:10 +01007485 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7486 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007487}
7488
Gilles Peskine449bd832023-01-11 14:50:10 +01007489int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007490{
7491 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7492 ssl->handshake->ciphersuite_info;
7493
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007495
Gilles Peskine449bd832023-01-11 14:50:10 +01007496 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7497 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007498 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007499 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007500 }
7501
Gilles Peskine449bd832023-01-11 14:50:10 +01007502 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7503 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007504}
7505
7506#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7507/* Some certificate support -> implement write and parse */
7508
Gilles Peskine449bd832023-01-11 14:50:10 +01007509int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007510{
7511 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7512 size_t i, n;
7513 const mbedtls_x509_crt *crt;
7514 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7515 ssl->handshake->ciphersuite_info;
7516
Gilles Peskine449bd832023-01-11 14:50:10 +01007517 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007518
Gilles Peskine449bd832023-01-11 14:50:10 +01007519 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7520 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007521 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007522 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007523 }
7524
7525#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007526 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7527 if (ssl->handshake->client_auth == 0) {
7528 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007529 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007530 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007531 }
7532 }
7533#endif /* MBEDTLS_SSL_CLI_C */
7534#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7536 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007537 /* Should never happen because we shouldn't have picked the
7538 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007539 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007540 }
7541 }
7542#endif
7543
Gilles Peskine449bd832023-01-11 14:50:10 +01007544 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007545
7546 /*
7547 * 0 . 0 handshake type
7548 * 1 . 3 handshake length
7549 * 4 . 6 length of all certs
7550 * 7 . 9 length of cert. 1
7551 * 10 . n-1 peer certificate
7552 * n . n+2 length of cert. 2
7553 * n+3 . ... upper level cert, etc.
7554 */
7555 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007556 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007557
Gilles Peskine449bd832023-01-11 14:50:10 +01007558 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007559 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007560 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7561 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7562 " > %" MBEDTLS_PRINTF_SIZET,
7563 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7564 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007565 }
7566
Gilles Peskine449bd832023-01-11 14:50:10 +01007567 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7568 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7569 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007570
Gilles Peskine449bd832023-01-11 14:50:10 +01007571 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007572 i += n; crt = crt->next;
7573 }
7574
Gilles Peskine449bd832023-01-11 14:50:10 +01007575 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7576 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7577 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007578
7579 ssl->out_msglen = i;
7580 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7581 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7582
7583 ssl->state++;
7584
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7586 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7587 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007588 }
7589
Gilles Peskine449bd832023-01-11 14:50:10 +01007590 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007591
Gilles Peskine449bd832023-01-11 14:50:10 +01007592 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007593}
7594
7595#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7596
7597#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007598MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007599static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7600 unsigned char *crt_buf,
7601 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007602{
7603 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7604
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 if (peer_crt == NULL) {
7606 return -1;
7607 }
Jerry Yud9526692022-02-17 14:23:47 +08007608
Gilles Peskine449bd832023-01-11 14:50:10 +01007609 if (peer_crt->raw.len != crt_buf_len) {
7610 return -1;
7611 }
Jerry Yud9526692022-02-17 14:23:47 +08007612
Gilles Peskine449bd832023-01-11 14:50:10 +01007613 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007614}
7615#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007616MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007617static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7618 unsigned char *crt_buf,
7619 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007620{
7621 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7622 unsigned char const * const peer_cert_digest =
7623 ssl->session->peer_cert_digest;
7624 mbedtls_md_type_t const peer_cert_digest_type =
7625 ssl->session->peer_cert_digest_type;
7626 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007627 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007628 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7629 size_t digest_len;
7630
Gilles Peskine449bd832023-01-11 14:50:10 +01007631 if (peer_cert_digest == NULL || digest_info == NULL) {
7632 return -1;
7633 }
Jerry Yud9526692022-02-17 14:23:47 +08007634
Gilles Peskine449bd832023-01-11 14:50:10 +01007635 digest_len = mbedtls_md_get_size(digest_info);
7636 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7637 return -1;
7638 }
Jerry Yud9526692022-02-17 14:23:47 +08007639
Gilles Peskine449bd832023-01-11 14:50:10 +01007640 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7641 if (ret != 0) {
7642 return -1;
7643 }
Jerry Yud9526692022-02-17 14:23:47 +08007644
Gilles Peskine449bd832023-01-11 14:50:10 +01007645 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007646}
7647#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7648#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7649
7650/*
7651 * Once the certificate message is read, parse it into a cert chain and
7652 * perform basic checks, but leave actual verification to the caller
7653 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007654MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007655static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7656 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007657{
7658 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7659#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007660 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007661#endif
7662 size_t i, n;
7663 uint8_t alert;
7664
Gilles Peskine449bd832023-01-11 14:50:10 +01007665 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7666 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7667 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7668 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7669 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007670 }
7671
Gilles Peskine449bd832023-01-11 14:50:10 +01007672 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7673 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7674 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7675 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007676 }
7677
Gilles Peskine449bd832023-01-11 14:50:10 +01007678 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7679 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7680 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7681 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7682 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007683 }
7684
Gilles Peskine449bd832023-01-11 14:50:10 +01007685 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007686
7687 /*
7688 * Same message structure as in mbedtls_ssl_write_certificate()
7689 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007690 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007691
Gilles Peskine449bd832023-01-11 14:50:10 +01007692 if (ssl->in_msg[i] != 0 ||
7693 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7694 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7695 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7696 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7697 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007698 }
7699
7700 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7701 i += 3;
7702
7703 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007704 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007705 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007706 if (i + 3 > ssl->in_hslen) {
7707 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7708 mbedtls_ssl_send_alert_message(ssl,
7709 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7710 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7711 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007712 }
7713 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7714 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007715 if (ssl->in_msg[i] != 0) {
7716 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7717 mbedtls_ssl_send_alert_message(ssl,
7718 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7719 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7720 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007721 }
7722
7723 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007724 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007725 i += 3;
7726
Gilles Peskine449bd832023-01-11 14:50:10 +01007727 if (n < 128 || i + n > ssl->in_hslen) {
7728 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7729 mbedtls_ssl_send_alert_message(ssl,
7730 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7731 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7732 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007733 }
7734
7735 /* Check if we're handling the first CRT in the chain. */
7736#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007737 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007738 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007739 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007740 /* During client-side renegotiation, check that the server's
7741 * end-CRTs hasn't changed compared to the initial handshake,
7742 * mitigating the triple handshake attack. On success, reuse
7743 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007744 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7745 if (ssl_check_peer_crt_unchanged(ssl,
7746 &ssl->in_msg[i],
7747 n) != 0) {
7748 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7749 mbedtls_ssl_send_alert_message(ssl,
7750 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7751 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7752 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007753 }
7754
7755 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007756 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007757 }
7758#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7759
7760 /* Parse the next certificate in the chain. */
7761#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007762 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007763#else
7764 /* If we don't need to store the CRT chain permanently, parse
7765 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007766 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007767#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007768 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007769 case 0: /*ok*/
7770 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7771 /* Ignore certificate with an unknown algorithm: maybe a
7772 prior certificate was already trusted. */
7773 break;
7774
7775 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7776 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7777 goto crt_parse_der_failed;
7778
7779 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7780 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7781 goto crt_parse_der_failed;
7782
7783 default:
7784 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007785crt_parse_der_failed:
7786 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7787 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7788 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007789 }
7790
7791 i += n;
7792 }
7793
Gilles Peskine449bd832023-01-11 14:50:10 +01007794 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7795 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007796}
7797
7798#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007799MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007800static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007801{
Gilles Peskine449bd832023-01-11 14:50:10 +01007802 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7803 return -1;
7804 }
Jerry Yud9526692022-02-17 14:23:47 +08007805
Gilles Peskine449bd832023-01-11 14:50:10 +01007806 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007807 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7808 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007809 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7810 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7811 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007812 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007813 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007814}
7815#endif /* MBEDTLS_SSL_SRV_C */
7816
7817/* Check if a certificate message is expected.
7818 * Return either
7819 * - SSL_CERTIFICATE_EXPECTED, or
7820 * - SSL_CERTIFICATE_SKIP
7821 * indicating whether a Certificate message is expected or not.
7822 */
7823#define SSL_CERTIFICATE_EXPECTED 0
7824#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007825MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007826static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7827 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007828{
7829 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7830 ssl->handshake->ciphersuite_info;
7831
Gilles Peskine449bd832023-01-11 14:50:10 +01007832 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7833 return SSL_CERTIFICATE_SKIP;
7834 }
Jerry Yud9526692022-02-17 14:23:47 +08007835
7836#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007837 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7838 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7839 return SSL_CERTIFICATE_SKIP;
7840 }
Jerry Yud9526692022-02-17 14:23:47 +08007841
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:
9688 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
9689 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
9690 break;
9691
9692 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
9693 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
9694 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
9695 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
9696 break;
9697
9698 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
9699 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
9700 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
9701 break;
9702
9703 /* Don't use default: we want warnings when adding new values */
9704 case MBEDTLS_KEY_EXCHANGE_NONE:
9705 case MBEDTLS_KEY_EXCHANGE_PSK:
9706 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
9707 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
9708 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
9709 usage = 0;
9710 }
9711 } else
9712#endif
9713 {
9714 /* This is either TLS 1.3 authentication, which always uses signatures,
9715 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
9716 * options we implement, both using signatures. */
9717 (void) tls_version;
9718 (void) ciphersuite;
9719 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
9720 }
9721
9722 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
9723 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
9724 ret = -1;
9725 }
9726
9727 /*
9728 * extKeyUsage
9729 */
9730
9731 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
9732 ext_oid = MBEDTLS_OID_SERVER_AUTH;
9733 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
9734 } else {
9735 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
9736 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
9737 }
9738
9739 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
9740 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
9741 ret = -1;
9742 }
9743
9744 return ret;
9745}
9746
9747int mbedtls_ssl_verify_certificate(mbedtls_ssl_context *ssl,
9748 int authmode,
9749 mbedtls_x509_crt *chain,
9750 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
9751 void *rs_ctx)
9752{
9753 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
9754 return 0;
9755 }
9756
9757 /*
9758 * Primary check: use the appropriate X.509 verification function
9759 */
9760 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
9761 void *p_vrfy;
9762 if (ssl->f_vrfy != NULL) {
9763 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
9764 f_vrfy = ssl->f_vrfy;
9765 p_vrfy = ssl->p_vrfy;
9766 } else {
9767 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
9768 f_vrfy = ssl->conf->f_vrfy;
9769 p_vrfy = ssl->conf->p_vrfy;
9770 }
9771
9772 int ret = 0;
9773 int have_ca_chain_or_callback = 0;
9774#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
9775 if (ssl->conf->f_ca_cb != NULL) {
9776 ((void) rs_ctx);
9777 have_ca_chain_or_callback = 1;
9778
9779 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
9780 ret = mbedtls_x509_crt_verify_with_ca_cb(
9781 chain,
9782 ssl->conf->f_ca_cb,
9783 ssl->conf->p_ca_cb,
9784 ssl->conf->cert_profile,
9785 ssl->hostname,
9786 &ssl->session_negotiate->verify_result,
9787 f_vrfy, p_vrfy);
9788 } else
9789#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
9790 {
9791 mbedtls_x509_crt *ca_chain;
9792 mbedtls_x509_crl *ca_crl;
9793#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
9794 if (ssl->handshake->sni_ca_chain != NULL) {
9795 ca_chain = ssl->handshake->sni_ca_chain;
9796 ca_crl = ssl->handshake->sni_ca_crl;
9797 } else
9798#endif
9799 {
9800 ca_chain = ssl->conf->ca_chain;
9801 ca_crl = ssl->conf->ca_crl;
9802 }
9803
9804 if (ca_chain != NULL) {
9805 have_ca_chain_or_callback = 1;
9806 }
9807
9808 ret = mbedtls_x509_crt_verify_restartable(
9809 chain,
9810 ca_chain, ca_crl,
9811 ssl->conf->cert_profile,
9812 ssl->hostname,
9813 &ssl->session_negotiate->verify_result,
9814 f_vrfy, p_vrfy, rs_ctx);
9815 }
9816
9817 if (ret != 0) {
9818 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
9819 }
9820
9821#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
9822 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
9823 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
9824 }
9825#endif
9826
9827 /*
9828 * Secondary checks: always done, but change 'ret' only if it was 0
9829 */
9830
9831 /* With TLS 1.2 and ECC certs, check that the curve used by the
9832 * certificate is on our list of acceptable curves.
9833 *
9834 * With TLS 1.3 this is not needed because the curve is part of the
9835 * signature algorithm (eg ecdsa_secp256r1_sha256) which is checked when
9836 * we validate the signature made with the key associated to this cert.
9837 */
9838#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
9839 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
9840 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
9841 mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY)) {
9842 if (mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
9843 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
9844 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
9845 if (ret == 0) {
9846 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
9847 }
9848 }
9849 }
9850#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
9851
9852 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
9853 if (mbedtls_ssl_check_cert_usage(chain,
9854 ciphersuite_info,
9855 ssl->conf->endpoint,
9856 ssl->tls_version,
9857 &ssl->session_negotiate->verify_result) != 0) {
9858 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
9859 if (ret == 0) {
9860 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
9861 }
9862 }
9863
9864 /* With authmode optional, we want to keep going if the certificate was
9865 * unacceptable, but still fail on other errors (out of memory etc),
9866 * including fatal errors from the f_vrfy callback.
9867 *
9868 * The only acceptable errors are:
9869 * - MBEDTLS_ERR_X509_CERT_VERIFY_FAILED: cert rejected by primary check;
9870 * - MBEDTLS_ERR_SSL_BAD_CERTIFICATE: cert rejected by secondary checks.
9871 * Anything else is a fatal error. */
9872 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
9873 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
9874 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
9875 ret = 0;
9876 }
9877
9878 /* Return a specific error as this is a user error: inconsistent
9879 * configuration - can't verify without trust anchors. */
9880 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
9881 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
9882 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
9883 }
9884
9885 if (ret != 0) {
9886 uint8_t alert;
9887
9888 /* The certificate may have been rejected for several reasons.
9889 Pick one and send the corresponding alert. Which alert to send
9890 may be a subject of debate in some cases. */
9891 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
9892 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
9893 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
9894 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
9895 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
9896 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9897 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
9898 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9899 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
9900 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9901 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
9902 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9903 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
9904 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
9905 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
9906 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
9907 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
9908 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
9909 } else {
9910 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
9911 }
9912 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9913 alert);
9914 }
9915
9916#if defined(MBEDTLS_DEBUG_C)
9917 if (ssl->session_negotiate->verify_result != 0) {
9918 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
9919 (unsigned int) ssl->session_negotiate->verify_result));
9920 } else {
9921 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
9922 }
9923#endif /* MBEDTLS_DEBUG_C */
9924
9925 return ret;
9926}
9927#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
9928
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009929#endif /* MBEDTLS_SSL_TLS_C */