blob: 5031c77a56045f1eb7b830b3fec33e98f351982a [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
Ronald Cron8b592d22024-11-12 18:08:25 +01002455const mbedtls_error_pair_t psa_to_ssl_errors[] =
2456{
2457 { PSA_SUCCESS, 0 },
2458 { PSA_ERROR_INSUFFICIENT_MEMORY, MBEDTLS_ERR_SSL_ALLOC_FAILED },
2459 { PSA_ERROR_NOT_SUPPORTED, MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE },
2460 { PSA_ERROR_INVALID_SIGNATURE, MBEDTLS_ERR_SSL_INVALID_MAC },
2461 { PSA_ERROR_INVALID_ARGUMENT, MBEDTLS_ERR_SSL_BAD_INPUT_DATA },
2462 { PSA_ERROR_BAD_STATE, MBEDTLS_ERR_SSL_INTERNAL_ERROR },
2463 { PSA_ERROR_BUFFER_TOO_SMALL, MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL }
2464};
2465
Gilles Peskine449bd832023-01-11 14:50:10 +01002466psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2467 size_t taglen,
2468 psa_algorithm_t *alg,
2469 psa_key_type_t *key_type,
2470 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002471{
Elena Uziunaitec2561722024-07-05 11:37:33 +01002472#if !defined(PSA_WANT_ALG_CCM)
Yanray Wang19e4dc82023-11-16 18:02:05 +08002473 (void) taglen;
2474#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 switch (mbedtls_cipher_type) {
Elena Uziunaite74342c72024-07-05 11:31:29 +01002476#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002477 case MBEDTLS_CIPHER_AES_128_CBC:
2478 *alg = PSA_ALG_CBC_NO_PADDING;
2479 *key_type = PSA_KEY_TYPE_AES;
2480 *key_size = 128;
2481 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002482#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002483#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002484 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002485 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002486 *key_type = PSA_KEY_TYPE_AES;
2487 *key_size = 128;
2488 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002489#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002490#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002491 case MBEDTLS_CIPHER_AES_128_GCM:
2492 *alg = PSA_ALG_GCM;
2493 *key_type = PSA_KEY_TYPE_AES;
2494 *key_size = 128;
2495 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002496#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002497#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002498 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002499 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002500 *key_type = PSA_KEY_TYPE_AES;
2501 *key_size = 192;
2502 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002503#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002504#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002505 case MBEDTLS_CIPHER_AES_192_GCM:
2506 *alg = PSA_ALG_GCM;
2507 *key_type = PSA_KEY_TYPE_AES;
2508 *key_size = 192;
2509 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002510#endif
Elena Uziunaite74342c72024-07-05 11:31:29 +01002511#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002512 case MBEDTLS_CIPHER_AES_256_CBC:
2513 *alg = PSA_ALG_CBC_NO_PADDING;
2514 *key_type = PSA_KEY_TYPE_AES;
2515 *key_size = 256;
2516 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002517#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002518#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002519 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002520 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002521 *key_type = PSA_KEY_TYPE_AES;
2522 *key_size = 256;
2523 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002524#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002525#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002526 case MBEDTLS_CIPHER_AES_256_GCM:
2527 *alg = PSA_ALG_GCM;
2528 *key_type = PSA_KEY_TYPE_AES;
2529 *key_size = 256;
2530 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002531#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002532#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002533 case MBEDTLS_CIPHER_ARIA_128_CBC:
2534 *alg = PSA_ALG_CBC_NO_PADDING;
2535 *key_type = PSA_KEY_TYPE_ARIA;
2536 *key_size = 128;
2537 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002538#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002539#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002540 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002542 *key_type = PSA_KEY_TYPE_ARIA;
2543 *key_size = 128;
2544 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002545#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002546#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002547 case MBEDTLS_CIPHER_ARIA_128_GCM:
2548 *alg = PSA_ALG_GCM;
2549 *key_type = PSA_KEY_TYPE_ARIA;
2550 *key_size = 128;
2551 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002552#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002553#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002554 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002556 *key_type = PSA_KEY_TYPE_ARIA;
2557 *key_size = 192;
2558 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002559#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002560#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002561 case MBEDTLS_CIPHER_ARIA_192_GCM:
2562 *alg = PSA_ALG_GCM;
2563 *key_type = PSA_KEY_TYPE_ARIA;
2564 *key_size = 192;
2565 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002566#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002567#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002568 case MBEDTLS_CIPHER_ARIA_256_CBC:
2569 *alg = PSA_ALG_CBC_NO_PADDING;
2570 *key_type = PSA_KEY_TYPE_ARIA;
2571 *key_size = 256;
2572 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002573#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002574#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002575 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002577 *key_type = PSA_KEY_TYPE_ARIA;
2578 *key_size = 256;
2579 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002580#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002581#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002582 case MBEDTLS_CIPHER_ARIA_256_GCM:
2583 *alg = PSA_ALG_GCM;
2584 *key_type = PSA_KEY_TYPE_ARIA;
2585 *key_size = 256;
2586 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002587#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002588#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002589 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2590 *alg = PSA_ALG_CBC_NO_PADDING;
2591 *key_type = PSA_KEY_TYPE_CAMELLIA;
2592 *key_size = 128;
2593 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002594#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002595#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002596 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002598 *key_type = PSA_KEY_TYPE_CAMELLIA;
2599 *key_size = 128;
2600 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002601#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002602#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002603 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2604 *alg = PSA_ALG_GCM;
2605 *key_type = PSA_KEY_TYPE_CAMELLIA;
2606 *key_size = 128;
2607 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002608#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002609#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002610 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002611 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002612 *key_type = PSA_KEY_TYPE_CAMELLIA;
2613 *key_size = 192;
2614 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002615#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002616#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002617 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2618 *alg = PSA_ALG_GCM;
2619 *key_type = PSA_KEY_TYPE_CAMELLIA;
2620 *key_size = 192;
2621 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002622#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002623#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002624 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2625 *alg = PSA_ALG_CBC_NO_PADDING;
2626 *key_type = PSA_KEY_TYPE_CAMELLIA;
2627 *key_size = 256;
2628 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002629#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002630#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002631 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002632 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002633 *key_type = PSA_KEY_TYPE_CAMELLIA;
2634 *key_size = 256;
2635 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002636#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002637#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002638 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2639 *alg = PSA_ALG_GCM;
2640 *key_type = PSA_KEY_TYPE_CAMELLIA;
2641 *key_size = 256;
2642 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002643#endif
Elena Uziunaite5c70c302024-07-05 11:44:44 +01002644#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002645 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2646 *alg = PSA_ALG_CHACHA20_POLY1305;
2647 *key_type = PSA_KEY_TYPE_CHACHA20;
2648 *key_size = 256;
2649 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002650#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002651 case MBEDTLS_CIPHER_NULL:
2652 *alg = MBEDTLS_SSL_NULL_CIPHER;
2653 *key_type = 0;
2654 *key_size = 0;
2655 break;
2656 default:
2657 return PSA_ERROR_NOT_SUPPORTED;
2658 }
2659
2660 return PSA_SUCCESS;
2661}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002662#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002663
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002664#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002665int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2666 const unsigned char *dhm_P, size_t P_len,
2667 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002668{
Janos Follath865b3eb2019-12-16 11:46:15 +00002669 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002670
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 mbedtls_mpi_free(&conf->dhm_P);
2672 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002673
Gilles Peskine449bd832023-01-11 14:50:10 +01002674 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2675 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2676 mbedtls_mpi_free(&conf->dhm_P);
2677 mbedtls_mpi_free(&conf->dhm_G);
2678 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002679 }
2680
Gilles Peskine449bd832023-01-11 14:50:10 +01002681 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002682}
Paul Bakker5121ce52009-01-03 21:22:43 +00002683
Gilles Peskine449bd832023-01-11 14:50:10 +01002684int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002685{
Janos Follath865b3eb2019-12-16 11:46:15 +00002686 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002687
Gilles Peskine449bd832023-01-11 14:50:10 +01002688 mbedtls_mpi_free(&conf->dhm_P);
2689 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002690
Gilles Peskine449bd832023-01-11 14:50:10 +01002691 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2692 &conf->dhm_P)) != 0 ||
2693 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2694 &conf->dhm_G)) != 0) {
2695 mbedtls_mpi_free(&conf->dhm_P);
2696 mbedtls_mpi_free(&conf->dhm_G);
2697 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002698 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002699
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002701}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002702#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002703
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002704#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2705/*
2706 * Set the minimum length for Diffie-Hellman parameters
2707 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002708void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2709 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002710{
2711 conf->dhm_min_bitlen = bitlen;
2712}
2713#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2714
Ronald Crone68ab4f2022-10-05 12:46:29 +02002715#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002716#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002717/*
2718 * Set allowed/preferred hashes for handshake signatures
2719 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002720void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2721 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002722{
2723 conf->sig_hashes = hashes;
2724}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002725#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002726
Jerry Yuf017ee42022-01-12 15:49:48 +08002727/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002728void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2729 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002730{
Jerry Yuf017ee42022-01-12 15:49:48 +08002731#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2732 conf->sig_hashes = NULL;
2733#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2734 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002735}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002736#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002737
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002738#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002739#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002740/*
2741 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002742 *
2743 * mbedtls_ssl_setup() takes the provided list
2744 * and translates it to a list of IANA TLS group identifiers,
2745 * stored in ssl->handshake->group_list.
2746 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002747 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002748void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2749 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002750{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002751 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002752 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002753}
Brett Warrene0edc842021-08-17 09:53:13 +01002754#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002755#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002756
Brett Warrene0edc842021-08-17 09:53:13 +01002757/*
2758 * Set the allowed groups
2759 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002760void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2761 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002762{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002763#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002764 conf->curve_list = NULL;
2765#endif
2766 conf->group_list = group_list;
2767}
2768
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002769#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002770int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002771{
Hanno Becker947194e2017-04-07 13:25:49 +01002772 /* Initialize to suppress unnecessary compiler warning */
2773 size_t hostname_len = 0;
2774
2775 /* Check if new hostname is valid before
2776 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002777 if (hostname != NULL) {
2778 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002779
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2781 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2782 }
Hanno Becker947194e2017-04-07 13:25:49 +01002783 }
2784
2785 /* Now it's clear that we will overwrite the old hostname,
2786 * so we can free it safely */
2787
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002789 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002790 }
2791
2792 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002793
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002795 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002796 } else {
2797 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2798 if (ssl->hostname == NULL) {
2799 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2800 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002801
Gilles Peskine449bd832023-01-11 14:50:10 +01002802 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002803
Hanno Becker947194e2017-04-07 13:25:49 +01002804 ssl->hostname[hostname_len] = '\0';
2805 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002806
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002808}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002809#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002810
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002811#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002812void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2813 int (*f_sni)(void *, mbedtls_ssl_context *,
2814 const unsigned char *, size_t),
2815 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002816{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002817 conf->f_sni = f_sni;
2818 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002819}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002820#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002821
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002822#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002823int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002824{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002825 size_t cur_len, tot_len;
2826 const char **p;
2827
2828 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002829 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2830 * MUST NOT be truncated."
2831 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002832 */
2833 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002834 for (p = protos; *p != NULL; p++) {
2835 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002836 tot_len += cur_len;
2837
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 if ((cur_len == 0) ||
2839 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2840 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2841 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2842 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002843 }
2844
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002845 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002846
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002848}
2849
Gilles Peskine449bd832023-01-11 14:50:10 +01002850const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002851{
Gilles Peskine449bd832023-01-11 14:50:10 +01002852 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002853}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002854#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002855
Johan Pascalb62bb512015-12-03 21:56:45 +01002856#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002857void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2858 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002859{
2860 conf->dtls_srtp_mki_support = support_mki_value;
2861}
2862
Gilles Peskine449bd832023-01-11 14:50:10 +01002863int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2864 unsigned char *mki_value,
2865 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002866{
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2868 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002869 }
Ron Eldor591f1622018-01-22 12:30:04 +02002870
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2872 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002873 }
Ron Eldor591f1622018-01-22 12:30:04 +02002874
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002876 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002878}
2879
Gilles Peskine449bd832023-01-11 14:50:10 +01002880int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2881 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002882{
Johan Pascal253d0262020-09-22 13:04:45 +02002883 const mbedtls_ssl_srtp_profile *p;
2884 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002885
Johan Pascal253d0262020-09-22 13:04:45 +02002886 /* check the profiles list: all entry must be valid,
2887 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002888 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2889 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2890 p++) {
2891 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002892 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002893 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002894 /* unsupported value, stop parsing and set the size to an error value */
2895 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002896 }
2897 }
2898
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2900 conf->dtls_srtp_profile_list = NULL;
2901 conf->dtls_srtp_profile_list_len = 0;
2902 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002903 }
2904
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002905 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002906 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002907
Gilles Peskine449bd832023-01-11 14:50:10 +01002908 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002909}
2910
Gilles Peskine449bd832023-01-11 14:50:10 +01002911void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2912 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002913{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002914 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2915 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002916 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002917 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002919 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002920 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2921 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002922 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002923}
Johan Pascalb62bb512015-12-03 21:56:45 +01002924#endif /* MBEDTLS_SSL_DTLS_SRTP */
2925
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302926#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002927void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002928{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002929 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002930}
2931
Gilles Peskine449bd832023-01-11 14:50:10 +01002932void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002933{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002934 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002935}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302936#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002937
Janos Follath088ce432017-04-10 12:42:31 +01002938#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002939void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2940 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002941{
2942 conf->cert_req_ca_list = cert_req_ca_list;
2943}
2944#endif
2945
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002946#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002947void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002948{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002949 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002950}
2951#endif
2952
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002953#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002954void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002955{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002956 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002957}
2958#endif
2959
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002960#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002961int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002962{
Gilles Peskine449bd832023-01-11 14:50:10 +01002963 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2964 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2965 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002966 }
2967
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002968 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002969
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002971}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002972#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002973
Gilles Peskine449bd832023-01-11 14:50:10 +01002974void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002975{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002976 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002977}
2978
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002979#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002980void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002981{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002982 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002983}
2984
Gilles Peskine449bd832023-01-11 14:50:10 +01002985void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002986{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002987 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002988}
2989
Gilles Peskine449bd832023-01-11 14:50:10 +01002990void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
2991 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002992{
Gilles Peskine449bd832023-01-11 14:50:10 +01002993 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002994}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002995#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002996
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002997#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002998#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002999void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003000{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003001 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003002}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003003#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003004
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003005#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003006
Jerry Yud0766ec2022-09-22 10:46:57 +08003007#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003008void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3009 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003010{
Jerry Yud0766ec2022-09-22 10:46:57 +08003011 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003012}
3013#endif
3014
Gilles Peskine449bd832023-01-11 14:50:10 +01003015void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3016 mbedtls_ssl_ticket_write_t *f_ticket_write,
3017 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3018 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003019{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003020 conf->f_ticket_write = f_ticket_write;
3021 conf->f_ticket_parse = f_ticket_parse;
3022 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003023}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003024#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003025#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003026
Gilles Peskine449bd832023-01-11 14:50:10 +01003027void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3028 mbedtls_ssl_export_keys_t *f_export_keys,
3029 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003030{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003031 ssl->f_export_keys = f_export_keys;
3032 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003033}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003034
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003035#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003036void mbedtls_ssl_conf_async_private_cb(
3037 mbedtls_ssl_config *conf,
3038 mbedtls_ssl_async_sign_t *f_async_sign,
3039 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3040 mbedtls_ssl_async_resume_t *f_async_resume,
3041 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003043{
3044 conf->f_async_sign_start = f_async_sign;
3045 conf->f_async_decrypt_start = f_async_decrypt;
3046 conf->f_async_resume = f_async_resume;
3047 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003048 conf->p_async_config_data = async_config_data;
3049}
3050
Gilles Peskine449bd832023-01-11 14:50:10 +01003051void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003052{
Gilles Peskine449bd832023-01-11 14:50:10 +01003053 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003054}
3055
Gilles Peskine449bd832023-01-11 14:50:10 +01003056void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003057{
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 if (ssl->handshake == NULL) {
3059 return NULL;
3060 } else {
3061 return ssl->handshake->user_async_ctx;
3062 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003063}
3064
Gilles Peskine449bd832023-01-11 14:50:10 +01003065void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3066 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003067{
Gilles Peskine449bd832023-01-11 14:50:10 +01003068 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003069 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003070 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003071}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003072#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003073
Paul Bakker5121ce52009-01-03 21:22:43 +00003074/*
3075 * SSL get accessors
3076 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003077uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003078{
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 if (ssl->session != NULL) {
3080 return ssl->session->verify_result;
3081 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003082
Gilles Peskine449bd832023-01-11 14:50:10 +01003083 if (ssl->session_negotiate != NULL) {
3084 return ssl->session_negotiate->verify_result;
3085 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003086
Gilles Peskine449bd832023-01-11 14:50:10 +01003087 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003088}
3089
Gilles Peskine449bd832023-01-11 14:50:10 +01003090int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003091{
Gilles Peskine449bd832023-01-11 14:50:10 +01003092 if (ssl == NULL || ssl->session == NULL) {
3093 return 0;
3094 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003095
Gilles Peskine449bd832023-01-11 14:50:10 +01003096 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003097}
3098
Gilles Peskine449bd832023-01-11 14:50:10 +01003099const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003100{
Gilles Peskine449bd832023-01-11 14:50:10 +01003101 if (ssl == NULL || ssl->session == NULL) {
3102 return NULL;
3103 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003104
Gilles Peskine449bd832023-01-11 14:50:10 +01003105 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003106}
3107
Gilles Peskine449bd832023-01-11 14:50:10 +01003108const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003109{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003110#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003111 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3112 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003113 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003114 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003115 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003116 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003117 }
3118 }
3119#endif
3120
Gilles Peskine449bd832023-01-11 14:50:10 +01003121 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003122 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003123 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003124 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003125 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003126 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003128 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003129}
3130
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003131#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3132
3133size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3134{
3135 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3136 size_t record_size_limit = max_len;
3137
3138 if (ssl->session != NULL &&
3139 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3140 ssl->session->record_size_limit < max_len) {
3141 record_size_limit = ssl->session->record_size_limit;
3142 }
3143
3144 // TODO: this is currently untested
3145 /* During a handshake, use the value being negotiated */
3146 if (ssl->session_negotiate != NULL &&
3147 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3148 ssl->session_negotiate->record_size_limit < max_len) {
3149 record_size_limit = ssl->session_negotiate->record_size_limit;
3150 }
3151
3152 return record_size_limit;
3153}
3154#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3155
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003156#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003157size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003158{
David Horstmann95d516f2021-05-04 18:36:56 +01003159 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003160 size_t read_mfl;
3161
Jerry Yuddda0502022-12-01 19:43:12 +08003162#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003163 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003164 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3165 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3166 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003167 }
Jerry Yuddda0502022-12-01 19:43:12 +08003168#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003169
3170 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003171 if (ssl->session_out != NULL) {
3172 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3173 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003174 max_len = read_mfl;
3175 }
3176 }
3177
Jerry Yuddda0502022-12-01 19:43:12 +08003178 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003179 if (ssl->session_negotiate != NULL) {
3180 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3181 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003182 max_len = read_mfl;
3183 }
3184 }
3185
Gilles Peskine449bd832023-01-11 14:50:10 +01003186 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003187}
3188
Gilles Peskine449bd832023-01-11 14:50:10 +01003189size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003190{
3191 size_t max_len;
3192
3193 /*
3194 * Assume mfl_code is correct since it was checked when set
3195 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003196 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003197
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003198 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003199 if (ssl->session_out != NULL &&
3200 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3201 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003202 }
3203
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003204 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003205 if (ssl->session_negotiate != NULL &&
3206 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3207 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003208 }
3209
Gilles Peskine449bd832023-01-11 14:50:10 +01003210 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003211}
3212#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3213
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003214#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003215size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003216{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003217 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003218 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3219 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3220 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3221 return 0;
3222 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003223
Gilles Peskine449bd832023-01-11 14:50:10 +01003224 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3225 return ssl->mtu;
3226 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003227
Gilles Peskine449bd832023-01-11 14:50:10 +01003228 if (ssl->mtu == 0) {
3229 return ssl->handshake->mtu;
3230 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003231
Gilles Peskine449bd832023-01-11 14:50:10 +01003232 return ssl->mtu < ssl->handshake->mtu ?
3233 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003234}
3235#endif /* MBEDTLS_SSL_PROTO_DTLS */
3236
Gilles Peskine449bd832023-01-11 14:50:10 +01003237int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003238{
3239 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3240
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003241#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003242 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003243 !defined(MBEDTLS_SSL_PROTO_DTLS)
3244 (void) ssl;
3245#endif
3246
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003247#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003248 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003249
Gilles Peskine449bd832023-01-11 14:50:10 +01003250 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003251 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003252 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003253#endif
3254
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003255#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3256 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3257
3258 if (max_len > record_size_limit) {
3259 max_len = record_size_limit;
3260 }
3261#endif
3262
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003263 if (ssl->transform_out != NULL &&
3264 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003265 /*
3266 * In TLS 1.3 case, when records are protected, `max_len` as computed
3267 * above is the maximum length of the TLSInnerPlaintext structure that
3268 * along the plaintext payload contains the inner content type (one byte)
3269 * and some zero padding. Given the algorithm used for padding
3270 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3271 * the plaintext payload. Round down to a multiple of
3272 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3273 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003274 */
3275 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3276 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3277 }
3278
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003279#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003280 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3281 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3282 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003283 const size_t overhead = (size_t) ret;
3284
Gilles Peskine449bd832023-01-11 14:50:10 +01003285 if (ret < 0) {
3286 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003287 }
3288
Gilles Peskine449bd832023-01-11 14:50:10 +01003289 if (mtu <= overhead) {
3290 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3291 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3292 }
3293
3294 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003295 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003296 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003297 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003298#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003299
Hanno Becker0defedb2018-08-10 12:35:02 +01003300#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003301 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3302 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003303 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003304#endif
3305
Gilles Peskine449bd832023-01-11 14:50:10 +01003306 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003307}
3308
Gilles Peskine449bd832023-01-11 14:50:10 +01003309int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003310{
3311 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3312
3313#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3314 (void) ssl;
3315#endif
3316
3317#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003318 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003319
Gilles Peskine449bd832023-01-11 14:50:10 +01003320 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003321 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003322 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003323#endif
3324
Gilles Peskine449bd832023-01-11 14:50:10 +01003325 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003326}
3327
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003328#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003329const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003330{
Gilles Peskine449bd832023-01-11 14:50:10 +01003331 if (ssl == NULL || ssl->session == NULL) {
3332 return NULL;
3333 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003334
Hanno Beckere6824572019-02-07 13:18:46 +00003335#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003336 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003337#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003338 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003339#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003340}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003341#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003342
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003343#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003344int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3345 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003346{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003347 int ret;
3348
Gilles Peskine449bd832023-01-11 14:50:10 +01003349 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003350 dst == NULL ||
3351 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003352 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3353 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003354 }
3355
Hanno Beckere810bbc2021-05-14 16:01:05 +01003356 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3357 * idempotent: Each session can only be exported once.
3358 *
3359 * (This is in preparation for TLS 1.3 support where we will
3360 * need the ability to export multiple sessions (aka tickets),
3361 * which will be achieved by calling mbedtls_ssl_get_session()
3362 * multiple times until it fails.)
3363 *
3364 * Check whether we have already exported the current session,
3365 * and fail if so.
3366 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003367 if (ssl->session->exported == 1) {
3368 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3369 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003370
Gilles Peskine449bd832023-01-11 14:50:10 +01003371 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3372 if (ret != 0) {
3373 return ret;
3374 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003375
3376 /* Remember that we've exported the session. */
3377 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003378 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003379}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003380#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003381
David Horstmanncb01b362024-02-29 17:31:46 +00003382#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3383
3384/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003385 *
David Horstmanncb01b362024-02-29 17:31:46 +00003386 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003387 */
3388static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3389 unsigned char *buf,
3390 size_t buf_len)
3391{
3392 unsigned char *p = buf;
3393 size_t used = 0;
3394
3395#if defined(MBEDTLS_HAVE_TIME)
3396 uint64_t start;
3397#endif
3398#if defined(MBEDTLS_X509_CRT_PARSE_C)
3399#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3400 size_t cert_len;
3401#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3402#endif /* MBEDTLS_X509_CRT_PARSE_C */
3403
3404 /*
3405 * Time
3406 */
3407#if defined(MBEDTLS_HAVE_TIME)
3408 used += 8;
3409
3410 if (used <= buf_len) {
3411 start = (uint64_t) session->start;
3412
3413 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3414 p += 8;
3415 }
3416#endif /* MBEDTLS_HAVE_TIME */
3417
3418 /*
3419 * Basic mandatory fields
3420 */
3421 used += 1 /* id_len */
3422 + sizeof(session->id)
3423 + sizeof(session->master)
3424 + 4; /* verify_result */
3425
3426 if (used <= buf_len) {
3427 *p++ = MBEDTLS_BYTE_0(session->id_len);
3428 memcpy(p, session->id, 32);
3429 p += 32;
3430
3431 memcpy(p, session->master, 48);
3432 p += 48;
3433
3434 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3435 p += 4;
3436 }
3437
3438 /*
3439 * Peer's end-entity certificate
3440 */
3441#if defined(MBEDTLS_X509_CRT_PARSE_C)
3442#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3443 if (session->peer_cert == NULL) {
3444 cert_len = 0;
3445 } else {
3446 cert_len = session->peer_cert->raw.len;
3447 }
3448
3449 used += 3 + cert_len;
3450
3451 if (used <= buf_len) {
3452 *p++ = MBEDTLS_BYTE_2(cert_len);
3453 *p++ = MBEDTLS_BYTE_1(cert_len);
3454 *p++ = MBEDTLS_BYTE_0(cert_len);
3455
3456 if (session->peer_cert != NULL) {
3457 memcpy(p, session->peer_cert->raw.p, cert_len);
3458 p += cert_len;
3459 }
3460 }
3461#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3462 if (session->peer_cert_digest != NULL) {
3463 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3464 if (used <= buf_len) {
3465 *p++ = (unsigned char) session->peer_cert_digest_type;
3466 *p++ = (unsigned char) session->peer_cert_digest_len;
3467 memcpy(p, session->peer_cert_digest,
3468 session->peer_cert_digest_len);
3469 p += session->peer_cert_digest_len;
3470 }
3471 } else {
3472 used += 2;
3473 if (used <= buf_len) {
3474 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3475 *p++ = 0;
3476 }
3477 }
3478#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3479#endif /* MBEDTLS_X509_CRT_PARSE_C */
3480
3481 /*
3482 * Session ticket if any, plus associated data
3483 */
3484#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3485#if defined(MBEDTLS_SSL_CLI_C)
3486 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3487 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3488
3489 if (used <= buf_len) {
3490 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3491 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3492 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3493
3494 if (session->ticket != NULL) {
3495 memcpy(p, session->ticket, session->ticket_len);
3496 p += session->ticket_len;
3497 }
3498
3499 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3500 p += 4;
3501 }
3502 }
3503#endif /* MBEDTLS_SSL_CLI_C */
3504#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3505 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3506 used += 8;
3507
3508 if (used <= buf_len) {
3509 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3510 p += 8;
3511 }
3512 }
3513#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3514#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3515
3516 /*
3517 * Misc extension-related info
3518 */
3519#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3520 used += 1;
3521
3522 if (used <= buf_len) {
3523 *p++ = session->mfl_code;
3524 }
3525#endif
3526
3527#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3528 used += 1;
3529
3530 if (used <= buf_len) {
3531 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3532 }
3533#endif
3534
3535 return used;
3536}
3537
3538MBEDTLS_CHECK_RETURN_CRITICAL
3539static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3540 const unsigned char *buf,
3541 size_t len)
3542{
3543#if defined(MBEDTLS_HAVE_TIME)
3544 uint64_t start;
3545#endif
3546#if defined(MBEDTLS_X509_CRT_PARSE_C)
3547#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3548 size_t cert_len;
3549#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3550#endif /* MBEDTLS_X509_CRT_PARSE_C */
3551
3552 const unsigned char *p = buf;
3553 const unsigned char * const end = buf + len;
3554
3555 /*
3556 * Time
3557 */
3558#if defined(MBEDTLS_HAVE_TIME)
3559 if (8 > (size_t) (end - p)) {
3560 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3561 }
3562
3563 start = MBEDTLS_GET_UINT64_BE(p, 0);
3564 p += 8;
3565
3566 session->start = (time_t) start;
3567#endif /* MBEDTLS_HAVE_TIME */
3568
3569 /*
3570 * Basic mandatory fields
3571 */
3572 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3573 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3574 }
3575
3576 session->id_len = *p++;
3577 memcpy(session->id, p, 32);
3578 p += 32;
3579
3580 memcpy(session->master, p, 48);
3581 p += 48;
3582
3583 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3584 p += 4;
3585
3586 /* Immediately clear invalid pointer values that have been read, in case
3587 * we exit early before we replaced them with valid ones. */
3588#if defined(MBEDTLS_X509_CRT_PARSE_C)
3589#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3590 session->peer_cert = NULL;
3591#else
3592 session->peer_cert_digest = NULL;
3593#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3594#endif /* MBEDTLS_X509_CRT_PARSE_C */
3595#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3596 session->ticket = NULL;
3597#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3598
3599 /*
3600 * Peer certificate
3601 */
3602#if defined(MBEDTLS_X509_CRT_PARSE_C)
3603#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3604 /* Deserialize CRT from the end of the ticket. */
3605 if (3 > (size_t) (end - p)) {
3606 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3607 }
3608
3609 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3610 p += 3;
3611
3612 if (cert_len != 0) {
3613 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3614
3615 if (cert_len > (size_t) (end - p)) {
3616 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3617 }
3618
3619 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3620
3621 if (session->peer_cert == NULL) {
3622 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3623 }
3624
3625 mbedtls_x509_crt_init(session->peer_cert);
3626
3627 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3628 p, cert_len)) != 0) {
3629 mbedtls_x509_crt_free(session->peer_cert);
3630 mbedtls_free(session->peer_cert);
3631 session->peer_cert = NULL;
3632 return ret;
3633 }
3634
3635 p += cert_len;
3636 }
3637#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3638 /* Deserialize CRT digest from the end of the ticket. */
3639 if (2 > (size_t) (end - p)) {
3640 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3641 }
3642
3643 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3644 session->peer_cert_digest_len = (size_t) *p++;
3645
3646 if (session->peer_cert_digest_len != 0) {
3647 const mbedtls_md_info_t *md_info =
3648 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3649 if (md_info == NULL) {
3650 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3651 }
3652 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3653 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3654 }
3655
3656 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3657 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3658 }
3659
3660 session->peer_cert_digest =
3661 mbedtls_calloc(1, session->peer_cert_digest_len);
3662 if (session->peer_cert_digest == NULL) {
3663 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3664 }
3665
3666 memcpy(session->peer_cert_digest, p,
3667 session->peer_cert_digest_len);
3668 p += session->peer_cert_digest_len;
3669 }
3670#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3671#endif /* MBEDTLS_X509_CRT_PARSE_C */
3672
3673 /*
3674 * Session ticket and associated data
3675 */
3676#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3677#if defined(MBEDTLS_SSL_CLI_C)
3678 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3679 if (3 > (size_t) (end - p)) {
3680 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3681 }
3682
3683 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3684 p += 3;
3685
3686 if (session->ticket_len != 0) {
3687 if (session->ticket_len > (size_t) (end - p)) {
3688 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3689 }
3690
3691 session->ticket = mbedtls_calloc(1, session->ticket_len);
3692 if (session->ticket == NULL) {
3693 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3694 }
3695
3696 memcpy(session->ticket, p, session->ticket_len);
3697 p += session->ticket_len;
3698 }
3699
3700 if (4 > (size_t) (end - p)) {
3701 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3702 }
3703
3704 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3705 p += 4;
3706 }
3707#endif /* MBEDTLS_SSL_CLI_C */
3708#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3709 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3710 if (8 > (size_t) (end - p)) {
3711 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3712 }
3713 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3714 p += 8;
3715 }
3716#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3717#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3718
3719 /*
3720 * Misc extension-related info
3721 */
3722#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3723 if (1 > (size_t) (end - p)) {
3724 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3725 }
3726
3727 session->mfl_code = *p++;
3728#endif
3729
3730#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3731 if (1 > (size_t) (end - p)) {
3732 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3733 }
3734
3735 session->encrypt_then_mac = *p++;
3736#endif
3737
3738 /* Done, should have consumed entire buffer */
3739 if (p != end) {
3740 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3741 }
3742
3743 return 0;
3744}
3745
3746#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3747
3748#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3749/* Serialization of TLS 1.3 sessions:
3750 *
David Horstmanncb01b362024-02-29 17:31:46 +00003751 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003752 */
3753#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3754MBEDTLS_CHECK_RETURN_CRITICAL
3755static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3756 unsigned char *buf,
3757 size_t buf_len,
3758 size_t *olen)
3759{
3760 unsigned char *p = buf;
3761#if defined(MBEDTLS_SSL_CLI_C) && \
3762 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3763 size_t hostname_len = (session->hostname == NULL) ?
3764 0 : strlen(session->hostname) + 1;
3765#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003766
3767#if defined(MBEDTLS_SSL_SRV_C) && \
3768 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003769 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003770 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003771#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003772 size_t needed = 4 /* ticket_age_add */
3773 + 1 /* ticket_flags */
3774 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003775
David Horstmanne59f9702024-02-29 16:08:57 +00003776 *olen = 0;
3777
3778 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3779 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3780 }
3781 needed += session->resumption_key_len; /* resumption_key */
3782
3783#if defined(MBEDTLS_SSL_EARLY_DATA)
3784 needed += 4; /* max_early_data_size */
3785#endif
3786#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3787 needed += 2; /* record_size_limit */
3788#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3789
3790#if defined(MBEDTLS_HAVE_TIME)
3791 needed += 8; /* ticket_creation_time or ticket_reception_time */
3792#endif
3793
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003794#if defined(MBEDTLS_SSL_SRV_C)
3795 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3796#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003797 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003798 + alpn_len; /* alpn */
3799#endif
3800 }
3801#endif /* MBEDTLS_SSL_SRV_C */
3802
David Horstmanne59f9702024-02-29 16:08:57 +00003803#if defined(MBEDTLS_SSL_CLI_C)
3804 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3805#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3806 needed += 2 /* hostname_len */
3807 + hostname_len; /* hostname */
3808#endif
3809
3810 needed += 4 /* ticket_lifetime */
3811 + 2; /* ticket_len */
3812
3813 /* Check size_t overflow */
3814 if (session->ticket_len > SIZE_MAX - needed) {
3815 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3816 }
3817
3818 needed += session->ticket_len; /* ticket */
3819 }
3820#endif /* MBEDTLS_SSL_CLI_C */
3821
3822 *olen = needed;
3823 if (needed > buf_len) {
3824 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3825 }
3826
3827 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3828 p[4] = session->ticket_flags;
3829
3830 /* save resumption_key */
3831 p[5] = session->resumption_key_len;
3832 p += 6;
3833 memcpy(p, session->resumption_key, session->resumption_key_len);
3834 p += session->resumption_key_len;
3835
3836#if defined(MBEDTLS_SSL_EARLY_DATA)
3837 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3838 p += 4;
3839#endif
3840#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3841 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3842 p += 2;
3843#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3844
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003845#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003846 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003847#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003848 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3849 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003850#endif /* MBEDTLS_HAVE_TIME */
3851
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003852#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003853 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3854 p += 2;
3855
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003856 if (alpn_len > 0) {
3857 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003858 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003859 p += alpn_len;
3860 }
3861#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3862 }
3863#endif /* MBEDTLS_SSL_SRV_C */
3864
David Horstmanne59f9702024-02-29 16:08:57 +00003865#if defined(MBEDTLS_SSL_CLI_C)
3866 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3867#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3868 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3869 p += 2;
3870 if (hostname_len > 0) {
3871 /* save host name */
3872 memcpy(p, session->hostname, hostname_len);
3873 p += hostname_len;
3874 }
3875#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3876
3877#if defined(MBEDTLS_HAVE_TIME)
3878 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3879 p += 8;
3880#endif
3881 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3882 p += 4;
3883
3884 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3885 p += 2;
3886
3887 if (session->ticket != NULL && session->ticket_len > 0) {
3888 memcpy(p, session->ticket, session->ticket_len);
3889 p += session->ticket_len;
3890 }
3891 }
3892#endif /* MBEDTLS_SSL_CLI_C */
3893 return 0;
3894}
3895
3896MBEDTLS_CHECK_RETURN_CRITICAL
3897static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3898 const unsigned char *buf,
3899 size_t len)
3900{
3901 const unsigned char *p = buf;
3902 const unsigned char *end = buf + len;
3903
3904 if (end - p < 6) {
3905 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3906 }
3907 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3908 session->ticket_flags = p[4];
3909
3910 /* load resumption_key */
3911 session->resumption_key_len = p[5];
3912 p += 6;
3913
3914 if (end - p < session->resumption_key_len) {
3915 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3916 }
3917
3918 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3919 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3920 }
3921 memcpy(session->resumption_key, p, session->resumption_key_len);
3922 p += session->resumption_key_len;
3923
3924#if defined(MBEDTLS_SSL_EARLY_DATA)
3925 if (end - p < 4) {
3926 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3927 }
3928 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3929 p += 4;
3930#endif
3931#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3932 if (end - p < 2) {
3933 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3934 }
3935 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3936 p += 2;
3937#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3938
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003939#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003940 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003941#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003942 if (end - p < 8) {
3943 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3944 }
3945 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3946 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003947#endif /* MBEDTLS_HAVE_TIME */
3948
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003949#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003950 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003951
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003952 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003953 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3954 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003955
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003956 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3957 p += 2;
3958
3959 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003960 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3961 }
3962
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003963 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003964 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3965 if (ret != 0) {
3966 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003967 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003968 p += alpn_len;
3969 }
3970#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3971 }
3972#endif /* MBEDTLS_SSL_SRV_C */
3973
David Horstmanne59f9702024-02-29 16:08:57 +00003974#if defined(MBEDTLS_SSL_CLI_C)
3975 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3976#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3977 size_t hostname_len;
3978 /* load host name */
3979 if (end - p < 2) {
3980 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3981 }
3982 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3983 p += 2;
3984
3985 if (end - p < (long int) hostname_len) {
3986 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3987 }
3988 if (hostname_len > 0) {
3989 session->hostname = mbedtls_calloc(1, hostname_len);
3990 if (session->hostname == NULL) {
3991 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3992 }
3993 memcpy(session->hostname, p, hostname_len);
3994 p += hostname_len;
3995 }
3996#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3997
3998#if defined(MBEDTLS_HAVE_TIME)
3999 if (end - p < 8) {
4000 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4001 }
4002 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
4003 p += 8;
4004#endif
4005 if (end - p < 4) {
4006 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4007 }
4008 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
4009 p += 4;
4010
4011 if (end - p < 2) {
4012 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4013 }
4014 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
4015 p += 2;
4016
4017 if (end - p < (long int) session->ticket_len) {
4018 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4019 }
4020 if (session->ticket_len > 0) {
4021 session->ticket = mbedtls_calloc(1, session->ticket_len);
4022 if (session->ticket == NULL) {
4023 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4024 }
4025 memcpy(session->ticket, p, session->ticket_len);
4026 p += session->ticket_len;
4027 }
4028 }
4029#endif /* MBEDTLS_SSL_CLI_C */
4030
4031 return 0;
4032
4033}
4034#else /* MBEDTLS_SSL_SESSION_TICKETS */
4035MBEDTLS_CHECK_RETURN_CRITICAL
4036static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
4037 unsigned char *buf,
4038 size_t buf_len,
4039 size_t *olen)
4040{
4041 ((void) session);
4042 ((void) buf);
4043 ((void) buf_len);
4044 *olen = 0;
4045 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4046}
4047
4048static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01004049 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00004050 size_t buf_len)
4051{
4052 ((void) session);
4053 ((void) buf);
4054 ((void) buf_len);
4055 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4056}
4057#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
4058#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4059
Paul Bakker5121ce52009-01-03 21:22:43 +00004060/*
Hanno Beckera835da52019-05-16 12:39:07 +01004061 * Define ticket header determining Mbed TLS version
4062 * and structure of the ticket.
4063 */
4064
Hanno Becker94ef3b32019-05-16 12:50:45 +01004065/*
Hanno Becker50b59662019-05-28 14:30:45 +01004066 * Define bitflag determining compile-time settings influencing
4067 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01004068 */
4069
Hanno Becker50b59662019-05-28 14:30:45 +01004070#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01004071#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01004072#else
Hanno Becker3e088662019-05-29 11:10:18 +01004073#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004074#endif /* MBEDTLS_HAVE_TIME */
4075
4076#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004077#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004078#else
Hanno Becker3e088662019-05-29 11:10:18 +01004079#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004080#endif /* MBEDTLS_X509_CRT_PARSE_C */
4081
David Horstmann5c5a32f2024-02-13 17:53:35 +00004082#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00004083#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00004084#else
David Horstmannf686f1d2024-03-01 11:20:32 +00004085#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00004086#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4087
Hanno Becker94ef3b32019-05-16 12:50:45 +01004088#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004089#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004090#else
Hanno Becker3e088662019-05-29 11:10:18 +01004091#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004092#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4093
4094#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004095#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004096#else
Hanno Becker3e088662019-05-29 11:10:18 +01004097#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004098#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4099
Hanno Becker94ef3b32019-05-16 12:50:45 +01004100#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004101#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004102#else
Hanno Becker3e088662019-05-29 11:10:18 +01004103#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004104#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4105
Hanno Becker94ef3b32019-05-16 12:50:45 +01004106#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4107#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4108#else
4109#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4110#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4111
David Horstmann92b258b2024-02-13 17:23:34 +00004112#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4113#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
4114#else
4115#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
4116#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4117
4118#if defined(MBEDTLS_SSL_EARLY_DATA)
4119#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
4120#else
4121#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
4122#endif /* MBEDTLS_SSL_EARLY_DATA */
4123
4124#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4125#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
4126#else
4127#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
4128#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
4129
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004130#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
4131 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00004132#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
4133#else
4134#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
4135#endif /* MBEDTLS_SSL_ALPN */
4136
Hanno Becker3e088662019-05-29 11:10:18 +01004137#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4138#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4139#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4140#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004141#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4142#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00004143#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00004144#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
4145#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
4146#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00004147#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01004148
Hanno Becker50b59662019-05-28 14:30:45 +01004149#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004150 ((uint16_t) ( \
4151 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
4152 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
4153 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
4154 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
4155 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
4156 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00004157 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00004158 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
4159 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00004160 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
4161 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
4162 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
4163 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004164 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00004165 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004166 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01004167
Chien Wong4e9683e2023-12-28 17:07:43 +08004168static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004169 MBEDTLS_VERSION_MAJOR,
4170 MBEDTLS_VERSION_MINOR,
4171 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004172 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4173 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01004174};
Hanno Beckera835da52019-05-16 12:39:07 +01004175
4176/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004177 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004178 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004179 *
David Horstmanncb01b362024-02-29 17:31:46 +00004180 * TLS 1.2 session:
4181 *
4182 * struct {
4183 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
4184 * opaque ticket<0..2^24-1>; // length 0 means no ticket
4185 * uint32 ticket_lifetime;
4186 * #endif
4187 * } ClientOnlyData;
4188 *
4189 * struct {
4190 * #if defined(MBEDTLS_HAVE_TIME)
4191 * uint64 start_time;
4192 * #endif
4193 * uint8 session_id_len; // at most 32
4194 * opaque session_id[32];
4195 * opaque master[48]; // fixed length in the standard
4196 * uint32 verify_result;
4197 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
4198 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
4199 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00004200 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00004201 * opaque peer_cert_digest<0..2^8-1>
4202 * #endif
4203 * select (endpoint) {
4204 * case client: ClientOnlyData;
4205 * case server: uint64 ticket_creation_time;
4206 * };
4207 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4208 * uint8 mfl_code; // up to 255 according to standard
4209 * #endif
4210 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4211 * uint8 encrypt_then_mac; // 0 or 1
4212 * #endif
4213 * } serialized_session_tls12;
4214 *
4215 *
4216 * TLS 1.3 Session:
4217 *
4218 * struct {
4219 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4220 * opaque hostname<0..2^16-1>;
4221 * #endif
4222 * #if defined(MBEDTLS_HAVE_TIME)
4223 * uint64 ticket_reception_time;
4224 * #endif
4225 * uint32 ticket_lifetime;
4226 * opaque ticket<1..2^16-1>;
4227 * } ClientOnlyData;
4228 *
4229 * struct {
4230 * uint32 ticket_age_add;
4231 * uint8 ticket_flags;
4232 * opaque resumption_key<0..255>;
4233 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4234 * uint32 max_early_data_size;
4235 * #endif
4236 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4237 * uint16 record_size_limit;
4238 * #endif
4239 * select ( endpoint ) {
4240 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004241 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00004242 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004243 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00004244 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004245 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004246 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00004247 * #endif
4248 * };
4249 * } serialized_session_tls13;
4250 *
4251 *
4252 * SSL session:
4253 *
4254 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004255 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004256 * opaque mbedtls_version[3]; // library version: major, minor, patch
4257 * opaque session_format[2]; // library-version specific 16-bit field
4258 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004259 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004260 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004261 * Note: When updating the format, remember to keep
4262 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004263 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004264 * // In this version, `session_format` determines
4265 * // the setting of those compile-time
4266 * // configuration options which influence
4267 * // the structure of mbedtls_ssl_session.
4268 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004269 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004270 * // - TLS 1.2 (0x0303)
4271 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004272 * uint8_t endpoint;
4273 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004274 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004275 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004276 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004277 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004278 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004279 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004280 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004281 *
4282 * };
4283 *
4284 * } serialized_session;
4285 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004286 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004287
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004288MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004289static int ssl_session_save(const mbedtls_ssl_session *session,
4290 unsigned char omit_header,
4291 unsigned char *buf,
4292 size_t buf_len,
4293 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004294{
4295 unsigned char *p = buf;
4296 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004297 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004298#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4299 size_t out_len;
4300 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4301#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004302 if (session == NULL) {
4303 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4304 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004305
Gilles Peskine449bd832023-01-11 14:50:10 +01004306 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004307 /*
4308 * Add Mbed TLS version identifier
4309 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004310 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004311
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 if (used <= buf_len) {
4313 memcpy(p, ssl_serialized_session_header,
4314 sizeof(ssl_serialized_session_header));
4315 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004316 }
4317 }
4318
4319 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004320 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004321 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004322 used += 1 /* TLS version */
4323 + 1 /* endpoint */
4324 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004325 if (used <= buf_len) {
4326 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004327 *p++ = session->endpoint;
4328 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4329 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004330 }
4331
4332 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004333 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004334 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004335#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004336 case MBEDTLS_SSL_VERSION_TLS1_2:
4337 used += ssl_tls12_session_save(session, p, remaining_len);
4338 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004339#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4340
Jerry Yu251a12e2022-07-13 15:15:48 +08004341#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004342 case MBEDTLS_SSL_VERSION_TLS1_3:
4343 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4344 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4345 return ret;
4346 }
4347 used += out_len;
4348 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004349#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4350
Gilles Peskine449bd832023-01-11 14:50:10 +01004351 default:
4352 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004353 }
4354
4355 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004356 if (used > buf_len) {
4357 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4358 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004359
Gilles Peskine449bd832023-01-11 14:50:10 +01004360 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004361}
4362
4363/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004364 * Public wrapper for ssl_session_save()
4365 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004366int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4367 unsigned char *buf,
4368 size_t buf_len,
4369 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004370{
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004372}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004373
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004374/*
4375 * Deserialize session, see mbedtls_ssl_session_save() for format.
4376 *
4377 * This internal version is wrapped by a public function that cleans up in
4378 * case of error, and has an extra option omit_header.
4379 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004380MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004381static int ssl_session_load(mbedtls_ssl_session *session,
4382 unsigned char omit_header,
4383 const unsigned char *buf,
4384 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004385{
4386 const unsigned char *p = buf;
4387 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004388 size_t remaining_len;
4389
4390
Gilles Peskine449bd832023-01-11 14:50:10 +01004391 if (session == NULL) {
4392 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4393 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004394
Gilles Peskine449bd832023-01-11 14:50:10 +01004395 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004396 /*
4397 * Check Mbed TLS version identifier
4398 */
4399
Gilles Peskine449bd832023-01-11 14:50:10 +01004400 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4401 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004402 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004403
4404 if (memcmp(p, ssl_serialized_session_header,
4405 sizeof(ssl_serialized_session_header)) != 0) {
4406 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4407 }
4408 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004409 }
4410
4411 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004412 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004413 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004414 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004415 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4416 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004417 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004418 session->endpoint = *p++;
4419 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4420 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004421
4422 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004423 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004424 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004425#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 case MBEDTLS_SSL_VERSION_TLS1_2:
4427 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004428#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4429
Jerry Yu438ddd82022-07-07 06:55:50 +00004430#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004431 case MBEDTLS_SSL_VERSION_TLS1_3:
4432 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004433#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4434
Gilles Peskine449bd832023-01-11 14:50:10 +01004435 default:
4436 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004437 }
4438}
4439
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004440/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004441 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004442 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004443int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4444 const unsigned char *buf,
4445 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004446{
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004448
Gilles Peskine449bd832023-01-11 14:50:10 +01004449 if (ret != 0) {
4450 mbedtls_ssl_session_free(session);
4451 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004452
Gilles Peskine449bd832023-01-11 14:50:10 +01004453 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004454}
4455
4456/*
Paul Bakker1961b702013-01-25 14:49:24 +01004457 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004458 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004459MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004460static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004461{
4462 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4463
Ronald Cron66dbf912022-02-02 15:33:46 +01004464 /*
4465 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004466 * that were written into the output buffer by the previous handshake step,
4467 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004468 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4469 * We proceed to the next handshake step only when all data from the
4470 * previous one have been sent to the peer, thus we make sure that this is
4471 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4472 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4473 * we have to wait before to go ahead.
4474 * In the case of TLS 1.3, handshake step handlers do not send data to the
4475 * peer. Data are only sent here and through
4476 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004477 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004478 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004479 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4480 return ret;
4481 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004482
4483#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4485 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4486 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4487 return ret;
4488 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004489 }
4490#endif /* MBEDTLS_SSL_PROTO_DTLS */
4491
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004493}
4494
Gilles Peskine449bd832023-01-11 14:50:10 +01004495int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004496{
Hanno Becker41934dd2021-08-07 19:13:43 +01004497 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004498
Gilles Peskine449bd832023-01-11 14:50:10 +01004499 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004500 ssl->conf == NULL ||
4501 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4503 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004504 }
4505
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 ret = ssl_prepare_handshake_step(ssl);
4507 if (ret != 0) {
4508 return ret;
4509 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004510
Gilles Peskine449bd832023-01-11 14:50:10 +01004511 ret = mbedtls_ssl_handle_pending_alert(ssl);
4512 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004513 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 }
Jerry Yue7047812021-09-13 19:26:39 +08004515
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004516 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4517 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4518 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4519
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004520#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4522 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004523 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004524
Gilles Peskine449bd832023-01-11 14:50:10 +01004525 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004526 case MBEDTLS_SSL_HELLO_REQUEST:
4527 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004528 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004529 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004530
Ronald Cron9f0fba32022-02-10 16:45:15 +01004531 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004533 break;
4534
4535 default:
4536#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004537 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4538 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4539 } else {
4540 ret = mbedtls_ssl_handshake_client_step(ssl);
4541 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004542#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004543 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004544#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004546#endif
4547 }
Jerry Yub9930e72021-08-06 17:11:51 +08004548 }
Ronald Cron6291b232023-03-08 15:51:25 +01004549#endif /* MBEDTLS_SSL_CLI_C */
4550
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004551#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004552 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004553#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4554 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004555 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004556 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 ret = mbedtls_ssl_handshake_server_step(ssl);
4558 }
Ronald Cron6291b232023-03-08 15:51:25 +01004559#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4560 ret = mbedtls_ssl_handshake_server_step(ssl);
4561#else
4562 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004563#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004564 }
4565#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004566
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004568 /* handshake_step return error. And it is same
4569 * with alert_reason.
4570 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004571 if (ssl->send_alert) {
4572 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004573 goto cleanup;
4574 }
4575 }
4576
4577cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004578 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004579}
4580
4581/*
4582 * Perform the SSL handshake
4583 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004584int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004585{
4586 int ret = 0;
4587
Hanno Beckera817ea42020-10-20 15:20:23 +01004588 /* Sanity checks */
4589
Gilles Peskine449bd832023-01-11 14:50:10 +01004590 if (ssl == NULL || ssl->conf == NULL) {
4591 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4592 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004593
Hanno Beckera817ea42020-10-20 15:20:23 +01004594#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4596 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4597 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4598 "mbedtls_ssl_set_timer_cb() for DTLS"));
4599 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004600 }
4601#endif /* MBEDTLS_SSL_PROTO_DTLS */
4602
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004604
Hanno Beckera817ea42020-10-20 15:20:23 +01004605 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004606 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4607 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004608
Gilles Peskine449bd832023-01-11 14:50:10 +01004609 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004610 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004611 }
Paul Bakker1961b702013-01-25 14:49:24 +01004612 }
4613
Gilles Peskine449bd832023-01-11 14:50:10 +01004614 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004615
Gilles Peskine449bd832023-01-11 14:50:10 +01004616 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004617}
4618
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004619#if defined(MBEDTLS_SSL_RENEGOTIATION)
4620#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004621/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004622 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004623 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004624MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004625static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004626{
Janos Follath865b3eb2019-12-16 11:46:15 +00004627 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004628
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
4631 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004632 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4633 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004634
Gilles Peskine449bd832023-01-11 14:50:10 +01004635 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4636 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4637 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004638 }
4639
Gilles Peskine449bd832023-01-11 14:50:10 +01004640 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004641
Gilles Peskine449bd832023-01-11 14:50:10 +01004642 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004643}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004644#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004645
4646/*
4647 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004648 * - any side: calling mbedtls_ssl_renegotiate(),
4649 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4650 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004651 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004652 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004653 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004654 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004655int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004656{
Janos Follath865b3eb2019-12-16 11:46:15 +00004657 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004658
Gilles Peskine449bd832023-01-11 14:50:10 +01004659 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004660
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 if ((ret = ssl_handshake_init(ssl)) != 0) {
4662 return ret;
4663 }
Paul Bakker48916f92012-09-16 19:57:18 +00004664
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004665 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4666 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004667#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004668 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4669 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4670 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004671 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004672 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004673 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004674 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004675 }
4676#endif
4677
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004678 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4679 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004680
Gilles Peskine449bd832023-01-11 14:50:10 +01004681 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4682 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4683 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004684 }
4685
Gilles Peskine449bd832023-01-11 14:50:10 +01004686 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004687
Gilles Peskine449bd832023-01-11 14:50:10 +01004688 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004689}
4690
4691/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004692 * Renegotiate current connection on client,
4693 * or request renegotiation on server
4694 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004695int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004696{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004697 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004698
Gilles Peskine449bd832023-01-11 14:50:10 +01004699 if (ssl == NULL || ssl->conf == NULL) {
4700 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4701 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004702
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004703#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004704 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004705 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4706 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4707 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4708 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004709
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004710 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004711
4712 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 if (ssl->out_left != 0) {
4714 return mbedtls_ssl_flush_output(ssl);
4715 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004716
Gilles Peskine449bd832023-01-11 14:50:10 +01004717 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004718 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004719#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004720
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004721#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004722 /*
4723 * On client, either start the renegotiation process or,
4724 * if already in progress, continue the handshake
4725 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004726 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4727 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4728 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004729 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004730
4731 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4732 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4733 return ret;
4734 }
4735 } else {
4736 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4737 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4738 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004739 }
4740 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004741#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004742
Gilles Peskine449bd832023-01-11 14:50:10 +01004743 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004744}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004745#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004746
Gilles Peskine449bd832023-01-11 14:50:10 +01004747void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004748{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004749 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4750
Gilles Peskine449bd832023-01-11 14:50:10 +01004751 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004752 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004753 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004754
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004755#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Brett Warrene0edc842021-08-17 09:53:13 +01004756#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004757 if (ssl->handshake->group_list_heap_allocated) {
4758 mbedtls_free((void *) handshake->group_list);
4759 }
Brett Warrene0edc842021-08-17 09:53:13 +01004760 handshake->group_list = NULL;
4761#endif /* MBEDTLS_DEPRECATED_REMOVED */
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004762#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Brett Warrene0edc842021-08-17 09:53:13 +01004763
Ronald Crone68ab4f2022-10-05 12:46:29 +02004764#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004765#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004766 if (ssl->handshake->sig_algs_heap_allocated) {
4767 mbedtls_free((void *) handshake->sig_algs);
4768 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004769 handshake->sig_algs = NULL;
4770#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004771#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004772 if (ssl->handshake->certificate_request_context) {
4773 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004774 }
4775#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004776#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004777
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004778#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004779 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4780 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004781 handshake->async_in_progress = 0;
4782 }
4783#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4784
Elena Uziunaite0916cd72024-05-23 17:01:07 +01004785#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004786#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004787 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004788#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004789 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004790#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004791#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01004792#if defined(PSA_WANT_ALG_SHA_384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004793#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004795#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004796 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004797#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004798#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004799
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004800#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004801 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004802#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004803#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004804 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004806#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004807
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004808#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004809#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004811 /*
4812 * Opaque keys are not stored in the handshake's data and it's the user
4813 * responsibility to destroy them. Clear ones, instead, are created by
4814 * the TLS library and should be destroyed at the same level
4815 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4817 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004818 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004819 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4820#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004822#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004823#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004824 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004825 handshake->ecjpake_cache = NULL;
4826 handshake->ecjpake_cache_len = 0;
4827#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004828#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004829
Valerio Setti7aeec542023-07-05 18:57:21 +02004830#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004831 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004832 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004833 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004835#endif
4836
Ronald Cron73fe8df2022-10-05 14:31:43 +02004837#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004838#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004839 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004840 /* The maintenance of the external PSK key slot is the
4841 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004842 if (ssl->handshake->psk_opaque_is_internal) {
4843 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004844 ssl->handshake->psk_opaque_is_internal = 0;
4845 }
4846 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4847 }
Neil Armstronge952a302022-05-03 10:22:14 +02004848#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004849 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004850 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004851 }
Neil Armstronge952a302022-05-03 10:22:14 +02004852#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004853#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004854
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004855#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4856 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004857 /*
4858 * Free only the linked list wrapper, not the keys themselves
4859 * since the belong to the SNI callback
4860 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004861 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004862#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004863
Gilles Peskineeccd8882020-03-10 12:19:08 +01004864#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004865 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4866 if (handshake->ecrs_peer_cert != NULL) {
4867 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4868 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004869 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004870#endif
4871
Hanno Becker75173122019-02-06 16:18:31 +00004872#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4873 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004875#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4876
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004877#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004878 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4879 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004880#endif /* MBEDTLS_SSL_CLI_C &&
4881 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004882
4883#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004884 mbedtls_ssl_flight_free(handshake->flight);
4885 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004886#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004887
Valerio Settiea59c432023-07-25 11:14:03 +02004888#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004889 if (handshake->xxdh_psa_privkey_is_external == 0) {
4890 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004891 }
Valerio Settiea59c432023-07-25 11:14:03 +02004892#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004893
Ronald Cron6f135e12021-12-08 16:57:54 +01004894#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 mbedtls_ssl_transform_free(handshake->transform_handshake);
4896 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004897#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004898 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4899 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004900#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004901#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004902
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004903
4904#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4905 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4906 * processes datagrams and the fact that a datagram is allowed to have
4907 * several records in it, it is possible that the I/O buffers are not
4908 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004909 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4910 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004911#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004912
Jerry Yuba9c7272021-10-30 11:54:10 +08004913 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004914 mbedtls_platform_zeroize(handshake,
4915 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004916}
4917
Gilles Peskine449bd832023-01-11 14:50:10 +01004918void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004919{
Gilles Peskine449bd832023-01-11 14:50:10 +01004920 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004921 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004922 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004923
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004924#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004926#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004927
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004928#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004929#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4930 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004931 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004932#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004934#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004935
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004936#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4937 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004938 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004939#endif
4940
Gilles Peskine449bd832023-01-11 14:50:10 +01004941 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004942}
4943
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004944#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004945
4946#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4947#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4948#else
4949#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4950#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4951
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004952#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004953
4954#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4955#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4956#else
4957#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4958#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4959
4960#if defined(MBEDTLS_SSL_ALPN)
4961#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4962#else
4963#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4964#endif /* MBEDTLS_SSL_ALPN */
4965
4966#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4967#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4968#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4969#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4970
4971#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004972 ((uint32_t) ( \
4973 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4974 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4975 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4976 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4977 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4978 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4979 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4980 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004981
Chien Wong4e9683e2023-12-28 17:07:43 +08004982static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004983 MBEDTLS_VERSION_MAJOR,
4984 MBEDTLS_VERSION_MINOR,
4985 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004986 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4987 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4988 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4989 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
4990 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004991};
4992
Paul Bakker5121ce52009-01-03 21:22:43 +00004993/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004994 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02004995 *
4996 * The format of the serialized data is:
4997 * (in the presentation language of TLS, RFC 8446 section 3)
4998 *
4999 * // header
5000 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005001 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005002 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005003 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005004 * Note: When updating the format, remember to keep these
5005 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005006 *
5007 * // session sub-structure
5008 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
5009 * // transform sub-structure
5010 * uint8 random[64]; // ServerHello.random+ClientHello.random
5011 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
5012 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
5013 * // fields from ssl_context
5014 * uint32 badmac_seen; // DTLS: number of records with failing MAC
5015 * uint64 in_window_top; // DTLS: last validated record seq_num
5016 * uint64 in_window; // DTLS: bitmask for replay protection
5017 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
5018 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
5019 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
5020 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
5021 *
5022 * Note that many fields of the ssl_context or sub-structures are not
5023 * serialized, as they fall in one of the following categories:
5024 *
5025 * 1. forced value (eg in_left must be 0)
5026 * 2. pointer to dynamically-allocated memory (eg session, transform)
5027 * 3. value can be re-derived from other data (eg session keys from MS)
5028 * 4. value was temporary (eg content of input buffer)
5029 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005030 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005031int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5032 unsigned char *buf,
5033 size_t buf_len,
5034 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005035{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005036 unsigned char *p = buf;
5037 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005038 size_t session_len;
5039 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005040
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005041 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005042 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
5043 * this function's documentation.
5044 *
5045 * These are due to assumptions/limitations in the implementation. Some of
5046 * them are likely to stay (no handshake in progress) some might go away
5047 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005048 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005049 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01005050 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
5051 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
5052 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005053 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 if (ssl->handshake != NULL) {
5055 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
5056 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005057 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005058 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01005059 if (ssl->transform == NULL || ssl->session == NULL) {
5060 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
5061 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005062 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005063 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01005064 if (mbedtls_ssl_check_pending(ssl) != 0) {
5065 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
5066 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005067 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005068 if (ssl->out_left != 0) {
5069 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
5070 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005071 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00005072 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005073 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5074 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
5075 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005076 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005077 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005078 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
5079 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
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 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01005083 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
5084 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
5085 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005086 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005087 /* Renegotiation must not be enabled */
5088#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005089 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5090 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
5091 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005092 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005093#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005094
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005095 /*
5096 * Version and format identifier
5097 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005098 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005099
Gilles Peskine449bd832023-01-11 14:50:10 +01005100 if (used <= buf_len) {
5101 memcpy(p, ssl_serialized_context_header,
5102 sizeof(ssl_serialized_context_header));
5103 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005104 }
5105
5106 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005107 * Session (length + data)
5108 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
5110 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
5111 return ret;
5112 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005113
5114 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 if (used <= buf_len) {
5116 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005117 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005118
Gilles Peskine449bd832023-01-11 14:50:10 +01005119 ret = ssl_session_save(ssl->session, 1,
5120 p, session_len, &session_len);
5121 if (ret != 0) {
5122 return ret;
5123 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005124
5125 p += session_len;
5126 }
5127
5128 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005129 * Transform
5130 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005131 used += sizeof(ssl->transform->randbytes);
5132 if (used <= buf_len) {
5133 memcpy(p, ssl->transform->randbytes,
5134 sizeof(ssl->transform->randbytes));
5135 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005136 }
5137
5138#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005139 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005140 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005141 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005142 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005143 p += ssl->transform->in_cid_len;
5144
5145 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005146 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005147 p += ssl->transform->out_cid_len;
5148 }
5149#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5150
5151 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005152 * Saved fields from top-level ssl_context structure
5153 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005154 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01005155 if (used <= buf_len) {
5156 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005157 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005158 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005159
5160#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5161 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 if (used <= buf_len) {
5163 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005164 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005165
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005167 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005168 }
5169#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5170
5171#if defined(MBEDTLS_SSL_PROTO_DTLS)
5172 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005174 *p++ = ssl->disable_datagram_packing;
5175 }
5176#endif /* MBEDTLS_SSL_PROTO_DTLS */
5177
Jerry Yuae0b2e22021-10-08 15:21:19 +08005178 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01005179 if (used <= buf_len) {
5180 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08005181 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005182 }
5183
5184#if defined(MBEDTLS_SSL_PROTO_DTLS)
5185 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 if (used <= buf_len) {
5187 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005188 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005189 }
5190#endif /* MBEDTLS_SSL_PROTO_DTLS */
5191
5192#if defined(MBEDTLS_SSL_ALPN)
5193 {
5194 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01005195 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005196 : 0;
5197
5198 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005199 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005200 *p++ = alpn_len;
5201
Gilles Peskine449bd832023-01-11 14:50:10 +01005202 if (ssl->alpn_chosen != NULL) {
5203 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005204 p += alpn_len;
5205 }
5206 }
5207 }
5208#endif /* MBEDTLS_SSL_ALPN */
5209
5210 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005211 * Done
5212 */
5213 *olen = used;
5214
Gilles Peskine449bd832023-01-11 14:50:10 +01005215 if (used > buf_len) {
5216 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
5217 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005218
Gilles Peskine449bd832023-01-11 14:50:10 +01005219 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005220
Gilles Peskine449bd832023-01-11 14:50:10 +01005221 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005222}
5223
5224/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005225 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005226 *
5227 * This internal version is wrapped by a public function that cleans up in
5228 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005229 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005230MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005231static int ssl_context_load(mbedtls_ssl_context *ssl,
5232 const unsigned char *buf,
5233 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005234{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005235 const unsigned char *p = buf;
5236 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005237 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005238 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005239#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04005240 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005241#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005242
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005243 /*
5244 * The context should have been freshly setup or reset.
5245 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005246 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005247 * renegotiating, or if the user mistakenly loaded a session first.)
5248 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005249 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5250 ssl->session != NULL) {
5251 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005252 }
5253
5254 /*
5255 * We can't check that the config matches the initial one, but we can at
5256 * least check it matches the requirements for serializing.
5257 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005258 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005259#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005260 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005261#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005262 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5263 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5264 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5265 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005267 }
5268
Gilles Peskine449bd832023-01-11 14:50:10 +01005269 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005270
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005271 /*
5272 * Check version identifier
5273 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005274 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5275 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005276 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005277
5278 if (memcmp(p, ssl_serialized_context_header,
5279 sizeof(ssl_serialized_context_header)) != 0) {
5280 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5281 }
5282 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005283
5284 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005285 * Session
5286 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005287 if ((size_t) (end - p) < 4) {
5288 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5289 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005290
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005291 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005292 p += 4;
5293
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005294 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005295 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005296 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005297 ssl->session_in = ssl->session;
5298 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005299 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005300
Gilles Peskine449bd832023-01-11 14:50:10 +01005301 if ((size_t) (end - p) < session_len) {
5302 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5303 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005304
Gilles Peskine449bd832023-01-11 14:50:10 +01005305 ret = ssl_session_load(ssl->session, 1, p, session_len);
5306 if (ret != 0) {
5307 mbedtls_ssl_session_free(ssl->session);
5308 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005309 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005310
5311 p += session_len;
5312
5313 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005314 * Transform
5315 */
5316
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005317 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005318 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005319#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005320 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005321 ssl->transform_in = ssl->transform;
5322 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005323 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005324#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005325
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005326#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005327 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5328 if (prf_func == NULL) {
5329 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5330 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005331
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005332 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005333 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5334 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5335 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005336
Gilles Peskine449bd832023-01-11 14:50:10 +01005337 ret = ssl_tls12_populate_transform(ssl->transform,
5338 ssl->session->ciphersuite,
5339 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005340#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005341 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005342#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005343 prf_func,
5344 p, /* currently pointing to randbytes */
5345 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5346 ssl->conf->endpoint,
5347 ssl);
5348 if (ret != 0) {
5349 return ret;
5350 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005351#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005352 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005353
5354#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5355 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 if ((size_t) (end - p) < 1) {
5357 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5358 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005359
5360 ssl->transform->in_cid_len = *p++;
5361
Gilles Peskine449bd832023-01-11 14:50:10 +01005362 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5363 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5364 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005365
Gilles Peskine449bd832023-01-11 14:50:10 +01005366 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005367 p += ssl->transform->in_cid_len;
5368
5369 ssl->transform->out_cid_len = *p++;
5370
Gilles Peskine449bd832023-01-11 14:50:10 +01005371 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5372 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5373 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005374
Gilles Peskine449bd832023-01-11 14:50:10 +01005375 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005376 p += ssl->transform->out_cid_len;
5377#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5378
5379 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005380 * Saved fields from top-level ssl_context structure
5381 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005382 if ((size_t) (end - p) < 4) {
5383 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5384 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005385
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005386 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005387 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005388
5389#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005390 if ((size_t) (end - p) < 16) {
5391 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5392 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005393
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005394 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005395 p += 8;
5396
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005397 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005398 p += 8;
5399#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5400
5401#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005402 if ((size_t) (end - p) < 1) {
5403 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5404 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005405
5406 ssl->disable_datagram_packing = *p++;
5407#endif /* MBEDTLS_SSL_PROTO_DTLS */
5408
Gilles Peskine449bd832023-01-11 14:50:10 +01005409 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5410 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5411 }
5412 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5413 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005414
5415#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 if ((size_t) (end - p) < 2) {
5417 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5418 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005419
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005420 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005421 p += 2;
5422#endif /* MBEDTLS_SSL_PROTO_DTLS */
5423
5424#if defined(MBEDTLS_SSL_ALPN)
5425 {
5426 uint8_t alpn_len;
5427 const char **cur;
5428
Gilles Peskine449bd832023-01-11 14:50:10 +01005429 if ((size_t) (end - p) < 1) {
5430 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5431 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005432
5433 alpn_len = *p++;
5434
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005436 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005437 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5438 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005439 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005440 ssl->alpn_chosen = *cur;
5441 break;
5442 }
5443 }
5444 }
5445
5446 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005447 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5448 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5449 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005450
5451 p += alpn_len;
5452 }
5453#endif /* MBEDTLS_SSL_ALPN */
5454
5455 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005456 * Forced fields from top-level ssl_context structure
5457 *
5458 * Most of them already set to the correct value by mbedtls_ssl_init() and
5459 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5460 */
5461 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005462 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005463
Hanno Becker361b10d2019-08-30 10:42:49 +01005464 /* Adjust pointers for header fields of outgoing records to
5465 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005466 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005467
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005468#if defined(MBEDTLS_SSL_PROTO_DTLS)
5469 ssl->in_epoch = 1;
5470#endif
5471
5472 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5473 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005474 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5475 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005476 if (ssl->handshake != NULL) {
5477 mbedtls_ssl_handshake_free(ssl);
5478 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005479 ssl->handshake = NULL;
5480 }
5481
5482 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005483 * Done - should have consumed entire buffer
5484 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005485 if (p != end) {
5486 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5487 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005488
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005490}
5491
5492/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005493 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005494 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005495int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5496 const unsigned char *buf,
5497 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005498{
Gilles Peskine449bd832023-01-11 14:50:10 +01005499 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005500
Gilles Peskine449bd832023-01-11 14:50:10 +01005501 if (ret != 0) {
5502 mbedtls_ssl_free(context);
5503 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005504
Gilles Peskine449bd832023-01-11 14:50:10 +01005505 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005506}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005507#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005508
5509/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005510 * Free an SSL context
5511 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005512void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005513{
Gilles Peskine449bd832023-01-11 14:50:10 +01005514 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005515 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005517
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005519
Gilles Peskine449bd832023-01-11 14:50:10 +01005520 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005521#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5522 size_t out_buf_len = ssl->out_buf_len;
5523#else
5524 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5525#endif
5526
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005527 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005528 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005529 }
5530
Gilles Peskine449bd832023-01-11 14:50:10 +01005531 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005532#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5533 size_t in_buf_len = ssl->in_buf_len;
5534#else
5535 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5536#endif
5537
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005538 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005539 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005540 }
5541
Gilles Peskine449bd832023-01-11 14:50:10 +01005542 if (ssl->transform) {
5543 mbedtls_ssl_transform_free(ssl->transform);
5544 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005545 }
5546
Gilles Peskine449bd832023-01-11 14:50:10 +01005547 if (ssl->handshake) {
5548 mbedtls_ssl_handshake_free(ssl);
5549 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005550
5551#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005552 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5553 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005554#endif
5555
Gilles Peskine449bd832023-01-11 14:50:10 +01005556 mbedtls_ssl_session_free(ssl->session_negotiate);
5557 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005558 }
5559
Ronald Cron6f135e12021-12-08 16:57:54 +01005560#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005561 mbedtls_ssl_transform_free(ssl->transform_application);
5562 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005563#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005564
Gilles Peskine449bd832023-01-11 14:50:10 +01005565 if (ssl->session) {
5566 mbedtls_ssl_session_free(ssl->session);
5567 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005568 }
5569
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005570#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005571 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005572 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005573 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005574#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005575
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005576#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005577 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005578#endif
5579
Gilles Peskine449bd832023-01-11 14:50:10 +01005580 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005581
Paul Bakker86f04f42013-02-14 11:20:09 +01005582 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005583 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005584}
5585
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005586/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005587 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005588 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005589void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005590{
Gilles Peskine449bd832023-01-11 14:50:10 +01005591 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005592}
5593
Gilles Peskineae270bf2021-06-02 00:05:29 +02005594/* The selection should be the same as mbedtls_x509_crt_profile_default in
5595 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005596 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005597 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005598 * about this list.
5599 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005600static const uint16_t ssl_preset_default_groups[] = {
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005601#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Brett Warrene0edc842021-08-17 09:53:13 +01005602 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005603#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005604#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005605 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005606#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005607#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005608 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005609#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005610#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Brett Warrene0edc842021-08-17 09:53:13 +01005611 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005612#endif
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005613#if defined(PSA_WANT_ECC_SECP_R1_521)
Brett Warrene0edc842021-08-17 09:53:13 +01005614 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005615#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005616#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005617 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005618#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005619#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005620 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005621#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005622#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Brett Warrene0edc842021-08-17 09:53:13 +01005623 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005624#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005625#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005626 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5627 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5628 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5629 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5630 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5631#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005632 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005633};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005634
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005635static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005636 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5637 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5638 0
5639};
5640
Ronald Crone68ab4f2022-10-05 12:46:29 +02005641#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005642
Jerry Yu909df7b2022-01-22 11:56:27 +08005643/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005644 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005645 * rules SHOULD be upheld.
5646 * - No duplicate entries.
5647 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005648 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005649 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005650 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005651static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005652
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005653#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005654 defined(PSA_WANT_ALG_SHA_256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005655 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005656 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005657 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5658#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005659
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005660#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005661 defined(PSA_WANT_ALG_SHA_384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005662 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005663 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005664 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5665#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005666
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005667#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Gabor Mezeic15ef932024-06-13 12:53:54 +02005668 defined(PSA_WANT_ALG_SHA_512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005669 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005670 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005671 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5672#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005673
Gabor Mezeic15ef932024-06-13 12:53:54 +02005674#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005675 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005676#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005677
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005678#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005679 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005680#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005681
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005682#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005683 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005684#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005685
Gabor Mezeic15ef932024-06-13 12:53:54 +02005686#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005687 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Gabor Mezeic15ef932024-06-13 12:53:54 +02005688#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005689
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005690#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005691 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005692#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005693
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005694#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005695 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005696#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005697
Gabor Mezei15b95a62022-05-09 16:37:58 +02005698 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005699};
5700
5701/* NOTICE: see above */
5702#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5703static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005704
Gabor Mezeic15ef932024-06-13 12:53:54 +02005705#if defined(PSA_WANT_ALG_SHA_512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005706#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005707 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005708#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005709#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5710 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005711#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005712#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005713 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005714#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005715#endif /* PSA_WANT_ALG_SHA_512 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005716
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005717#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005718#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005719 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005720#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005721#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5722 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005723#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005724#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005725 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005726#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005727#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005728
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005729#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005730#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005731 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005732#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005733#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5734 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005735#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005736#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005737 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005738#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005739#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005740
Gabor Mezei15b95a62022-05-09 16:37:58 +02005741 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005742};
5743#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005744
Jerry Yu909df7b2022-01-22 11:56:27 +08005745/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005746static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005747
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005748#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005749 defined(PSA_WANT_ALG_SHA_256) && \
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005750 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005751 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005752 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5753#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005754
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005755#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005756 defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005757 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu53037892022-01-25 11:02:06 +08005758 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005759 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5760#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005761
Gabor Mezei15b95a62022-05-09 16:37:58 +02005762 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005763};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005764
Jerry Yu909df7b2022-01-22 11:56:27 +08005765/* NOTICE: see above */
5766#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5767static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005768
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005769#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005770#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005771 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005772#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005773#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005774
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005775#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005776#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005777 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005778#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005779#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005780
Gabor Mezei15b95a62022-05-09 16:37:58 +02005781 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005782};
Jerry Yu909df7b2022-01-22 11:56:27 +08005783#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5784
Ronald Crone68ab4f2022-10-05 12:46:29 +02005785#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005786
Chien Wong4e9683e2023-12-28 17:07:43 +08005787static const uint16_t ssl_preset_suiteb_groups[] = {
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005788#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005789 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005790#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005791#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005792 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005793#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005794 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005795};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005796
Ronald Crone68ab4f2022-10-05 12:46:29 +02005797#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005798/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005799 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005800MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005801static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005802{
5803 size_t i, j;
5804 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005805
Gilles Peskine449bd832023-01-11 14:50:10 +01005806 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5807 for (j = 0; j < i; j++) {
5808 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005809 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005810 }
5811 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5812 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5813 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005814 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005815 }
5816 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005817 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005818}
5819
Ronald Crone68ab4f2022-10-05 12:46:29 +02005820#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005821
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005822/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005823 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005824 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005825int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5826 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005827{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005828#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005829 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005830#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005831
Ronald Crone68ab4f2022-10-05 12:46:29 +02005832#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005833 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5834 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5835 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005836 }
5837
Gilles Peskine449bd832023-01-11 14:50:10 +01005838 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5839 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5840 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005841 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005842
5843#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005844 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5845 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5846 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005847 }
5848
Gilles Peskine449bd832023-01-11 14:50:10 +01005849 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5850 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5851 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005852 }
5853#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005854#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005855
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005856 /* Use the functions here so that they are covered in tests,
5857 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005858 mbedtls_ssl_conf_endpoint(conf, endpoint);
5859 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005860
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005861 /*
5862 * Things that are common to all presets
5863 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005864#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005865 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005866 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5867#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5868 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5869#endif
5870 }
5871#endif
5872
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005873#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5874 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5875#endif
5876
5877#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5878 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5879#endif
5880
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005881#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005882 conf->f_cookie_write = ssl_cookie_write_dummy;
5883 conf->f_cookie_check = ssl_cookie_check_dummy;
5884#endif
5885
5886#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5887 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5888#endif
5889
Janos Follath088ce432017-04-10 12:42:31 +01005890#if defined(MBEDTLS_SSL_SRV_C)
5891 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005892 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005893#endif
5894
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005895#if defined(MBEDTLS_SSL_PROTO_DTLS)
5896 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5897 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5898#endif
5899
5900#if defined(MBEDTLS_SSL_RENEGOTIATION)
5901 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005902 memset(conf->renego_period, 0x00, 2);
5903 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005904#endif
5905
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005906#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005907 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005908 const unsigned char dhm_p[] =
5909 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5910 const unsigned char dhm_g[] =
5911 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005912
Gilles Peskine449bd832023-01-11 14:50:10 +01005913 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5914 dhm_p, sizeof(dhm_p),
5915 dhm_g, sizeof(dhm_g))) != 0) {
5916 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005917 }
5918 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005919#endif
5920
Ronald Cron6f135e12021-12-08 16:57:54 +01005921#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005922
5923#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005924 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005925#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005926 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005927#endif
5928#endif /* MBEDTLS_SSL_EARLY_DATA */
5929
Jerry Yud0766ec2022-09-22 10:46:57 +08005930#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005931 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005932 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005933#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005934 /*
5935 * Allow all TLS 1.3 key exchange modes by default.
5936 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005937 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005938#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005939
Gilles Peskine449bd832023-01-11 14:50:10 +01005940 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005941#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005942 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005943 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005944#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005945 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005946#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005947 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005948#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005949 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5950 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005951#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5952 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5953 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5954#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5955 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5956 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5957#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005958 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005959#endif
5960 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005961
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005962 /*
5963 * Preset-specific defaults
5964 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005965 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005966 /*
5967 * NSA Suite B
5968 */
5969 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005970
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005971 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005972
5973#if defined(MBEDTLS_X509_CRT_PARSE_C)
5974 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005975#endif
5976
Ronald Crone68ab4f2022-10-05 12:46:29 +02005977#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005978#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005979 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005980 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005981 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005982#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005983 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005984#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005985
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005986#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01005987 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005988#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005989 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02005990 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005991
5992 /*
5993 * Default
5994 */
5995 default:
Ronald Cronf6606552022-03-15 11:23:25 +01005996
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005997 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005998
5999#if defined(MBEDTLS_X509_CRT_PARSE_C)
6000 conf->cert_profile = &mbedtls_x509_crt_profile_default;
6001#endif
6002
Ronald Crone68ab4f2022-10-05 12:46:29 +02006003#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08006004#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006005 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08006006 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01006007 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08006008#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02006010#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006011
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02006012#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006013 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006014#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006015 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006016
6017#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
6018 conf->dhm_min_bitlen = 1024;
6019#endif
6020 }
6021
Gilles Peskine449bd832023-01-11 14:50:10 +01006022 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006023}
6024
6025/*
6026 * Free mbedtls_ssl_config
6027 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006028void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006029{
Troy-Butlerda73abc2024-04-02 13:37:31 -04006030 if (conf == NULL) {
6031 return;
6032 }
6033
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006034#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006035 mbedtls_mpi_free(&conf->dhm_P);
6036 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006037#endif
6038
Ronald Cron73fe8df2022-10-05 14:31:43 +02006039#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02006040#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006041 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02006042 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
6043 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02006044#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01006045 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006046 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006047 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006048 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09006049 }
6050
Gilles Peskine449bd832023-01-11 14:50:10 +01006051 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006052 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006053 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006054 conf->psk_identity_len = 0;
6055 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02006056#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006057
6058#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006059 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006060#endif
6061
Gilles Peskine449bd832023-01-11 14:50:10 +01006062 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006063}
6064
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02006065#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02006066 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006067/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006068 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006069 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006070unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006071{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006072#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006073 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
6074 return MBEDTLS_SSL_SIG_RSA;
6075 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006076#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006077#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006078 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
6079 return MBEDTLS_SSL_SIG_ECDSA;
6080 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006081#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006083}
6084
Gilles Peskine449bd832023-01-11 14:50:10 +01006085unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01006086{
Gilles Peskine449bd832023-01-11 14:50:10 +01006087 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01006088 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006089 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006090 case MBEDTLS_PK_ECDSA:
6091 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01006092 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006093 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006094 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006095 }
6096}
6097
Gilles Peskine449bd832023-01-11 14:50:10 +01006098mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006099{
Gilles Peskine449bd832023-01-11 14:50:10 +01006100 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006101#if defined(MBEDTLS_RSA_C)
6102 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006103 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006104#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006105#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006106 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006107 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006108#endif
6109 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006111 }
6112}
Valerio Settie9646ec2023-08-02 20:02:28 +02006113#endif /* MBEDTLS_PK_C &&
6114 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006115
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006116/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006117 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006118 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006119mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006120{
Gilles Peskine449bd832023-01-11 14:50:10 +01006121 switch (hash) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01006122#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006123 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006124 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006125#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01006126#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006127 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006128 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006129#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01006130#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006131 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006132 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006133#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006134#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006135 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006136 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006137#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006138#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006139 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006140 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006141#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02006142#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006143 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006144 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006145#endif
6146 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006147 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006148 }
6149}
6150
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006151/*
6152 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6153 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006154unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006155{
Gilles Peskine449bd832023-01-11 14:50:10 +01006156 switch (md) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01006157#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006158 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006159 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006160#endif
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01006161#if defined(PSA_WANT_ALG_SHA_1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006162 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006163 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006164#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01006165#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006166 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006167 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006168#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006169#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006170 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006171 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006172#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006173#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006174 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006175 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006176#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02006177#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006178 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006179 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006180#endif
6181 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006182 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006183 }
6184}
6185
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006186/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006187 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006188 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006189 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006190int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006191{
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006193
Gilles Peskine449bd832023-01-11 14:50:10 +01006194 if (group_list == NULL) {
6195 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01006196 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006197
Gilles Peskine449bd832023-01-11 14:50:10 +01006198 for (; *group_list != 0; group_list++) {
6199 if (*group_list == tls_id) {
6200 return 0;
6201 }
6202 }
6203
6204 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006205}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006206
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01006207#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006208/*
6209 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6210 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006211int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006212{
Gilles Peskine449bd832023-01-11 14:50:10 +01006213 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006214
Gilles Peskine449bd832023-01-11 14:50:10 +01006215 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006216 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006217 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006218
Gilles Peskine449bd832023-01-11 14:50:10 +01006219 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006220}
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01006221#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Valerio Setti67419f02023-01-04 16:12:42 +01006222
Valerio Setti18c9fed2022-12-30 17:44:24 +01006223static const struct {
6224 uint16_t tls_id;
6225 mbedtls_ecp_group_id ecp_group_id;
6226 psa_ecc_family_t psa_family;
6227 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01006228} tls_id_match_table[] =
6229{
Elena Uziunaite24e24f22024-07-04 17:53:40 +01006230#if defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02006231 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006232#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01006233#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02006234 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006235#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01006236#if defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02006237 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006238#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01006239#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02006240 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006241#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01006242#if defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02006243 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006244#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01006245#if defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02006246 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006247#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01006248#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02006249 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006250#endif
Elena Uziunaiteeaa0cf02024-07-04 17:41:25 +01006251#if defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02006252 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006253#endif
Elena Uziunaitea3632862024-07-04 13:52:43 +01006254#if defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02006255 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006256#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01006257#if defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02006258 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006259#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01006260#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02006261 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006262#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01006263#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006264 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006265#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006266 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006267};
6268
Gilles Peskine449bd832023-01-11 14:50:10 +01006269int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006270 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006271 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006272{
Gilles Peskine449bd832023-01-11 14:50:10 +01006273 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6274 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006275 if (type != NULL) {
6276 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006277 }
6278 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006279 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006280 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006281 return PSA_SUCCESS;
6282 }
6283 }
6284
6285 return PSA_ERROR_NOT_SUPPORTED;
6286}
6287
Gilles Peskine449bd832023-01-11 14:50:10 +01006288mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006289{
Gilles Peskine449bd832023-01-11 14:50:10 +01006290 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6291 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006292 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006293 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006294 }
6295
6296 return MBEDTLS_ECP_DP_NONE;
6297}
6298
Gilles Peskine449bd832023-01-11 14:50:10 +01006299uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006300{
Gilles Peskine449bd832023-01-11 14:50:10 +01006301 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6302 i++) {
6303 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006304 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006305 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006306 }
6307
6308 return 0;
6309}
6310
Valerio Setti67419f02023-01-04 16:12:42 +01006311#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006312static const struct {
6313 uint16_t tls_id;
6314 const char *name;
6315} tls_id_curve_name_table[] =
6316{
Valerio Setti54e23792023-07-07 10:49:27 +02006317 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6318 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6319 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6320 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6321 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6322 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6323 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6324 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6325 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6326 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6327 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6328 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6329 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006330 { 0, NULL },
6331};
6332
Gilles Peskine449bd832023-01-11 14:50:10 +01006333const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006334{
Valerio Settiacd32c02023-06-29 18:06:29 +02006335 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6336 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6337 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006338 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006339 }
6340
6341 return NULL;
6342}
Valerio Setti67419f02023-01-04 16:12:42 +01006343#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006344
Jerry Yu148165c2021-09-24 23:20:59 +08006345#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006346int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6347 const mbedtls_md_type_t md,
6348 unsigned char *dst,
6349 size_t dst_len,
6350 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006351{
Ronald Cronf6893e12022-01-07 22:09:01 +01006352 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6353 psa_hash_operation_t *hash_operation_to_clone;
6354 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6355
Jerry Yu148165c2021-09-24 23:20:59 +08006356 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006357
Gilles Peskine449bd832023-01-11 14:50:10 +01006358 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006359#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006360 case MBEDTLS_MD_SHA384:
6361 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6362 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006363#endif
6364
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006365#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006366 case MBEDTLS_MD_SHA256:
6367 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6368 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006369#endif
6370
Gilles Peskine449bd832023-01-11 14:50:10 +01006371 default:
6372 goto exit;
6373 }
6374
6375 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6376 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006377 goto exit;
6378 }
6379
Gilles Peskine449bd832023-01-11 14:50:10 +01006380 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6381 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006382 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006383 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006384
6385exit:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006386#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006387 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006388 (void) ssl;
6389#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006390 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006391}
6392#else /* MBEDTLS_USE_PSA_CRYPTO */
6393
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006394#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006395MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006396static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
6397 unsigned char *dst,
6398 size_t dst_len,
6399 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006400{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006401 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006402 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006403
Gilles Peskine449bd832023-01-11 14:50:10 +01006404 if (dst_len < 48) {
6405 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6406 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006407
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006408 mbedtls_md_init(&sha384);
6409 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006410 if (ret != 0) {
6411 goto exit;
6412 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006413 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006414 if (ret != 0) {
6415 goto exit;
6416 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006417
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006418 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006419 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006420 goto exit;
6421 }
6422
6423 *olen = 48;
6424
6425exit:
6426
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006427 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006428 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006429}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006430#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006431
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006432#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006433MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006434static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
6435 unsigned char *dst,
6436 size_t dst_len,
6437 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006438{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006439 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006440 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006441
Gilles Peskine449bd832023-01-11 14:50:10 +01006442 if (dst_len < 32) {
6443 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6444 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006445
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006446 mbedtls_md_init(&sha256);
6447 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6448 if (ret != 0) {
6449 goto exit;
6450 }
6451 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6452 if (ret != 0) {
6453 goto exit;
6454 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006455
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006456 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
6457 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006458 goto exit;
6459 }
6460
6461 *olen = 32;
6462
6463exit:
6464
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006465 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006466 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006467}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006468#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006469
Gilles Peskine449bd832023-01-11 14:50:10 +01006470int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6471 const mbedtls_md_type_t md,
6472 unsigned char *dst,
6473 size_t dst_len,
6474 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006475{
Gilles Peskine449bd832023-01-11 14:50:10 +01006476 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006477
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006478#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006479 case MBEDTLS_MD_SHA384:
6480 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006481#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006482
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006483#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 case MBEDTLS_MD_SHA256:
6485 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006486#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006487
Gilles Peskine449bd832023-01-11 14:50:10 +01006488 default:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006489#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006490 !defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006491 (void) ssl;
6492 (void) dst;
6493 (void) dst_len;
6494 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006495#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006496 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006497 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006498 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006499}
XiaokangQian647719a2021-12-07 09:16:29 +00006500
Jerry Yu148165c2021-09-24 23:20:59 +08006501#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006502
Ronald Crone68ab4f2022-10-05 12:46:29 +02006503#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006504/* mbedtls_ssl_parse_sig_alg_ext()
6505 *
6506 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6507 * value (TLS 1.3 RFC8446):
6508 * enum {
6509 * ....
6510 * ecdsa_secp256r1_sha256( 0x0403 ),
6511 * ecdsa_secp384r1_sha384( 0x0503 ),
6512 * ecdsa_secp521r1_sha512( 0x0603 ),
6513 * ....
6514 * } SignatureScheme;
6515 *
6516 * struct {
6517 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6518 * } SignatureSchemeList;
6519 *
6520 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6521 * value (TLS 1.2 RFC5246):
6522 * enum {
6523 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6524 * sha512(6), (255)
6525 * } HashAlgorithm;
6526 *
6527 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6528 * SignatureAlgorithm;
6529 *
6530 * struct {
6531 * HashAlgorithm hash;
6532 * SignatureAlgorithm signature;
6533 * } SignatureAndHashAlgorithm;
6534 *
6535 * SignatureAndHashAlgorithm
6536 * supported_signature_algorithms<2..2^16-2>;
6537 *
6538 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6539 * generalization of the TLS 1.2 signature algorithm extension.
6540 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6541 * `SignatureScheme` field of TLS 1.3
6542 *
6543 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006544int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6545 const unsigned char *buf,
6546 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006547{
6548 const unsigned char *p = buf;
6549 size_t supported_sig_algs_len = 0;
6550 const unsigned char *supported_sig_algs_end;
6551 uint16_t sig_alg;
6552 uint32_t common_idx = 0;
6553
Gilles Peskine449bd832023-01-11 14:50:10 +01006554 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6555 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006556 p += 2;
6557
Gilles Peskine449bd832023-01-11 14:50:10 +01006558 memset(ssl->handshake->received_sig_algs, 0,
6559 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006560
Gilles Peskine449bd832023-01-11 14:50:10 +01006561 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006562 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006563 while (p < supported_sig_algs_end) {
6564 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6565 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006566 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006567 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6568 sig_alg,
6569 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006570#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006571 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6572 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6573 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006574 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006575 }
6576#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006577
Gilles Peskine449bd832023-01-11 14:50:10 +01006578 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6579 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006580
Gilles Peskine449bd832023-01-11 14:50:10 +01006581 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006582 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6583 common_idx += 1;
6584 }
6585 }
6586 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006587 if (p != end) {
6588 MBEDTLS_SSL_DEBUG_MSG(1,
6589 ("Signature algorithms extension length misaligned"));
6590 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6591 MBEDTLS_ERR_SSL_DECODE_ERROR);
6592 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006593 }
6594
Gilles Peskine449bd832023-01-11 14:50:10 +01006595 if (common_idx == 0) {
6596 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6597 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6598 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6599 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006600 }
6601
Gabor Mezei15b95a62022-05-09 16:37:58 +02006602 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006603 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006604}
6605
Ronald Crone68ab4f2022-10-05 12:46:29 +02006606#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006607
Jerry Yudc7bd172022-02-17 13:44:15 +08006608#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6609
6610#if defined(MBEDTLS_USE_PSA_CRYPTO)
6611
Gilles Peskine449bd832023-01-11 14:50:10 +01006612static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6613 mbedtls_svc_key_id_t key,
6614 psa_algorithm_t alg,
6615 const unsigned char *raw_psk, size_t raw_psk_length,
6616 const unsigned char *seed, size_t seed_length,
6617 const unsigned char *label, size_t label_length,
6618 const unsigned char *other_secret,
6619 size_t other_secret_length,
6620 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006621{
6622 psa_status_t status;
6623
Gilles Peskine449bd832023-01-11 14:50:10 +01006624 status = psa_key_derivation_setup(derivation, alg);
6625 if (status != PSA_SUCCESS) {
6626 return status;
6627 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006628
Gilles Peskine449bd832023-01-11 14:50:10 +01006629 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6630 status = psa_key_derivation_input_bytes(derivation,
6631 PSA_KEY_DERIVATION_INPUT_SEED,
6632 seed, seed_length);
6633 if (status != PSA_SUCCESS) {
6634 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006635 }
6636
Gilles Peskine449bd832023-01-11 14:50:10 +01006637 if (other_secret != NULL) {
6638 status = psa_key_derivation_input_bytes(derivation,
6639 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6640 other_secret, other_secret_length);
6641 if (status != PSA_SUCCESS) {
6642 return status;
6643 }
6644 }
6645
6646 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006647 status = psa_key_derivation_input_bytes(
6648 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006649 raw_psk, raw_psk_length);
6650 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006651 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006652 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006653 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006654 if (status != PSA_SUCCESS) {
6655 return status;
6656 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006657
Gilles Peskine449bd832023-01-11 14:50:10 +01006658 status = psa_key_derivation_input_bytes(derivation,
6659 PSA_KEY_DERIVATION_INPUT_LABEL,
6660 label, label_length);
6661 if (status != PSA_SUCCESS) {
6662 return status;
6663 }
6664 } else {
6665 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006666 }
6667
Gilles Peskine449bd832023-01-11 14:50:10 +01006668 status = psa_key_derivation_set_capacity(derivation, capacity);
6669 if (status != PSA_SUCCESS) {
6670 return status;
6671 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006672
Gilles Peskine449bd832023-01-11 14:50:10 +01006673 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006674}
6675
Andrzej Kurek57d10632022-10-24 10:32:01 -04006676#if defined(PSA_WANT_ALG_SHA_384) || \
6677 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006678MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006679static int tls_prf_generic(mbedtls_md_type_t md_type,
6680 const unsigned char *secret, size_t slen,
6681 const char *label,
6682 const unsigned char *random, size_t rlen,
6683 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006684{
6685 psa_status_t status;
6686 psa_algorithm_t alg;
6687 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6688 psa_key_derivation_operation_t derivation =
6689 PSA_KEY_DERIVATION_OPERATION_INIT;
6690
Gilles Peskine449bd832023-01-11 14:50:10 +01006691 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006692 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006693 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006694 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006695 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006696
6697 /* Normally a "secret" should be long enough to be impossible to
6698 * find by brute force, and in particular should not be empty. But
6699 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6700 * and for this use case it makes sense to have a 0-length "secret".
6701 * Since the key API doesn't allow importing a key of length 0,
6702 * keep master_key=0, which setup_psa_key_derivation() understands
6703 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006704 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006705 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006706 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6707 psa_set_key_algorithm(&key_attributes, alg);
6708 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006709
Gilles Peskine449bd832023-01-11 14:50:10 +01006710 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6711 if (status != PSA_SUCCESS) {
6712 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6713 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006714 }
6715
Gilles Peskine449bd832023-01-11 14:50:10 +01006716 status = setup_psa_key_derivation(&derivation,
6717 master_key, alg,
6718 NULL, 0,
6719 random, rlen,
6720 (unsigned char const *) label,
6721 (size_t) strlen(label),
6722 NULL, 0,
6723 dlen);
6724 if (status != PSA_SUCCESS) {
6725 psa_key_derivation_abort(&derivation);
6726 psa_destroy_key(master_key);
6727 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006728 }
6729
Gilles Peskine449bd832023-01-11 14:50:10 +01006730 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6731 if (status != PSA_SUCCESS) {
6732 psa_key_derivation_abort(&derivation);
6733 psa_destroy_key(master_key);
6734 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006735 }
6736
Gilles Peskine449bd832023-01-11 14:50:10 +01006737 status = psa_key_derivation_abort(&derivation);
6738 if (status != PSA_SUCCESS) {
6739 psa_destroy_key(master_key);
6740 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006741 }
6742
Gilles Peskine449bd832023-01-11 14:50:10 +01006743 if (!mbedtls_svc_key_id_is_null(master_key)) {
6744 status = psa_destroy_key(master_key);
6745 }
6746 if (status != PSA_SUCCESS) {
6747 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6748 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006749
Gilles Peskine449bd832023-01-11 14:50:10 +01006750 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006751}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006752#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006753#else /* MBEDTLS_USE_PSA_CRYPTO */
6754
Andrzej Kurek57d10632022-10-24 10:32:01 -04006755#if defined(MBEDTLS_MD_C) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006756 (defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006757 defined(PSA_WANT_ALG_SHA_384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006758MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006759static int tls_prf_generic(mbedtls_md_type_t md_type,
6760 const unsigned char *secret, size_t slen,
6761 const char *label,
6762 const unsigned char *random, size_t rlen,
6763 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006764{
6765 size_t nb;
6766 size_t i, j, k, md_len;
6767 unsigned char *tmp;
6768 size_t tmp_len = 0;
6769 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6770 const mbedtls_md_info_t *md_info;
6771 mbedtls_md_context_t md_ctx;
6772 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6773
Gilles Peskine449bd832023-01-11 14:50:10 +01006774 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006775
Gilles Peskine449bd832023-01-11 14:50:10 +01006776 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6777 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6778 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006779
Gilles Peskine449bd832023-01-11 14:50:10 +01006780 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006781
Gilles Peskine449bd832023-01-11 14:50:10 +01006782 tmp_len = md_len + strlen(label) + rlen;
6783 tmp = mbedtls_calloc(1, tmp_len);
6784 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006785 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6786 goto exit;
6787 }
6788
Gilles Peskine449bd832023-01-11 14:50:10 +01006789 nb = strlen(label);
6790 memcpy(tmp + md_len, label, nb);
6791 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006792 nb += rlen;
6793
6794 /*
6795 * Compute P_<hash>(secret, label + random)[0..dlen]
6796 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006798 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006799 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006800
Gilles Peskine449bd832023-01-11 14:50:10 +01006801 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6802 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006803 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006804 }
6805 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6806 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006807 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006808 }
6809 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6810 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006811 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006812 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006813
Gilles Peskine449bd832023-01-11 14:50:10 +01006814 for (i = 0; i < dlen; i += md_len) {
6815 ret = mbedtls_md_hmac_reset(&md_ctx);
6816 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006817 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006818 }
6819 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6820 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006821 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006822 }
6823 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6824 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006825 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006826 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006827
Gilles Peskine449bd832023-01-11 14:50:10 +01006828 ret = mbedtls_md_hmac_reset(&md_ctx);
6829 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006830 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006831 }
6832 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6833 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006834 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006835 }
6836 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6837 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006838 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006839 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006840
Gilles Peskine449bd832023-01-11 14:50:10 +01006841 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006842
Gilles Peskine449bd832023-01-11 14:50:10 +01006843 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006844 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006845 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006846 }
6847
6848exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006849 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006850
Gilles Peskine449bd832023-01-11 14:50:10 +01006851 if (tmp != NULL) {
6852 mbedtls_platform_zeroize(tmp, tmp_len);
6853 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006854
Gilles Peskine449bd832023-01-11 14:50:10 +01006855 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006856
Gilles Peskine449bd832023-01-11 14:50:10 +01006857 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006858
Gilles Peskine449bd832023-01-11 14:50:10 +01006859 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006860}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006861#endif /* MBEDTLS_MD_C && ( PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006862#endif /* MBEDTLS_USE_PSA_CRYPTO */
6863
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006864#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006865MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006866static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6867 const char *label,
6868 const unsigned char *random, size_t rlen,
6869 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006870{
Gilles Peskine449bd832023-01-11 14:50:10 +01006871 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6872 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006873}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006874#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006875
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006876#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006877MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006878static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6879 const char *label,
6880 const unsigned char *random, size_t rlen,
6881 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006882{
Gilles Peskine449bd832023-01-11 14:50:10 +01006883 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6884 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006885}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006886#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006887
Jerry Yuf009d862022-02-17 14:01:37 +08006888/*
6889 * Set appropriate PRF function and other SSL / TLS1.2 functions
6890 *
6891 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006892 * - hash associated with the ciphersuite (only used by TLS 1.2)
6893 *
6894 * Outputs:
6895 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6896 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006897MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006898static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6899 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006900{
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006901#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006902 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006903 handshake->tls_prf = tls_prf_sha384;
6904 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6905 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006906 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006907#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006908#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuf009d862022-02-17 14:01:37 +08006909 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006910 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006911 handshake->tls_prf = tls_prf_sha256;
6912 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6913 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6914 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006915#else
Jerry Yuf009d862022-02-17 14:01:37 +08006916 {
Jerry Yuf009d862022-02-17 14:01:37 +08006917 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006918 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01006919 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08006920 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006921#endif
Jerry Yuf009d862022-02-17 14:01:37 +08006922
Gilles Peskine449bd832023-01-11 14:50:10 +01006923 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08006924}
Jerry Yud6ab2352022-02-17 14:03:43 +08006925
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006926/*
6927 * Compute master secret if needed
6928 *
6929 * Parameters:
6930 * [in/out] handshake
6931 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
6932 * (PSA-PSK) ciphersuite_info, psk_opaque
6933 * [out] premaster (cleared)
6934 * [out] master
6935 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
6936 * debug: conf->f_dbg, conf->p_dbg
6937 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01006938 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006939 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006940MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006941static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
6942 unsigned char *master,
6943 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006944{
6945 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6946
6947 /* cf. RFC 5246, Section 8.1:
6948 * "The master secret is always exactly 48 bytes in length." */
6949 size_t const master_secret_len = 48;
6950
6951#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
6952 unsigned char session_hash[48];
6953#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
6954
6955 /* The label for the KDF used for key expansion.
6956 * This is either "master secret" or "extended master secret"
6957 * depending on whether the Extended Master Secret extension
6958 * is used. */
6959 char const *lbl = "master secret";
6960
Przemek Stekielae4ed302022-04-05 17:15:55 +02006961 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006962 * - If the Extended Master Secret extension is not used,
6963 * this is ClientHello.Random + ServerHello.Random
6964 * (see Sect. 8.1 in RFC 5246).
6965 * - If the Extended Master Secret extension is used,
6966 * this is the transcript of the handshake so far.
6967 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02006968 unsigned char const *seed = handshake->randbytes;
6969 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006970
6971#if !defined(MBEDTLS_DEBUG_C) && \
6972 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
6973 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01006974 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006975 ssl = NULL; /* make sure we don't use it except for those cases */
6976 (void) ssl;
6977#endif
6978
Gilles Peskine449bd832023-01-11 14:50:10 +01006979 if (handshake->resume != 0) {
6980 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
6981 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006982 }
6983
6984#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01006985 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006986 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02006987 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01006988 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
6989 if (ret != 0) {
6990 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
6991 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006992
Gilles Peskine449bd832023-01-11 14:50:10 +01006993 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
6994 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006995 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02006996#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08006997
Przemek Stekiel99114f32022-04-22 11:20:09 +02006998#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02006999 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007000 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007001 /* Perform PSK-to-MS expansion in a single step. */
7002 psa_status_t status;
7003 psa_algorithm_t alg;
7004 mbedtls_svc_key_id_t psk;
7005 psa_key_derivation_operation_t derivation =
7006 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01007007 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007008
Gilles Peskine449bd832023-01-11 14:50:10 +01007009 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007010
Gilles Peskine449bd832023-01-11 14:50:10 +01007011 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007012
Gilles Peskine449bd832023-01-11 14:50:10 +01007013 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007014 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01007015 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007016 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01007017 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007018
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007019 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007020 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02007021
Gilles Peskine449bd832023-01-11 14:50:10 +01007022 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007023 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007024 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007025 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02007026 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007027 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007028 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007029 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
7030 other_secret = handshake->premaster + 2;
7031 break;
7032 default:
7033 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02007034 }
7035
Gilles Peskine449bd832023-01-11 14:50:10 +01007036 status = setup_psa_key_derivation(&derivation, psk, alg,
7037 ssl->conf->psk, ssl->conf->psk_len,
7038 seed, seed_len,
7039 (unsigned char const *) lbl,
7040 (size_t) strlen(lbl),
7041 other_secret, other_secret_len,
7042 master_secret_len);
7043 if (status != PSA_SUCCESS) {
7044 psa_key_derivation_abort(&derivation);
7045 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007046 }
7047
Gilles Peskine449bd832023-01-11 14:50:10 +01007048 status = psa_key_derivation_output_bytes(&derivation,
7049 master,
7050 master_secret_len);
7051 if (status != PSA_SUCCESS) {
7052 psa_key_derivation_abort(&derivation);
7053 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007054 }
7055
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 status = psa_key_derivation_abort(&derivation);
7057 if (status != PSA_SUCCESS) {
7058 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7059 }
7060 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007061#endif
7062 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007063#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007064 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7065 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007066 psa_status_t status;
7067 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
7068 psa_key_derivation_operation_t derivation =
7069 PSA_KEY_DERIVATION_OPERATION_INIT;
7070
Gilles Peskine449bd832023-01-11 14:50:10 +01007071 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02007072
7073 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
7074
Gilles Peskine449bd832023-01-11 14:50:10 +01007075 status = psa_key_derivation_setup(&derivation, alg);
7076 if (status != PSA_SUCCESS) {
7077 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007078 }
7079
Gilles Peskine449bd832023-01-11 14:50:10 +01007080 status = psa_key_derivation_set_capacity(&derivation,
7081 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
7082 if (status != PSA_SUCCESS) {
7083 psa_key_derivation_abort(&derivation);
7084 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007085 }
7086
Gilles Peskine449bd832023-01-11 14:50:10 +01007087 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
7088 &derivation);
7089 if (status != PSA_SUCCESS) {
7090 psa_key_derivation_abort(&derivation);
7091 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007092 }
7093
Gilles Peskine449bd832023-01-11 14:50:10 +01007094 status = psa_key_derivation_output_bytes(&derivation,
7095 handshake->premaster,
7096 handshake->pmslen);
7097 if (status != PSA_SUCCESS) {
7098 psa_key_derivation_abort(&derivation);
7099 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7100 }
7101
7102 status = psa_key_derivation_abort(&derivation);
7103 if (status != PSA_SUCCESS) {
7104 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007105 }
7106 }
7107#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007108 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
7109 lbl, seed, seed_len,
7110 master,
7111 master_secret_len);
7112 if (ret != 0) {
7113 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7114 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007115 }
7116
Gilles Peskine449bd832023-01-11 14:50:10 +01007117 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
7118 handshake->premaster,
7119 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007120
Gilles Peskine449bd832023-01-11 14:50:10 +01007121 mbedtls_platform_zeroize(handshake->premaster,
7122 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007123 }
7124
Gilles Peskine449bd832023-01-11 14:50:10 +01007125 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007126}
7127
Gilles Peskine449bd832023-01-11 14:50:10 +01007128int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08007129{
7130 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7131 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7132 ssl->handshake->ciphersuite_info;
7133
Gilles Peskine449bd832023-01-11 14:50:10 +01007134 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007135
7136 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007137 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01007138 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007139 if (ret != 0) {
7140 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
7141 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007142 }
7143
7144 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01007145 ret = ssl_compute_master(ssl->handshake,
7146 ssl->session_negotiate->master,
7147 ssl);
7148 if (ret != 0) {
7149 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
7150 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007151 }
7152
7153 /* Swap the client and server random values:
7154 * - MS derivation wanted client+server (RFC 5246 8.1)
7155 * - key derivation wants server+client (RFC 5246 6.3) */
7156 {
7157 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01007158 memcpy(tmp, ssl->handshake->randbytes, 64);
7159 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
7160 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
7161 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08007162 }
7163
7164 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01007165 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
7166 ssl->session_negotiate->ciphersuite,
7167 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007168#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007169 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007170#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007171 ssl->handshake->tls_prf,
7172 ssl->handshake->randbytes,
7173 ssl->tls_version,
7174 ssl->conf->endpoint,
7175 ssl);
7176 if (ret != 0) {
7177 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
7178 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007179 }
7180
7181 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01007182 mbedtls_platform_zeroize(ssl->handshake->randbytes,
7183 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08007184
Gilles Peskine449bd832023-01-11 14:50:10 +01007185 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007186
Gilles Peskine449bd832023-01-11 14:50:10 +01007187 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08007188}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007189
Gilles Peskine449bd832023-01-11 14:50:10 +01007190int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007191{
Gilles Peskine449bd832023-01-11 14:50:10 +01007192 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007193#if defined(PSA_WANT_ALG_SHA_384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007194 case MBEDTLS_SSL_HASH_SHA384:
7195 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
7196 break;
7197#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007198#if defined(PSA_WANT_ALG_SHA_256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007199 case MBEDTLS_SSL_HASH_SHA256:
7200 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
7201 break;
7202#endif
7203 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007204 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007205 }
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007206#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007207 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007208 (void) ssl;
7209#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007210 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007211}
7212
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007213#if defined(MBEDTLS_USE_PSA_CRYPTO)
7214static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
7215 const psa_hash_operation_t *hs_op,
7216 size_t buffer_size,
7217 unsigned char *hash,
7218 size_t *hlen)
7219{
7220 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007221 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007222
7223#if !defined(MBEDTLS_DEBUG_C)
7224 (void) ssl;
7225#endif
7226 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007227 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007228 if (status != PSA_SUCCESS) {
7229 goto exit;
7230 }
7231
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007232 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007233 if (status != PSA_SUCCESS) {
7234 goto exit;
7235 }
7236
7237 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
7238 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
7239
7240exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007241 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007242 return mbedtls_md_error_from_psa(status);
7243}
7244#else
7245static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
7246 const mbedtls_md_context_t *hs_ctx,
7247 unsigned char *hash,
7248 size_t *hlen)
7249{
7250 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007251 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007252
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007253 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007254
7255#if !defined(MBEDTLS_DEBUG_C)
7256 (void) ssl;
7257#endif
7258 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
7259
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007260 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007261 if (ret != 0) {
7262 goto exit;
7263 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007264 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007265 if (ret != 0) {
7266 goto exit;
7267 }
7268
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007269 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007270 if (ret != 0) {
7271 goto exit;
7272 }
7273
7274 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
7275
7276 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
7277 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
7278
7279exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007280 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007281 return ret;
7282}
7283#endif /* MBEDTLS_USE_PSA_CRYPTO */
7284
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007285#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007286int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
7287 unsigned char *hash,
7288 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08007289{
7290#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007291 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
7292 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007293#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007294 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
7295 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007296#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007297}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007298#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007299
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007300#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007301int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
7302 unsigned char *hash,
7303 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08007304{
7305#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007306 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
7307 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007308#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007309 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
7310 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007311#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007312}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007313#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007314
Neil Armstrong80f6f322022-05-03 17:56:38 +02007315#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
7316 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007317int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08007318{
7319 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01007320 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007321 const unsigned char *psk = NULL;
7322 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007323 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007324
Gilles Peskine449bd832023-01-11 14:50:10 +01007325 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007326 /*
7327 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007328 * checked before calling this function.
7329 *
7330 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007331 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08007332 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007333 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
7334 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7335 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007336 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007337 }
7338
7339 /*
7340 * PMS = struct {
7341 * opaque other_secret<0..2^16-1>;
7342 * opaque psk<0..2^16-1>;
7343 * };
7344 * with "other_secret" depending on the particular key exchange
7345 */
7346#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007347 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
7348 if (end - p < 2) {
7349 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7350 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007351
Gilles Peskine449bd832023-01-11 14:50:10 +01007352 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007353 p += 2;
7354
Gilles Peskine449bd832023-01-11 14:50:10 +01007355 if (end < p || (size_t) (end - p) < psk_len) {
7356 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7357 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007358
Gilles Peskine449bd832023-01-11 14:50:10 +01007359 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007360 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007361 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007362#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007363#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007364 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007365 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7366 size_t len;
7367
7368 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01007369 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007370 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01007371 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7372 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
7373 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007374 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007375 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007376 p += 2 + len;
7377
Gilles Peskine449bd832023-01-11 14:50:10 +01007378 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
7379 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007380#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02007381#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007382 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007383 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7384 size_t zlen;
7385
Gilles Peskine449bd832023-01-11 14:50:10 +01007386 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007387 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01007388 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7389 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
7390 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007391 }
7392
Gilles Peskine449bd832023-01-11 14:50:10 +01007393 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007394 p += 2 + zlen;
7395
Gilles Peskine449bd832023-01-11 14:50:10 +01007396 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
7397 MBEDTLS_DEBUG_ECDH_Z);
7398 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02007399#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007400 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007401 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7402 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08007403 }
7404
7405 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01007406 if (end - p < 2) {
7407 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7408 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007409
Gilles Peskine449bd832023-01-11 14:50:10 +01007410 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007411 p += 2;
7412
Gilles Peskine449bd832023-01-11 14:50:10 +01007413 if (end < p || (size_t) (end - p) < psk_len) {
7414 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7415 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007416
Gilles Peskine449bd832023-01-11 14:50:10 +01007417 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007418 p += psk_len;
7419
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007420 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007421
Gilles Peskine449bd832023-01-11 14:50:10 +01007422 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08007423}
Neil Armstrong80f6f322022-05-03 17:56:38 +02007424#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007425
7426#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007427MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007428static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007429
7430#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007431int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08007432{
7433 /* If renegotiation is not enforced, retransmit until we would reach max
7434 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01007435 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007436 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7437 unsigned char doublings = 1;
7438
Gilles Peskine449bd832023-01-11 14:50:10 +01007439 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007440 ++doublings;
7441 ratio >>= 1;
7442 }
7443
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 if (++ssl->renego_records_seen > doublings) {
7445 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
7446 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08007447 }
7448 }
7449
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007451}
7452#endif
7453#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007454
Jerry Yud9526692022-02-17 14:23:47 +08007455/*
7456 * Handshake functions
7457 */
7458#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7459/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007460int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007461{
7462 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7463 ssl->handshake->ciphersuite_info;
7464
Gilles Peskine449bd832023-01-11 14:50:10 +01007465 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007466
Gilles Peskine449bd832023-01-11 14:50:10 +01007467 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7468 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007469 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007470 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007471 }
7472
Gilles Peskine449bd832023-01-11 14:50:10 +01007473 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7474 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007475}
7476
Gilles Peskine449bd832023-01-11 14:50:10 +01007477int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007478{
7479 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7480 ssl->handshake->ciphersuite_info;
7481
Gilles Peskine449bd832023-01-11 14:50:10 +01007482 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007483
Gilles Peskine449bd832023-01-11 14:50:10 +01007484 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7485 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007486 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007487 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007488 }
7489
Gilles Peskine449bd832023-01-11 14:50:10 +01007490 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7491 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007492}
7493
7494#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7495/* Some certificate support -> implement write and parse */
7496
Gilles Peskine449bd832023-01-11 14:50:10 +01007497int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007498{
7499 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7500 size_t i, n;
7501 const mbedtls_x509_crt *crt;
7502 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7503 ssl->handshake->ciphersuite_info;
7504
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007506
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7508 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007509 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007510 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007511 }
7512
7513#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007514 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7515 if (ssl->handshake->client_auth == 0) {
7516 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007517 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007518 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007519 }
7520 }
7521#endif /* MBEDTLS_SSL_CLI_C */
7522#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007523 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7524 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007525 /* Should never happen because we shouldn't have picked the
7526 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007527 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007528 }
7529 }
7530#endif
7531
Gilles Peskine449bd832023-01-11 14:50:10 +01007532 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007533
7534 /*
7535 * 0 . 0 handshake type
7536 * 1 . 3 handshake length
7537 * 4 . 6 length of all certs
7538 * 7 . 9 length of cert. 1
7539 * 10 . n-1 peer certificate
7540 * n . n+2 length of cert. 2
7541 * n+3 . ... upper level cert, etc.
7542 */
7543 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007544 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007545
Gilles Peskine449bd832023-01-11 14:50:10 +01007546 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007547 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007548 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7549 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7550 " > %" MBEDTLS_PRINTF_SIZET,
7551 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7552 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007553 }
7554
Gilles Peskine449bd832023-01-11 14:50:10 +01007555 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7556 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7557 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007558
Gilles Peskine449bd832023-01-11 14:50:10 +01007559 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007560 i += n; crt = crt->next;
7561 }
7562
Gilles Peskine449bd832023-01-11 14:50:10 +01007563 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7564 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7565 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007566
7567 ssl->out_msglen = i;
7568 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7569 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7570
7571 ssl->state++;
7572
Gilles Peskine449bd832023-01-11 14:50:10 +01007573 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7574 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7575 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007576 }
7577
Gilles Peskine449bd832023-01-11 14:50:10 +01007578 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007579
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007581}
7582
7583#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7584
7585#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007586MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007587static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7588 unsigned char *crt_buf,
7589 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007590{
7591 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7592
Gilles Peskine449bd832023-01-11 14:50:10 +01007593 if (peer_crt == NULL) {
7594 return -1;
7595 }
Jerry Yud9526692022-02-17 14:23:47 +08007596
Gilles Peskine449bd832023-01-11 14:50:10 +01007597 if (peer_crt->raw.len != crt_buf_len) {
7598 return -1;
7599 }
Jerry Yud9526692022-02-17 14:23:47 +08007600
Gilles Peskine449bd832023-01-11 14:50:10 +01007601 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007602}
7603#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007604MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007605static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7606 unsigned char *crt_buf,
7607 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007608{
7609 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7610 unsigned char const * const peer_cert_digest =
7611 ssl->session->peer_cert_digest;
7612 mbedtls_md_type_t const peer_cert_digest_type =
7613 ssl->session->peer_cert_digest_type;
7614 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007615 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007616 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7617 size_t digest_len;
7618
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 if (peer_cert_digest == NULL || digest_info == NULL) {
7620 return -1;
7621 }
Jerry Yud9526692022-02-17 14:23:47 +08007622
Gilles Peskine449bd832023-01-11 14:50:10 +01007623 digest_len = mbedtls_md_get_size(digest_info);
7624 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7625 return -1;
7626 }
Jerry Yud9526692022-02-17 14:23:47 +08007627
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7629 if (ret != 0) {
7630 return -1;
7631 }
Jerry Yud9526692022-02-17 14:23:47 +08007632
Gilles Peskine449bd832023-01-11 14:50:10 +01007633 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007634}
7635#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7636#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7637
7638/*
7639 * Once the certificate message is read, parse it into a cert chain and
7640 * perform basic checks, but leave actual verification to the caller
7641 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007642MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007643static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7644 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007645{
7646 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7647#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007648 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007649#endif
7650 size_t i, n;
7651 uint8_t alert;
7652
Gilles Peskine449bd832023-01-11 14:50:10 +01007653 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7654 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7655 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7656 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7657 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007658 }
7659
Gilles Peskine449bd832023-01-11 14:50:10 +01007660 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7661 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7662 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7663 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007664 }
7665
Gilles Peskine449bd832023-01-11 14:50:10 +01007666 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7667 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7668 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7669 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7670 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007671 }
7672
Gilles Peskine449bd832023-01-11 14:50:10 +01007673 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007674
7675 /*
7676 * Same message structure as in mbedtls_ssl_write_certificate()
7677 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007678 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007679
Gilles Peskine449bd832023-01-11 14:50:10 +01007680 if (ssl->in_msg[i] != 0 ||
7681 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7682 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7683 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7684 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7685 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007686 }
7687
7688 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7689 i += 3;
7690
7691 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007692 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007693 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007694 if (i + 3 > ssl->in_hslen) {
7695 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7696 mbedtls_ssl_send_alert_message(ssl,
7697 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7698 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7699 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007700 }
7701 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7702 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007703 if (ssl->in_msg[i] != 0) {
7704 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7705 mbedtls_ssl_send_alert_message(ssl,
7706 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7707 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7708 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007709 }
7710
7711 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007712 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007713 i += 3;
7714
Gilles Peskine449bd832023-01-11 14:50:10 +01007715 if (n < 128 || i + n > ssl->in_hslen) {
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_DECODE_ERROR);
7720 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007721 }
7722
7723 /* Check if we're handling the first CRT in the chain. */
7724#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007725 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007726 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007727 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007728 /* During client-side renegotiation, check that the server's
7729 * end-CRTs hasn't changed compared to the initial handshake,
7730 * mitigating the triple handshake attack. On success, reuse
7731 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007732 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7733 if (ssl_check_peer_crt_unchanged(ssl,
7734 &ssl->in_msg[i],
7735 n) != 0) {
7736 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7737 mbedtls_ssl_send_alert_message(ssl,
7738 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7739 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7740 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007741 }
7742
7743 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007744 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007745 }
7746#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7747
7748 /* Parse the next certificate in the chain. */
7749#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007750 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007751#else
7752 /* If we don't need to store the CRT chain permanently, parse
7753 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007754 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007755#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007756 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007757 case 0: /*ok*/
7758 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7759 /* Ignore certificate with an unknown algorithm: maybe a
7760 prior certificate was already trusted. */
7761 break;
7762
7763 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7764 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7765 goto crt_parse_der_failed;
7766
7767 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7768 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7769 goto crt_parse_der_failed;
7770
7771 default:
7772 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007773crt_parse_der_failed:
7774 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7775 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7776 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007777 }
7778
7779 i += n;
7780 }
7781
Gilles Peskine449bd832023-01-11 14:50:10 +01007782 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7783 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007784}
7785
7786#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007787MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007788static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007789{
Gilles Peskine449bd832023-01-11 14:50:10 +01007790 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7791 return -1;
7792 }
Jerry Yud9526692022-02-17 14:23:47 +08007793
Gilles Peskine449bd832023-01-11 14:50:10 +01007794 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007795 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7796 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007797 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7798 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7799 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007800 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007801 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007802}
7803#endif /* MBEDTLS_SSL_SRV_C */
7804
7805/* Check if a certificate message is expected.
7806 * Return either
7807 * - SSL_CERTIFICATE_EXPECTED, or
7808 * - SSL_CERTIFICATE_SKIP
7809 * indicating whether a Certificate message is expected or not.
7810 */
7811#define SSL_CERTIFICATE_EXPECTED 0
7812#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007813MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007814static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7815 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007816{
7817 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7818 ssl->handshake->ciphersuite_info;
7819
Gilles Peskine449bd832023-01-11 14:50:10 +01007820 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7821 return SSL_CERTIFICATE_SKIP;
7822 }
Jerry Yud9526692022-02-17 14:23:47 +08007823
7824#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007825 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007826 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007827 ssl->session_negotiate->verify_result =
7828 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007829 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007830 }
7831 }
7832#else
7833 ((void) authmode);
7834#endif /* MBEDTLS_SSL_SRV_C */
7835
Gilles Peskine449bd832023-01-11 14:50:10 +01007836 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007837}
7838
Jerry Yud9526692022-02-17 14:23:47 +08007839#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007840MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007841static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
7842 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007843{
7844 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7845 /* Remember digest of the peer's end-CRT. */
7846 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01007847 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
7848 if (ssl->session_negotiate->peer_cert_digest == NULL) {
7849 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
7850 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
7851 mbedtls_ssl_send_alert_message(ssl,
7852 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7853 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007854
Gilles Peskine449bd832023-01-11 14:50:10 +01007855 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08007856 }
7857
Gilles Peskine449bd832023-01-11 14:50:10 +01007858 ret = mbedtls_md(mbedtls_md_info_from_type(
7859 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
7860 start, len,
7861 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08007862
7863 ssl->session_negotiate->peer_cert_digest_type =
7864 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
7865 ssl->session_negotiate->peer_cert_digest_len =
7866 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
7867
Gilles Peskine449bd832023-01-11 14:50:10 +01007868 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007869}
7870
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007871MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007872static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
7873 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08007874{
7875 unsigned char *end = start + len;
7876 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7877
7878 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007879 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
7880 ret = mbedtls_pk_parse_subpubkey(&start, end,
7881 &ssl->handshake->peer_pubkey);
7882 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007883 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007884 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007885 }
7886
Gilles Peskine449bd832023-01-11 14:50:10 +01007887 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007888}
7889#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7890
Gilles Peskine449bd832023-01-11 14:50:10 +01007891int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007892{
7893 int ret = 0;
7894 int crt_expected;
Manuel Pégourié-Gonnard58ab9ba2024-08-14 09:47:38 +02007895 /* Authmode: precedence order is SNI if used else configuration */
Jerry Yud9526692022-02-17 14:23:47 +08007896#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
7897 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
7898 ? ssl->handshake->sni_authmode
7899 : ssl->conf->authmode;
7900#else
7901 const int authmode = ssl->conf->authmode;
7902#endif
7903 void *rs_ctx = NULL;
7904 mbedtls_x509_crt *chain = NULL;
7905
Gilles Peskine449bd832023-01-11 14:50:10 +01007906 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007907
Gilles Peskine449bd832023-01-11 14:50:10 +01007908 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
7909 if (crt_expected == SSL_CERTIFICATE_SKIP) {
7910 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007911 goto exit;
7912 }
7913
7914#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007915 if (ssl->handshake->ecrs_enabled &&
7916 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08007917 chain = ssl->handshake->ecrs_peer_cert;
7918 ssl->handshake->ecrs_peer_cert = NULL;
7919 goto crt_verify;
7920 }
7921#endif
7922
Gilles Peskine449bd832023-01-11 14:50:10 +01007923 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007924 /* mbedtls_ssl_read_record may have sent an alert already. We
7925 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08007927 goto exit;
7928 }
7929
7930#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007931 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007932 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
7933
Gilles Peskine449bd832023-01-11 14:50:10 +01007934 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08007935 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01007936 }
Jerry Yud9526692022-02-17 14:23:47 +08007937
7938 goto exit;
7939 }
7940#endif /* MBEDTLS_SSL_SRV_C */
7941
7942 /* Clear existing peer CRT structure in case we tried to
7943 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007944 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08007945
Gilles Peskine449bd832023-01-11 14:50:10 +01007946 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
7947 if (chain == NULL) {
7948 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
7949 sizeof(mbedtls_x509_crt)));
7950 mbedtls_ssl_send_alert_message(ssl,
7951 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7952 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08007953
7954 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
7955 goto exit;
7956 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007957 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08007958
Gilles Peskine449bd832023-01-11 14:50:10 +01007959 ret = ssl_parse_certificate_chain(ssl, chain);
7960 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007961 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007962 }
Jerry Yud9526692022-02-17 14:23:47 +08007963
7964#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007965 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007966 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01007967 }
Jerry Yud9526692022-02-17 14:23:47 +08007968
7969crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01007970 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08007971 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01007972 }
Jerry Yud9526692022-02-17 14:23:47 +08007973#endif
7974
Manuel Pégourié-Gonnard19dd9f52024-08-16 11:03:42 +02007975 ret = mbedtls_ssl_verify_certificate(ssl, authmode, chain,
7976 ssl->handshake->ciphersuite_info,
7977 rs_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +01007978 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08007979 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007980 }
Jerry Yud9526692022-02-17 14:23:47 +08007981
7982#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
7983 {
7984 unsigned char *crt_start, *pk_start;
7985 size_t crt_len, pk_len;
7986
7987 /* We parse the CRT chain without copying, so
7988 * these pointers point into the input buffer,
7989 * and are hence still valid after freeing the
7990 * CRT chain. */
7991
7992 crt_start = chain->raw.p;
7993 crt_len = chain->raw.len;
7994
7995 pk_start = chain->pk_raw.p;
7996 pk_len = chain->pk_raw.len;
7997
7998 /* Free the CRT structures before computing
7999 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008000 mbedtls_x509_crt_free(chain);
8001 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008002 chain = NULL;
8003
Gilles Peskine449bd832023-01-11 14:50:10 +01008004 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
8005 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008006 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008007 }
Jerry Yud9526692022-02-17 14:23:47 +08008008
Gilles Peskine449bd832023-01-11 14:50:10 +01008009 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
8010 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008011 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008012 }
Jerry Yud9526692022-02-17 14:23:47 +08008013 }
8014#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8015 /* Pass ownership to session structure. */
8016 ssl->session_negotiate->peer_cert = chain;
8017 chain = NULL;
8018#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8019
Gilles Peskine449bd832023-01-11 14:50:10 +01008020 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008021
8022exit:
8023
Gilles Peskine449bd832023-01-11 14:50:10 +01008024 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008025 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008026 }
Jerry Yud9526692022-02-17 14:23:47 +08008027
8028#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008029 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08008030 ssl->handshake->ecrs_peer_cert = chain;
8031 chain = NULL;
8032 }
8033#endif
8034
Gilles Peskine449bd832023-01-11 14:50:10 +01008035 if (chain != NULL) {
8036 mbedtls_x509_crt_free(chain);
8037 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008038 }
8039
Gilles Peskine449bd832023-01-11 14:50:10 +01008040 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008041}
8042#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8043
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008044static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
8045 unsigned char *padbuf, size_t hlen,
8046 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008047{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008048 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008049 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008050#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008051 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008052 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008053 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008054 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008055#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008056 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008057 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008058 mbedtls_md_context_t cloned_ctx;
8059 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008060#endif
8061
8062 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01008063 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08008064 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01008065 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008066
Gilles Peskine449bd832023-01-11 14:50:10 +01008067 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008068 ? "client finished"
8069 : "server finished";
8070
8071#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008072 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008073
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008074 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01008075 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008076 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008077 }
8078
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008079 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01008080 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008081 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008082 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008083 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008084#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008085 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008086
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008087 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008088 if (ret != 0) {
8089 goto exit;
8090 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008091 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008092 if (ret != 0) {
8093 goto exit;
8094 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008095
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008096 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008097 if (ret != 0) {
8098 goto exit;
8099 }
8100#endif /* MBEDTLS_USE_PSA_CRYPTO */
8101
8102 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
8103
Jerry Yu615bd6f2022-02-17 14:25:15 +08008104 /*
8105 * TLSv1.2:
8106 * hash = PRF( master, finished_label,
8107 * Hash( handshake ) )[0.11]
8108 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008109 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008110 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008111
Gilles Peskine449bd832023-01-11 14:50:10 +01008112 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008113
Paul Elliottecb95be2023-08-11 16:41:04 +01008114 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008115
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008116 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008117
8118exit:
8119#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008120 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02008121 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008122#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008123 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008124 return ret;
8125#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08008126}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008127
Elena Uziunaite0916cd72024-05-23 17:01:07 +01008128#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008129static int ssl_calc_finished_tls_sha256(
8130 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
8131{
8132 unsigned char padbuf[32];
8133 return ssl_calc_finished_tls_generic(ssl,
8134#if defined(MBEDTLS_USE_PSA_CRYPTO)
8135 &ssl->handshake->fin_sha256_psa,
8136#else
8137 &ssl->handshake->fin_sha256,
8138#endif
8139 padbuf, sizeof(padbuf),
8140 buf, from);
8141}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01008142#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08008143
Jerry Yub7ba49e2022-02-17 14:25:53 +08008144
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01008145#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01008146static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01008147 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08008148{
Jerry Yub7ba49e2022-02-17 14:25:53 +08008149 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008150 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008151#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008152 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008153#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008154 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008155#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008156 padbuf, sizeof(padbuf),
8157 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08008158}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01008159#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08008160
Gilles Peskine449bd832023-01-11 14:50:10 +01008161void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08008162{
Gilles Peskine449bd832023-01-11 14:50:10 +01008163 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008164
8165 /*
8166 * Free our handshake params
8167 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008168 mbedtls_ssl_handshake_free(ssl);
8169 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08008170 ssl->handshake = NULL;
8171
8172 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08008173 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08008174 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008175 if (ssl->transform) {
8176 mbedtls_ssl_transform_free(ssl->transform);
8177 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08008178 }
8179 ssl->transform = ssl->transform_negotiate;
8180 ssl->transform_negotiate = NULL;
8181
Gilles Peskine449bd832023-01-11 14:50:10 +01008182 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008183}
8184
Gilles Peskine449bd832023-01-11 14:50:10 +01008185void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08008186{
8187 int resume = ssl->handshake->resume;
8188
Gilles Peskine449bd832023-01-11 14:50:10 +01008189 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008190
8191#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008192 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008193 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
8194 ssl->renego_records_seen = 0;
8195 }
8196#endif
8197
8198 /*
8199 * Free the previous session and switch in the current one
8200 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008201 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008202#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8203 /* RFC 7366 3.1: keep the EtM state */
8204 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01008205 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008206#endif
8207
Gilles Peskine449bd832023-01-11 14:50:10 +01008208 mbedtls_ssl_session_free(ssl->session);
8209 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008210 }
8211 ssl->session = ssl->session_negotiate;
8212 ssl->session_negotiate = NULL;
8213
8214 /*
8215 * Add cache entry
8216 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008217 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08008218 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01008219 resume == 0) {
8220 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
8221 ssl->session->id,
8222 ssl->session->id_len,
8223 ssl->session) != 0) {
8224 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
8225 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08008226 }
8227
8228#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008229 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8230 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008231 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01008232 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008233
8234 /* Keep last flight around in case we need to resend it:
8235 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01008236 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
8237 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08008238#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008239 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008240
Jerry Yu5ed73ff2022-10-27 13:08:42 +08008241 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008242
Gilles Peskine449bd832023-01-11 14:50:10 +01008243 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008244}
8245
Gilles Peskine449bd832023-01-11 14:50:10 +01008246int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008247{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008248 int ret;
8249 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008250
Gilles Peskine449bd832023-01-11 14:50:10 +01008251 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008252
Gilles Peskine449bd832023-01-11 14:50:10 +01008253 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008254
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008255 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
8256 if (ret != 0) {
8257 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8258 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008259
8260 /*
8261 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
8262 * may define some other value. Currently (early 2016), no defined
8263 * ciphersuite does this (and this is unlikely to change as activity has
8264 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
8265 */
8266 hash_len = 12;
8267
8268#if defined(MBEDTLS_SSL_RENEGOTIATION)
8269 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008270 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008271#endif
8272
8273 ssl->out_msglen = 4 + hash_len;
8274 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8275 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8276
8277 /*
8278 * In case of session resuming, invert the client and server
8279 * ChangeCipherSpec messages order.
8280 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008281 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008282#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008283 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008284 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008285 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008286#endif
8287#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008288 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008289 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008290 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008291#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008292 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008293 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008294 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008295
8296 /*
8297 * Switch to our negotiated transform and session parameters for outbound
8298 * data.
8299 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008300 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008301
8302#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008303 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008304 unsigned char i;
8305
8306 /* Remember current epoch settings for resending */
8307 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008308 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8309 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008310
8311 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008312 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008313
8314
8315 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008316 for (i = 2; i > 0; i--) {
8317 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008318 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008319 }
8320 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008321
8322 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008323 if (i == 0) {
8324 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8325 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008326 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008327 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008328#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008329 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008330
8331 ssl->transform_out = ssl->transform_negotiate;
8332 ssl->session_out = ssl->session_negotiate;
8333
8334#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008335 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8336 mbedtls_ssl_send_flight_completed(ssl);
8337 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008338#endif
8339
Gilles Peskine449bd832023-01-11 14:50:10 +01008340 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8341 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8342 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008343 }
8344
8345#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008346 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8347 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8348 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8349 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008350 }
8351#endif
8352
Gilles Peskine449bd832023-01-11 14:50:10 +01008353 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008354
Gilles Peskine449bd832023-01-11 14:50:10 +01008355 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008356}
8357
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008358#define SSL_MAX_HASH_LEN 12
8359
Gilles Peskine449bd832023-01-11 14:50:10 +01008360int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008361{
8362 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8363 unsigned int hash_len = 12;
8364 unsigned char buf[SSL_MAX_HASH_LEN];
8365
Gilles Peskine449bd832023-01-11 14:50:10 +01008366 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008367
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008368 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8369 if (ret != 0) {
8370 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8371 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008372
Gilles Peskine449bd832023-01-11 14:50:10 +01008373 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8374 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008375 goto exit;
8376 }
8377
Gilles Peskine449bd832023-01-11 14:50:10 +01008378 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8379 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8380 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8381 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008382 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8383 goto exit;
8384 }
8385
Gilles Peskine449bd832023-01-11 14:50:10 +01008386 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8387 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8388 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008389 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8390 goto exit;
8391 }
8392
Gilles Peskine449bd832023-01-11 14:50:10 +01008393 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8394 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8395 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8396 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008397 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8398 goto exit;
8399 }
8400
Gilles Peskine449bd832023-01-11 14:50:10 +01008401 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8402 buf, hash_len) != 0) {
8403 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8404 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8405 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008406 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8407 goto exit;
8408 }
8409
8410#if defined(MBEDTLS_SSL_RENEGOTIATION)
8411 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008412 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008413#endif
8414
Gilles Peskine449bd832023-01-11 14:50:10 +01008415 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008416#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008417 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008418 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008419 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008420#endif
8421#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008422 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008423 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008424 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008425#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008426 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008427 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008428 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008429
8430#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008431 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8432 mbedtls_ssl_recv_flight_completed(ssl);
8433 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008434#endif
8435
Gilles Peskine449bd832023-01-11 14:50:10 +01008436 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008437
8438exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008439 mbedtls_platform_zeroize(buf, hash_len);
8440 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008441}
8442
Jerry Yu392112c2022-02-17 14:34:10 +08008443#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8444/*
8445 * Helper to get TLS 1.2 PRF from ciphersuite
8446 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8447 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008448static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008449{
Jerry Yu392112c2022-02-17 14:34:10 +08008450 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008451 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01008452#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008453 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8454 return tls_prf_sha384;
8455 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008456#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01008457#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008458 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008459 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8460 return tls_prf_sha256;
8461 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008462 }
8463#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01008464#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01008465 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008466 (void) ciphersuite_info;
8467#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008468
Gilles Peskine449bd832023-01-11 14:50:10 +01008469 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008470}
8471#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008472
Gilles Peskine449bd832023-01-11 14:50:10 +01008473static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008474{
8475 ((void) tls_prf);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01008476#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008477 if (tls_prf == tls_prf_sha384) {
8478 return MBEDTLS_SSL_TLS_PRF_SHA384;
8479 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008480#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01008481#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008482 if (tls_prf == tls_prf_sha256) {
8483 return MBEDTLS_SSL_TLS_PRF_SHA256;
8484 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008485#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008486 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008487}
8488
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008489/*
8490 * Populate a transform structure with session keys and all the other
8491 * necessary information.
8492 *
8493 * Parameters:
8494 * - [in/out]: transform: structure to populate
8495 * [in] must be just initialised with mbedtls_ssl_transform_init()
8496 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8497 * - [in] ciphersuite
8498 * - [in] master
8499 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008500 * - [in] tls_prf: pointer to PRF to use for key derivation
8501 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008502 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008503 * - [in] endpoint: client or server
8504 * - [in] ssl: used for:
8505 * - ssl->conf->{f,p}_export_keys
8506 * [in] optionally used for:
8507 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8508 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008509MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008510static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8511 int ciphersuite,
8512 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008513#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008514 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008515#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008516 ssl_tls_prf_t tls_prf,
8517 const unsigned char randbytes[64],
8518 mbedtls_ssl_protocol_version tls_version,
8519 unsigned endpoint,
8520 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008521{
8522 int ret = 0;
8523 unsigned char keyblk[256];
8524 unsigned char *key1;
8525 unsigned char *key2;
8526 unsigned char *mac_enc;
8527 unsigned char *mac_dec;
8528 size_t mac_key_len = 0;
8529 size_t iv_copy_len;
8530 size_t keylen;
8531 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008532 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008533#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008534 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008535 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008536#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008537
8538#if defined(MBEDTLS_USE_PSA_CRYPTO)
8539 psa_key_type_t key_type;
8540 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8541 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008542 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008543 size_t key_bits;
8544 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8545#endif
8546
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008547 /*
8548 * Some data just needs copying into the structure
8549 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008550#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008551 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008552#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008553 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008554
8555#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008556 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008557#endif
8558
8559#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008560 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008561 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8562 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008563 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008564 }
8565#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8566
8567 /*
8568 * Get various info structures
8569 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008570 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8571 if (ciphersuite_info == NULL) {
8572 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8573 ciphersuite));
8574 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008575 }
8576
Neil Armstrongab555e02022-04-04 11:07:59 +02008577 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008578#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008579 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008580#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008581 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008582
Gilles Peskine449bd832023-01-11 14:50:10 +01008583 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008584 transform->taglen =
8585 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008586 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008587
8588#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008589 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008590 transform->taglen,
8591 &alg,
8592 &key_type,
8593 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008594 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008595 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008596 goto end;
8597 }
8598#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008599 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008600 if (cipher_info == NULL) {
8601 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8602 ciphersuite_info->cipher));
8603 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008604 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008605#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008606
Neil Armstronge4512952022-03-08 09:08:22 +01008607#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008608 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008609 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008610 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008611 (unsigned) ciphersuite_info->mac));
8612 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008613 }
8614#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008615 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008616 if (md_info == NULL) {
8617 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8618 (unsigned) ciphersuite_info->mac));
8619 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008620 }
Neil Armstronge4512952022-03-08 09:08:22 +01008621#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008622
8623#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8624 /* Copy own and peer's CID if the use of the CID
8625 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008626 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8627 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008628
8629 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008630 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8631 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8632 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008633
8634 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008635 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8636 ssl->handshake->peer_cid_len);
8637 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8638 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008639 }
8640#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8641
8642 /*
8643 * Compute key block using the PRF
8644 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008645 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8646 if (ret != 0) {
8647 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8648 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008649 }
8650
Gilles Peskine449bd832023-01-11 14:50:10 +01008651 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8652 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8653 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8654 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8655 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008656
8657 /*
8658 * Determine the appropriate key, IV and MAC length.
8659 */
8660
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008661#if defined(MBEDTLS_USE_PSA_CRYPTO)
8662 keylen = PSA_BITS_TO_BYTES(key_bits);
8663#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008664 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008665#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008666
Valerio Settie5707042023-10-11 11:54:42 +02008667#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008668 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008669 size_t explicit_ivlen;
8670
8671 transform->maclen = 0;
8672 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008673
8674 /* All modes haves 96-bit IVs, but the length of the static parts vary
8675 * with mode and version:
8676 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8677 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8678 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8679 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8680 * sequence number).
8681 */
8682 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008683
8684 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008685#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008686 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008687#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008688 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8689 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008690#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008691
Gilles Peskine449bd832023-01-11 14:50:10 +01008692 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008693 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008694 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008695 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008696 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008697
8698 /* Minimum length of encrypted record */
8699 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8700 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008701 } else
Valerio Settie5707042023-10-11 11:54:42 +02008702#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008703#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008704 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008705 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008706 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01008707#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008708 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008709#else
Dave Rodgman85a88132023-06-24 11:41:50 +01008710 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008711#endif /* MBEDTLS_USE_PSA_CRYPTO */
8712
8713#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01008714 /* Get MAC length */
8715 mac_key_len = PSA_HASH_LENGTH(mac_alg);
8716#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008717 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01008718 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
8719 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
8720 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008721 goto end;
8722 }
8723
8724 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008725 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01008726#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008727 transform->maclen = mac_key_len;
8728
8729 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008730#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008731 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008732#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01008733 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008734#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008735
8736 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01008737 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008738 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008739 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008740 /*
8741 * GenericBlockCipher:
8742 * 1. if EtM is in use: one block plus MAC
8743 * otherwise: * first multiple of blocklen greater than maclen
8744 * 2. IV
8745 */
8746#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008747 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008748 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008749 + block_size;
8750 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008751#endif
8752 {
8753 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01008754 + block_size
8755 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008756 }
8757
Gilles Peskine449bd832023-01-11 14:50:10 +01008758 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008759 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008760 } else {
8761 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008762 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8763 goto end;
8764 }
8765 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008766 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008767#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8768 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008769 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
8770 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008771 }
8772
Gilles Peskine449bd832023-01-11 14:50:10 +01008773 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
8774 (unsigned) keylen,
8775 (unsigned) transform->minlen,
8776 (unsigned) transform->ivlen,
8777 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008778
8779 /*
8780 * Finally setup the cipher contexts, IVs and MAC secrets.
8781 */
8782#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008783 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008784 key1 = keyblk + mac_key_len * 2;
8785 key2 = keyblk + mac_key_len * 2 + keylen;
8786
8787 mac_enc = keyblk;
8788 mac_dec = keyblk + mac_key_len;
8789
Gilles Peskine449bd832023-01-11 14:50:10 +01008790 iv_copy_len = (transform->fixed_ivlen) ?
8791 transform->fixed_ivlen : transform->ivlen;
8792 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
8793 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
8794 iv_copy_len);
8795 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008796#endif /* MBEDTLS_SSL_CLI_C */
8797#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008798 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008799 key1 = keyblk + mac_key_len * 2 + keylen;
8800 key2 = keyblk + mac_key_len * 2;
8801
8802 mac_enc = keyblk + mac_key_len;
8803 mac_dec = keyblk;
8804
Gilles Peskine449bd832023-01-11 14:50:10 +01008805 iv_copy_len = (transform->fixed_ivlen) ?
8806 transform->fixed_ivlen : transform->ivlen;
8807 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
8808 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
8809 iv_copy_len);
8810 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008811#endif /* MBEDTLS_SSL_SRV_C */
8812 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008813 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008814 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
8815 goto end;
8816 }
8817
Paul Elliott4fb19552023-10-18 12:15:30 +01008818 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008819 ssl->f_export_keys(ssl->p_export_keys,
8820 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
8821 master, 48,
8822 randbytes + 32,
8823 randbytes,
8824 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008825 }
8826
8827#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008828 transform->psa_alg = alg;
8829
Gilles Peskine449bd832023-01-11 14:50:10 +01008830 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
8831 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
8832 psa_set_key_algorithm(&attributes, alg);
8833 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008834
Gilles Peskine449bd832023-01-11 14:50:10 +01008835 if ((status = psa_import_key(&attributes,
8836 key1,
8837 PSA_BITS_TO_BYTES(key_bits),
8838 &transform->psa_key_enc)) != PSA_SUCCESS) {
8839 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008840 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008841 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008842 goto end;
8843 }
8844
Gilles Peskine449bd832023-01-11 14:50:10 +01008845 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008846
Gilles Peskine449bd832023-01-11 14:50:10 +01008847 if ((status = psa_import_key(&attributes,
8848 key2,
8849 PSA_BITS_TO_BYTES(key_bits),
8850 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008851 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008852 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008853 goto end;
8854 }
8855 }
8856#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008857 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
8858 cipher_info)) != 0) {
8859 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008860 goto end;
8861 }
8862
Gilles Peskine449bd832023-01-11 14:50:10 +01008863 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
8864 cipher_info)) != 0) {
8865 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008866 goto end;
8867 }
8868
Gilles Peskine449bd832023-01-11 14:50:10 +01008869 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
8870 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8871 MBEDTLS_ENCRYPT)) != 0) {
8872 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008873 goto end;
8874 }
8875
Gilles Peskine449bd832023-01-11 14:50:10 +01008876 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
8877 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
8878 MBEDTLS_DECRYPT)) != 0) {
8879 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008880 goto end;
8881 }
8882
8883#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008884 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
8885 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
8886 MBEDTLS_PADDING_NONE)) != 0) {
8887 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008888 goto end;
8889 }
8890
Gilles Peskine449bd832023-01-11 14:50:10 +01008891 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
8892 MBEDTLS_PADDING_NONE)) != 0) {
8893 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008894 goto end;
8895 }
8896 }
8897#endif /* MBEDTLS_CIPHER_MODE_CBC */
8898#endif /* MBEDTLS_USE_PSA_CRYPTO */
8899
Neil Armstrong29c0c042022-03-17 17:47:28 +01008900#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
8901 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
8902 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008903 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008904#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008905 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008906
Gilles Peskine449bd832023-01-11 14:50:10 +01008907 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
8908 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
8909 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008910
Gilles Peskine449bd832023-01-11 14:50:10 +01008911 if ((status = psa_import_key(&attributes,
8912 mac_enc, mac_key_len,
8913 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008914 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008915 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008916 goto end;
8917 }
8918
Gilles Peskine449bd832023-01-11 14:50:10 +01008919 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
8920 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008921#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008922 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04008923#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008924 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008925 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01008926 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
8927 PSA_KEY_USAGE_VERIFY_HASH);
8928 } else {
8929 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
8930 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008931
Gilles Peskine449bd832023-01-11 14:50:10 +01008932 if ((status = psa_import_key(&attributes,
8933 mac_dec, mac_key_len,
8934 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008935 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008936 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01008937 goto end;
8938 }
8939#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008940 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
8941 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008942 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008943 }
8944 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
8945 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01008946 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01008947 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01008948#endif /* MBEDTLS_USE_PSA_CRYPTO */
8949 }
8950#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
8951
8952 ((void) mac_dec);
8953 ((void) mac_enc);
8954
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008955end:
Gilles Peskine449bd832023-01-11 14:50:10 +01008956 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
8957 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008958}
8959
Valerio Settia08b1a42022-11-17 15:10:02 +01008960#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
8961 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01008962int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01008963 psa_pake_operation_t *pake_ctx,
8964 const unsigned char *buf,
8965 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01008966{
8967 psa_status_t status;
8968 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01008969 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01008970 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
8971 * At round two perform a single cycle
8972 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008973 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01008974
Gilles Peskine449bd832023-01-11 14:50:10 +01008975 for (; remaining_steps > 0; remaining_steps--) {
8976 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01008977 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01008978 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008979 /* Length is stored at the first byte */
8980 size_t length = buf[input_offset];
8981 input_offset += 1;
8982
Gilles Peskine449bd832023-01-11 14:50:10 +01008983 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01008984 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8985 }
8986
Gilles Peskine449bd832023-01-11 14:50:10 +01008987 status = psa_pake_input(pake_ctx, step,
8988 buf + input_offset, length);
8989 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008990 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01008991 }
8992
8993 input_offset += length;
8994 }
8995 }
8996
Gilles Peskine449bd832023-01-11 14:50:10 +01008997 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01008998 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008999 }
Valerio Setti30ebe112022-11-17 16:23:34 +01009000
Gilles Peskine449bd832023-01-11 14:50:10 +01009001 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009002}
9003
Valerio Setti6b3dab02022-11-17 17:14:54 +01009004int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009005 psa_pake_operation_t *pake_ctx,
9006 unsigned char *buf,
9007 size_t len, size_t *olen,
9008 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009009{
9010 psa_status_t status;
9011 size_t output_offset = 0;
9012 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01009013 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009014 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9015 * At round two perform a single cycle
9016 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009017 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009018
Gilles Peskine449bd832023-01-11 14:50:10 +01009019 for (; remaining_steps > 0; remaining_steps--) {
9020 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
9021 step <= PSA_PAKE_STEP_ZK_PROOF;
9022 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009023 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01009024 * For each step, prepend 1 byte with the length of the data as
9025 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009026 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009027 status = psa_pake_output(pake_ctx, step,
9028 buf + output_offset + 1,
9029 len - output_offset - 1,
9030 &output_len);
9031 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009032 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009033 }
9034
Valerio Setti99d88c12022-11-22 16:03:43 +01009035 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009036
9037 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009038 }
9039 }
9040
9041 *olen = output_offset;
9042
Gilles Peskine449bd832023-01-11 14:50:10 +01009043 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009044}
Valerio Settia08b1a42022-11-17 15:10:02 +01009045#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
9046
Jerry Yuee40f9d2022-02-17 14:55:16 +08009047#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009048int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9049 unsigned char *hash, size_t *hashlen,
9050 unsigned char *data, size_t data_len,
9051 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009052{
9053 psa_status_t status;
9054 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02009055 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009056
Gilles Peskine449bd832023-01-11 14:50:10 +01009057 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009058
Gilles Peskine449bd832023-01-11 14:50:10 +01009059 if ((status = psa_hash_setup(&hash_operation,
9060 hash_alg)) != PSA_SUCCESS) {
9061 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009062 goto exit;
9063 }
9064
Gilles Peskine449bd832023-01-11 14:50:10 +01009065 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
9066 64)) != PSA_SUCCESS) {
9067 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009068 goto exit;
9069 }
9070
Gilles Peskine449bd832023-01-11 14:50:10 +01009071 if ((status = psa_hash_update(&hash_operation,
9072 data, data_len)) != PSA_SUCCESS) {
9073 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009074 goto exit;
9075 }
9076
Gilles Peskine449bd832023-01-11 14:50:10 +01009077 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
9078 hashlen)) != PSA_SUCCESS) {
9079 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
9080 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009081 }
9082
9083exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009084 if (status != PSA_SUCCESS) {
9085 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9086 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9087 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08009088 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01009089 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009090 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
9091 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01009092 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009093 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01009094 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009095 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01009096 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009097 }
9098 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009099 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009100}
9101
9102#else
9103
Gilles Peskine449bd832023-01-11 14:50:10 +01009104int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9105 unsigned char *hash, size_t *hashlen,
9106 unsigned char *data, size_t data_len,
9107 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009108{
9109 int ret = 0;
9110 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01009111 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
9112 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009113
Gilles Peskine449bd832023-01-11 14:50:10 +01009114 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009115
Gilles Peskine449bd832023-01-11 14:50:10 +01009116 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009117
9118 /*
9119 * digitally-signed struct {
9120 * opaque client_random[32];
9121 * opaque server_random[32];
9122 * ServerDHParams params;
9123 * };
9124 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009125 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
9126 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009127 goto exit;
9128 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009129 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
9130 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009131 goto exit;
9132 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009133 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
9134 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009135 goto exit;
9136 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009137 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
9138 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009139 goto exit;
9140 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009141 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
9142 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009143 goto exit;
9144 }
9145
9146exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009147 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009148
Gilles Peskine449bd832023-01-11 14:50:10 +01009149 if (ret != 0) {
9150 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9151 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9152 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08009153
Gilles Peskine449bd832023-01-11 14:50:10 +01009154 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009155}
9156#endif /* MBEDTLS_USE_PSA_CRYPTO */
9157
Jerry Yud9d91da2022-02-17 14:57:06 +08009158#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
9159
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009160/* Find the preferred hash for a given signature algorithm. */
9161unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01009162 mbedtls_ssl_context *ssl,
9163 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08009164{
Gabor Mezei078e8032022-04-27 21:17:56 +02009165 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009166 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02009167
Gilles Peskine449bd832023-01-11 14:50:10 +01009168 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
9169 return MBEDTLS_SSL_HASH_NONE;
9170 }
Gabor Mezei078e8032022-04-27 21:17:56 +02009171
Gilles Peskine449bd832023-01-11 14:50:10 +01009172 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009173 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009174 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
9175 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009176 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009177 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
9178 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009179
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009180 mbedtls_md_type_t md_alg =
9181 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
9182 if (md_alg == MBEDTLS_MD_NONE) {
9183 continue;
9184 }
9185
Gilles Peskine449bd832023-01-11 14:50:10 +01009186 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009187#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009188 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02009189 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009190 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009191
Gilles Peskine449bd832023-01-11 14:50:10 +01009192 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
9193 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9194 PSA_ALG_ECDSA(psa_hash_alg),
9195 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009196 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009197 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009198
Gilles Peskine449bd832023-01-11 14:50:10 +01009199 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
9200 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9201 PSA_ALG_RSA_PKCS1V15_SIGN(
9202 psa_hash_alg),
9203 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009204 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009205 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009206 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009207#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02009208
Gilles Peskine449bd832023-01-11 14:50:10 +01009209 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009210 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009211 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009212
Gilles Peskine449bd832023-01-11 14:50:10 +01009213 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08009214}
9215
9216#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
9217
Jerry Yudc7bd172022-02-17 13:44:15 +08009218#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9219
XiaokangQian75d40ef2022-04-20 11:05:24 +00009220int mbedtls_ssl_validate_ciphersuite(
9221 const mbedtls_ssl_context *ssl,
9222 const mbedtls_ssl_ciphersuite_t *suite_info,
9223 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009224 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009225{
9226 (void) ssl;
9227
Gilles Peskine449bd832023-01-11 14:50:10 +01009228 if (suite_info == NULL) {
9229 return -1;
9230 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009231
Gilles Peskine449bd832023-01-11 14:50:10 +01009232 if ((suite_info->min_tls_version > max_tls_version) ||
9233 (suite_info->max_tls_version < min_tls_version)) {
9234 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009235 }
9236
XiaokangQian060d8672022-04-21 09:24:56 +00009237#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009238#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009239#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009240 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9241 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009242#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009243 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9244 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009245#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009246 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009247 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009248 }
9249#endif
9250
9251 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9252#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009253 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9254 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9255 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009256 }
9257#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9258#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9259
Gilles Peskine449bd832023-01-11 14:50:10 +01009260 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009261}
9262
Ronald Crone68ab4f2022-10-05 12:46:29 +02009263#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009264/*
9265 * Function for writing a signature algorithm extension.
9266 *
9267 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9268 * value (TLS 1.3 RFC8446):
9269 * enum {
9270 * ....
9271 * ecdsa_secp256r1_sha256( 0x0403 ),
9272 * ecdsa_secp384r1_sha384( 0x0503 ),
9273 * ecdsa_secp521r1_sha512( 0x0603 ),
9274 * ....
9275 * } SignatureScheme;
9276 *
9277 * struct {
9278 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9279 * } SignatureSchemeList;
9280 *
9281 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9282 * value (TLS 1.2 RFC5246):
9283 * enum {
9284 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9285 * sha512(6), (255)
9286 * } HashAlgorithm;
9287 *
9288 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9289 * SignatureAlgorithm;
9290 *
9291 * struct {
9292 * HashAlgorithm hash;
9293 * SignatureAlgorithm signature;
9294 * } SignatureAndHashAlgorithm;
9295 *
9296 * SignatureAndHashAlgorithm
9297 * supported_signature_algorithms<2..2^16-2>;
9298 *
9299 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9300 * generalization of the TLS 1.2 signature algorithm extension.
9301 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9302 * `SignatureScheme` field of TLS 1.3
9303 *
9304 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009305int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9306 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009307{
9308 unsigned char *p = buf;
9309 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9310 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9311
9312 *out_len = 0;
9313
Gilles Peskine449bd832023-01-11 14:50:10 +01009314 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009315
9316 /* Check if we have space for header and length field:
9317 * - extension_type (2 bytes)
9318 * - extension_data_length (2 bytes)
9319 * - supported_signature_algorithms_length (2 bytes)
9320 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009321 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009322 p += 6;
9323
9324 /*
9325 * Write supported_signature_algorithms
9326 */
9327 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009328 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9329 if (sig_alg == NULL) {
9330 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9331 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009332
Gilles Peskine449bd832023-01-11 14:50:10 +01009333 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9334 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9335 *sig_alg,
9336 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9337 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009338 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009339 }
9340 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9341 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009342 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009343 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9344 *sig_alg,
9345 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009346 }
9347
9348 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009349 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009350 if (supported_sig_alg_len == 0) {
9351 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9352 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009353 }
9354
Gilles Peskine449bd832023-01-11 14:50:10 +01009355 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9356 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9357 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009358
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009359 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009360
9361#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009362 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009363#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009364
Gilles Peskine449bd832023-01-11 14:50:10 +01009365 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009366}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009367#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009368
XiaokangQian40a35232022-05-07 09:02:40 +00009369#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009370/*
9371 * mbedtls_ssl_parse_server_name_ext
9372 *
9373 * Structure of server_name extension:
9374 *
9375 * enum {
9376 * host_name(0), (255)
9377 * } NameType;
9378 * opaque HostName<1..2^16-1>;
9379 *
9380 * struct {
9381 * NameType name_type;
9382 * select (name_type) {
9383 * case host_name: HostName;
9384 * } name;
9385 * } ServerName;
9386 * struct {
9387 * ServerName server_name_list<1..2^16-1>
9388 * } ServerNameList;
9389 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009390MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009391int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9392 const unsigned char *buf,
9393 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009394{
9395 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9396 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009397 size_t server_name_list_len, hostname_len;
9398 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009399
Gilles Peskine449bd832023-01-11 14:50:10 +01009400 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009401
Gilles Peskine449bd832023-01-11 14:50:10 +01009402 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9403 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009404 p += 2;
9405
Gilles Peskine449bd832023-01-11 14:50:10 +01009406 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009407 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009408 while (p < server_name_list_end) {
9409 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9410 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9411 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9412 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009413
Gilles Peskine449bd832023-01-11 14:50:10 +01009414 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009415 /* sni_name is intended to be used only during the parsing of the
9416 * ClientHello message (it is reset to NULL before the end of
9417 * the message parsing). Thus it is ok to just point to the
9418 * reception buffer and not make a copy of it.
9419 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009420 ssl->handshake->sni_name = p + 3;
9421 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009422 if (ssl->conf->f_sni == NULL) {
9423 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009424 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009425 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9426 ssl, p + 3, hostname_len);
9427 if (ret != 0) {
9428 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9429 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9430 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9431 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9432 }
9433 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009434 }
9435
9436 p += hostname_len + 3;
9437 }
9438
Gilles Peskine449bd832023-01-11 14:50:10 +01009439 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009440}
9441#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9442
XiaokangQianacb39922022-06-17 10:18:48 +00009443#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009444MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009445int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9446 const unsigned char *buf,
9447 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009448{
9449 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009450 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009451 const unsigned char *protocol_name_list;
9452 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009453 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009454
9455 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009456 if (ssl->conf->alpn_list == NULL) {
9457 return 0;
9458 }
XiaokangQianacb39922022-06-17 10:18:48 +00009459
9460 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009461 * RFC7301, section 3.1
9462 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009463 *
XiaokangQianc7403452022-06-23 03:24:12 +00009464 * struct {
9465 * ProtocolName protocol_name_list<2..2^16-1>
9466 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009467 */
9468
XiaokangQianc7403452022-06-23 03:24:12 +00009469 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009470 * protocol_name_list_len 2 bytes
9471 * protocol_name_len 1 bytes
9472 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009473 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009474 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009475
Gilles Peskine449bd832023-01-11 14:50:10 +01009476 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009477 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009478 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009479 protocol_name_list = p;
9480 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009481
9482 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009483 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009484 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009485 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9486 protocol_name_len);
9487 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009488 MBEDTLS_SSL_PEND_FATAL_ALERT(
9489 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009490 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9491 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009492 }
9493
9494 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009495 }
9496
9497 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009498 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9499 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009500 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009501 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009502 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009503 if (protocol_name_len == alpn_len &&
9504 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009505 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009506 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009507 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009508
9509 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009510 }
9511 }
9512
XiaokangQian95d5f542022-06-24 02:29:26 +00009513 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009514 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009515 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9516 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9517 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009518}
9519
Gilles Peskine449bd832023-01-11 14:50:10 +01009520int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9521 unsigned char *buf,
9522 unsigned char *end,
9523 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009524{
9525 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009526 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009527 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009528
Gilles Peskine449bd832023-01-11 14:50:10 +01009529 if (ssl->alpn_chosen == NULL) {
9530 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009531 }
9532
Gilles Peskine449bd832023-01-11 14:50:10 +01009533 protocol_name_len = strlen(ssl->alpn_chosen);
9534 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009535
Gilles Peskine449bd832023-01-11 14:50:10 +01009536 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009537 /*
9538 * 0 . 1 ext identifier
9539 * 2 . 3 ext length
9540 * 4 . 5 protocol list length
9541 * 6 . 6 protocol name length
9542 * 7 . 7+n protocol name
9543 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009544 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009545
XiaokangQian95d5f542022-06-24 02:29:26 +00009546 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009547
Gilles Peskine449bd832023-01-11 14:50:10 +01009548 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9549 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009550 /* Note: the length of the chosen protocol has been checked to be less
9551 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9552 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009553 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009554
Gilles Peskine449bd832023-01-11 14:50:10 +01009555 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009556
9557#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009558 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009559#endif
9560
Gilles Peskine449bd832023-01-11 14:50:10 +01009561 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009562}
9563#endif /* MBEDTLS_SSL_ALPN */
9564
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009565#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009566 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009567 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009568 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009569int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9570 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009571{
9572 /* Initialize to suppress unnecessary compiler warning */
9573 size_t hostname_len = 0;
9574
9575 /* Check if new hostname is valid before
9576 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009577 if (hostname != NULL) {
9578 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009579
Gilles Peskine449bd832023-01-11 14:50:10 +01009580 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9581 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9582 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009583 }
9584
9585 /* Now it's clear that we will overwrite the old hostname,
9586 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009587 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009588 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009589 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009590 }
9591
9592 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009593 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009594 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009595 } else {
9596 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9597 if (session->hostname == NULL) {
9598 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9599 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009600
Gilles Peskine449bd832023-01-11 14:50:10 +01009601 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009602 }
9603
Gilles Peskine449bd832023-01-11 14:50:10 +01009604 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009605}
Xiaokang Qian03409292022-10-12 02:49:52 +00009606#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9607 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009608 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009609 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009610
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009611#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
9612 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009613int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
9614 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009615{
9616 size_t alpn_len = 0;
9617
9618 if (alpn != NULL) {
9619 alpn_len = strlen(alpn);
9620
9621 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
9622 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9623 }
9624 }
9625
9626 if (session->ticket_alpn != NULL) {
9627 mbedtls_zeroize_and_free(session->ticket_alpn,
9628 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009629 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009630 }
9631
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009632 if (alpn != NULL) {
9633 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009634 if (session->ticket_alpn == NULL) {
9635 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9636 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009637 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009638 }
9639
9640 return 0;
9641}
9642#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02009643
9644/*
9645 * The following functions are used by 1.2 and 1.3, client and server.
9646 */
9647#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
9648int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
9649 const mbedtls_ssl_ciphersuite_t *ciphersuite,
9650 int recv_endpoint,
9651 mbedtls_ssl_protocol_version tls_version,
9652 uint32_t *flags)
9653{
9654 int ret = 0;
9655 unsigned int usage = 0;
9656 const char *ext_oid;
9657 size_t ext_len;
9658
9659 /*
9660 * keyUsage
9661 */
9662
9663 /* Note: don't guard this with MBEDTLS_SSL_CLI_C because the server wants
9664 * to check what a compliant client will think while choosing which cert
9665 * to send to the client. */
9666#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
9667 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
9668 recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
9669 /* TLS 1.2 server part of the key exchange */
9670 switch (ciphersuite->key_exchange) {
9671 case MBEDTLS_KEY_EXCHANGE_RSA:
Manuel Pégourié-Gonnard5398e582024-08-20 12:14:43 +02009672 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
9673 break;
9674
9675 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
9676 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
9677 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
9678 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
9679 break;
9680
9681 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
9682 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
9683 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
9684 break;
9685
9686 /* Don't use default: we want warnings when adding new values */
9687 case MBEDTLS_KEY_EXCHANGE_NONE:
9688 case MBEDTLS_KEY_EXCHANGE_PSK:
9689 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
9690 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
9691 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
9692 usage = 0;
9693 }
9694 } else
9695#endif
9696 {
9697 /* This is either TLS 1.3 authentication, which always uses signatures,
9698 * or 1.2 client auth: rsa_sign and mbedtls_ecdsa_sign are the only
9699 * options we implement, both using signatures. */
9700 (void) tls_version;
9701 (void) ciphersuite;
9702 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
9703 }
9704
9705 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
9706 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
9707 ret = -1;
9708 }
9709
9710 /*
9711 * extKeyUsage
9712 */
9713
9714 if (recv_endpoint == MBEDTLS_SSL_IS_CLIENT) {
9715 ext_oid = MBEDTLS_OID_SERVER_AUTH;
9716 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
9717 } else {
9718 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
9719 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
9720 }
9721
9722 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
9723 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
9724 ret = -1;
9725 }
9726
9727 return ret;
9728}
9729
9730int mbedtls_ssl_verify_certificate(mbedtls_ssl_context *ssl,
9731 int authmode,
9732 mbedtls_x509_crt *chain,
9733 const mbedtls_ssl_ciphersuite_t *ciphersuite_info,
9734 void *rs_ctx)
9735{
9736 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
9737 return 0;
9738 }
9739
9740 /*
9741 * Primary check: use the appropriate X.509 verification function
9742 */
9743 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
9744 void *p_vrfy;
9745 if (ssl->f_vrfy != NULL) {
9746 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
9747 f_vrfy = ssl->f_vrfy;
9748 p_vrfy = ssl->p_vrfy;
9749 } else {
9750 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
9751 f_vrfy = ssl->conf->f_vrfy;
9752 p_vrfy = ssl->conf->p_vrfy;
9753 }
9754
9755 int ret = 0;
9756 int have_ca_chain_or_callback = 0;
9757#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
9758 if (ssl->conf->f_ca_cb != NULL) {
9759 ((void) rs_ctx);
9760 have_ca_chain_or_callback = 1;
9761
9762 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
9763 ret = mbedtls_x509_crt_verify_with_ca_cb(
9764 chain,
9765 ssl->conf->f_ca_cb,
9766 ssl->conf->p_ca_cb,
9767 ssl->conf->cert_profile,
9768 ssl->hostname,
9769 &ssl->session_negotiate->verify_result,
9770 f_vrfy, p_vrfy);
9771 } else
9772#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
9773 {
9774 mbedtls_x509_crt *ca_chain;
9775 mbedtls_x509_crl *ca_crl;
9776#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
9777 if (ssl->handshake->sni_ca_chain != NULL) {
9778 ca_chain = ssl->handshake->sni_ca_chain;
9779 ca_crl = ssl->handshake->sni_ca_crl;
9780 } else
9781#endif
9782 {
9783 ca_chain = ssl->conf->ca_chain;
9784 ca_crl = ssl->conf->ca_crl;
9785 }
9786
9787 if (ca_chain != NULL) {
9788 have_ca_chain_or_callback = 1;
9789 }
9790
9791 ret = mbedtls_x509_crt_verify_restartable(
9792 chain,
9793 ca_chain, ca_crl,
9794 ssl->conf->cert_profile,
9795 ssl->hostname,
9796 &ssl->session_negotiate->verify_result,
9797 f_vrfy, p_vrfy, rs_ctx);
9798 }
9799
9800 if (ret != 0) {
9801 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
9802 }
9803
9804#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
9805 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
9806 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
9807 }
9808#endif
9809
9810 /*
9811 * Secondary checks: always done, but change 'ret' only if it was 0
9812 */
9813
9814 /* With TLS 1.2 and ECC certs, check that the curve used by the
9815 * certificate is on our list of acceptable curves.
9816 *
9817 * With TLS 1.3 this is not needed because the curve is part of the
9818 * signature algorithm (eg ecdsa_secp256r1_sha256) which is checked when
9819 * we validate the signature made with the key associated to this cert.
9820 */
9821#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
9822 defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
9823 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
9824 mbedtls_pk_can_do(&chain->pk, MBEDTLS_PK_ECKEY)) {
9825 if (mbedtls_ssl_check_curve(ssl, mbedtls_pk_get_ec_group_id(&chain->pk)) != 0) {
9826 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
9827 ssl->session_negotiate->verify_result |= MBEDTLS_X509_BADCERT_BAD_KEY;
9828 if (ret == 0) {
9829 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
9830 }
9831 }
9832 }
9833#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
9834
9835 /* Check X.509 usage extensions (keyUsage, extKeyUsage) */
9836 if (mbedtls_ssl_check_cert_usage(chain,
9837 ciphersuite_info,
9838 ssl->conf->endpoint,
9839 ssl->tls_version,
9840 &ssl->session_negotiate->verify_result) != 0) {
9841 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
9842 if (ret == 0) {
9843 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
9844 }
9845 }
9846
9847 /* With authmode optional, we want to keep going if the certificate was
9848 * unacceptable, but still fail on other errors (out of memory etc),
9849 * including fatal errors from the f_vrfy callback.
9850 *
9851 * The only acceptable errors are:
9852 * - MBEDTLS_ERR_X509_CERT_VERIFY_FAILED: cert rejected by primary check;
9853 * - MBEDTLS_ERR_SSL_BAD_CERTIFICATE: cert rejected by secondary checks.
9854 * Anything else is a fatal error. */
9855 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
9856 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
9857 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
9858 ret = 0;
9859 }
9860
9861 /* Return a specific error as this is a user error: inconsistent
9862 * configuration - can't verify without trust anchors. */
9863 if (have_ca_chain_or_callback == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
9864 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
9865 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
9866 }
9867
9868 if (ret != 0) {
9869 uint8_t alert;
9870
9871 /* The certificate may have been rejected for several reasons.
9872 Pick one and send the corresponding alert. Which alert to send
9873 may be a subject of debate in some cases. */
9874 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
9875 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
9876 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
9877 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
9878 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
9879 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9880 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
9881 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9882 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
9883 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9884 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
9885 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
9886 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
9887 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
9888 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
9889 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
9890 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
9891 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
9892 } else {
9893 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
9894 }
9895 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9896 alert);
9897 }
9898
9899#if defined(MBEDTLS_DEBUG_C)
9900 if (ssl->session_negotiate->verify_result != 0) {
9901 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
9902 (unsigned int) ssl->session_negotiate->verify_result));
9903 } else {
9904 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
9905 }
9906#endif /* MBEDTLS_DEBUG_C */
9907
9908 return ret;
9909}
9910#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
9911
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009912#endif /* MBEDTLS_SSL_TLS_C */