blob: 794adddc9f3c8be86f2ec80f7b646c6d6d16b4b5 [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
Gilles Peskinedb09ef62020-06-03 01:43:33 +020012#include "common.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"
Chris Jones84a773f2021-03-05 18:38:47 +000021#include "ssl_misc.h"
Andrzej Kurek25f27152022-08-17 16:09:31 -040022
Valerio Settib4f50762024-01-17 10:24:52 +010023#include "debug_internal.h"
Janos Follath73c616b2019-12-18 15:07:04 +000024#include "mbedtls/error.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050025#include "mbedtls/platform_util.h"
Hanno Beckera835da52019-05-16 12:39:07 +010026#include "mbedtls/version.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020027#include "mbedtls/constant_time.h"
Paul Bakker0be444a2013-08-27 21:55:01 +020028
Rich Evans00ab4702015-02-06 13:43:58 +000029#include <string.h>
30
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050031#if defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti384fbde2024-01-02 13:26:40 +010032#include "mbedtls/psa_util.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020033#include "md_psa.h"
Manuel Pégourié-Gonnard2be8c632023-06-07 13:07:21 +020034#include "psa_util_internal.h"
Andrzej Kurekd6db9be2019-01-10 05:27:10 -050035#include "psa/crypto.h"
36#endif
37
Janos Follath23bdca02016-10-07 14:47:14 +010038#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000039#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +020040#endif
41
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050042#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek00644842023-05-30 05:45:00 -040043/* Define local translating functions to save code size by not using too many
44 * arguments in each translating place. */
45static int local_err_translation(psa_status_t status)
46{
47 return psa_status_to_mbedtls(status, psa_to_ssl_errors,
Andrzej Kurek1e4a0302023-05-30 09:45:17 -040048 ARRAY_LENGTH(psa_to_ssl_errors),
Andrzej Kurek00644842023-05-30 05:45:00 -040049 psa_generic_status_to_mbedtls);
50}
51#define PSA_TO_MBEDTLS_ERR(status) local_err_translation(status)
Andrzej Kurek8a045ce2022-12-23 11:00:06 -050052#endif
53
Ronald Cronad8c17b2022-06-10 17:18:09 +020054#if defined(MBEDTLS_TEST_HOOKS)
55static mbedtls_ssl_chk_buf_ptr_args chk_buf_ptr_fail_args;
56
57void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +010058 const uint8_t *cur, const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +020059{
60 chk_buf_ptr_fail_args.cur = cur;
61 chk_buf_ptr_fail_args.end = end;
62 chk_buf_ptr_fail_args.need = need;
63}
64
Gilles Peskine449bd832023-01-11 14:50:10 +010065void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void)
Ronald Cronad8c17b2022-06-10 17:18:09 +020066{
Gilles Peskine449bd832023-01-11 14:50:10 +010067 memset(&chk_buf_ptr_fail_args, 0, sizeof(chk_buf_ptr_fail_args));
Ronald Cronad8c17b2022-06-10 17:18:09 +020068}
69
Gilles Peskine449bd832023-01-11 14:50:10 +010070int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args)
Ronald Cronad8c17b2022-06-10 17:18:09 +020071{
Gilles Peskine449bd832023-01-11 14:50:10 +010072 return (chk_buf_ptr_fail_args.cur != args->cur) ||
73 (chk_buf_ptr_fail_args.end != args->end) ||
74 (chk_buf_ptr_fail_args.need != args->need);
Ronald Cronad8c17b2022-06-10 17:18:09 +020075}
76#endif /* MBEDTLS_TEST_HOOKS */
77
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +020078#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker2b1e3542018-08-06 11:19:13 +010079
Hanno Beckera0e20d02019-05-15 14:03:01 +010080#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf8542cf2019-04-09 15:22:03 +010081/* Top-level Connection ID API */
82
Gilles Peskine449bd832023-01-11 14:50:10 +010083int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf,
84 size_t len,
85 int ignore_other_cid)
Hanno Beckerad4a1372019-05-03 13:06:44 +010086{
Gilles Peskine449bd832023-01-11 14:50:10 +010087 if (len > MBEDTLS_SSL_CID_IN_LEN_MAX) {
88 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
89 }
Hanno Beckerad4a1372019-05-03 13:06:44 +010090
Gilles Peskine449bd832023-01-11 14:50:10 +010091 if (ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_FAIL &&
92 ignore_other_cid != MBEDTLS_SSL_UNEXPECTED_CID_IGNORE) {
93 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker611ac772019-05-14 11:45:26 +010094 }
95
96 conf->ignore_unexpected_cid = ignore_other_cid;
Hanno Beckerad4a1372019-05-03 13:06:44 +010097 conf->cid_len = len;
Gilles Peskine449bd832023-01-11 14:50:10 +010098 return 0;
Hanno Beckerad4a1372019-05-03 13:06:44 +010099}
100
Gilles Peskine449bd832023-01-11 14:50:10 +0100101int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
102 int enable,
103 unsigned char const *own_cid,
104 size_t own_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100105{
Gilles Peskine449bd832023-01-11 14:50:10 +0100106 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
107 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
108 }
Hanno Becker76a79ab2019-05-03 14:38:32 +0100109
Hanno Beckerca092242019-04-25 16:01:49 +0100110 ssl->negotiate_cid = enable;
Gilles Peskine449bd832023-01-11 14:50:10 +0100111 if (enable == MBEDTLS_SSL_CID_DISABLED) {
112 MBEDTLS_SSL_DEBUG_MSG(3, ("Disable use of CID extension."));
113 return 0;
Hanno Beckerca092242019-04-25 16:01:49 +0100114 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100115 MBEDTLS_SSL_DEBUG_MSG(3, ("Enable use of CID extension."));
116 MBEDTLS_SSL_DEBUG_BUF(3, "Own CID", own_cid, own_cid_len);
Hanno Beckerca092242019-04-25 16:01:49 +0100117
Gilles Peskine449bd832023-01-11 14:50:10 +0100118 if (own_cid_len != ssl->conf->cid_len) {
119 MBEDTLS_SSL_DEBUG_MSG(3, ("CID length %u does not match CID length %u in config",
120 (unsigned) own_cid_len,
121 (unsigned) ssl->conf->cid_len));
122 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerca092242019-04-25 16:01:49 +0100123 }
124
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 memcpy(ssl->own_cid, own_cid, own_cid_len);
Hanno Beckerb7ee0cf2019-04-30 14:07:31 +0100126 /* Truncation is not an issue here because
127 * MBEDTLS_SSL_CID_IN_LEN_MAX at most 255. */
128 ssl->own_cid_len = (uint8_t) own_cid_len;
Hanno Beckerca092242019-04-25 16:01:49 +0100129
Gilles Peskine449bd832023-01-11 14:50:10 +0100130 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100131}
132
Gilles Peskine449bd832023-01-11 14:50:10 +0100133int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
134 int *enabled,
Sam Berry3504c882024-06-11 14:34:17 +0100135 unsigned char own_cid[MBEDTLS_SSL_CID_IN_LEN_MAX],
Gilles Peskine449bd832023-01-11 14:50:10 +0100136 size_t *own_cid_len)
Paul Elliott0113cf12022-03-11 20:26:47 +0000137{
138 *enabled = MBEDTLS_SSL_CID_DISABLED;
139
Gilles Peskine449bd832023-01-11 14:50:10 +0100140 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
141 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
142 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000143
144 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID length is
145 * zero as this is indistinguishable from not requesting to use
146 * the CID extension. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 if (ssl->own_cid_len == 0 || ssl->negotiate_cid == MBEDTLS_SSL_CID_DISABLED) {
148 return 0;
149 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000150
Gilles Peskine449bd832023-01-11 14:50:10 +0100151 if (own_cid_len != NULL) {
Paul Elliott0113cf12022-03-11 20:26:47 +0000152 *own_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100153 if (own_cid != NULL) {
154 memcpy(own_cid, ssl->own_cid, ssl->own_cid_len);
155 }
Paul Elliott0113cf12022-03-11 20:26:47 +0000156 }
157
158 *enabled = MBEDTLS_SSL_CID_ENABLED;
159
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 return 0;
Paul Elliott0113cf12022-03-11 20:26:47 +0000161}
162
Gilles Peskine449bd832023-01-11 14:50:10 +0100163int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
164 int *enabled,
165 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
166 size_t *peer_cid_len)
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100167{
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100168 *enabled = MBEDTLS_SSL_CID_DISABLED;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100169
Gilles Peskine449bd832023-01-11 14:50:10 +0100170 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
171 mbedtls_ssl_is_handshake_over(ssl) == 0) {
172 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker76a79ab2019-05-03 14:38:32 +0100173 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100174
Hanno Beckerc5f24222019-05-03 12:54:52 +0100175 /* We report MBEDTLS_SSL_CID_DISABLED in case the CID extensions
176 * were used, but client and server requested the empty CID.
177 * This is indistinguishable from not using the CID extension
178 * in the first place. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100179 if (ssl->transform_in->in_cid_len == 0 &&
180 ssl->transform_in->out_cid_len == 0) {
181 return 0;
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100182 }
183
Gilles Peskine449bd832023-01-11 14:50:10 +0100184 if (peer_cid_len != NULL) {
Hanno Becker615ef172019-05-22 16:50:35 +0100185 *peer_cid_len = ssl->transform_in->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100186 if (peer_cid != NULL) {
187 memcpy(peer_cid, ssl->transform_in->out_cid,
188 ssl->transform_in->out_cid_len);
Hanno Becker615ef172019-05-22 16:50:35 +0100189 }
190 }
Hanno Beckerb1f89cd2019-04-26 17:08:02 +0100191
192 *enabled = MBEDTLS_SSL_CID_ENABLED;
193
Gilles Peskine449bd832023-01-11 14:50:10 +0100194 return 0;
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100195}
Hanno Beckera0e20d02019-05-15 14:03:01 +0100196#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerf8542cf2019-04-09 15:22:03 +0100197
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200198#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200199
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200200#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200201/*
202 * Convert max_fragment_length codes to length.
203 * RFC 6066 says:
204 * enum{
205 * 2^9(1), 2^10(2), 2^11(3), 2^12(4), (255)
206 * } MaxFragmentLength;
207 * and we add 0 -> extension unused
208 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100209static unsigned int ssl_mfl_code_to_length(int mfl)
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200210{
Gilles Peskine449bd832023-01-11 14:50:10 +0100211 switch (mfl) {
212 case MBEDTLS_SSL_MAX_FRAG_LEN_NONE:
213 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
214 case MBEDTLS_SSL_MAX_FRAG_LEN_512:
215 return 512;
216 case MBEDTLS_SSL_MAX_FRAG_LEN_1024:
217 return 1024;
218 case MBEDTLS_SSL_MAX_FRAG_LEN_2048:
219 return 2048;
220 case MBEDTLS_SSL_MAX_FRAG_LEN_4096:
221 return 4096;
222 default:
223 return MBEDTLS_TLS_EXT_ADV_CONTENT_LEN;
Angus Grattond8213d02016-05-25 20:56:48 +1000224 }
225}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200226#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200227
Gilles Peskine449bd832023-01-11 14:50:10 +0100228int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
229 const mbedtls_ssl_session *src)
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200230{
Gilles Peskine449bd832023-01-11 14:50:10 +0100231 mbedtls_ssl_session_free(dst);
232 memcpy(dst, src, sizeof(mbedtls_ssl_session));
吴敬辉0b716112021-11-29 10:46:35 +0800233#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
234 dst->ticket = NULL;
Xiaokang Qian87306442022-10-12 09:47:38 +0000235#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
236 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000237 dst->hostname = NULL;
吴敬辉0b716112021-11-29 10:46:35 +0800238#endif
Xiaokang Qian87306442022-10-12 09:47:38 +0000239#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
吴敬辉0b716112021-11-29 10:46:35 +0800240
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000241#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
242 defined(MBEDTLS_SSL_EARLY_DATA)
243 dst->ticket_alpn = NULL;
244#endif
245
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200246#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker6d1986e2019-02-07 12:27:42 +0000247
248#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100249 if (src->peer_cert != NULL) {
Janos Follath865b3eb2019-12-16 11:46:15 +0000250 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker2292d1f2013-09-15 17:06:49 +0200251
Gilles Peskine449bd832023-01-11 14:50:10 +0100252 dst->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
253 if (dst->peer_cert == NULL) {
254 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
255 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200256
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 mbedtls_x509_crt_init(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200258
Gilles Peskine449bd832023-01-11 14:50:10 +0100259 if ((ret = mbedtls_x509_crt_parse_der(dst->peer_cert, src->peer_cert->raw.p,
260 src->peer_cert->raw.len)) != 0) {
261 mbedtls_free(dst->peer_cert);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200262 dst->peer_cert = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 return ret;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200264 }
265 }
Hanno Becker6d1986e2019-02-07 12:27:42 +0000266#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100267 if (src->peer_cert_digest != NULL) {
Hanno Becker9198ad12019-02-05 17:00:50 +0000268 dst->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 mbedtls_calloc(1, src->peer_cert_digest_len);
270 if (dst->peer_cert_digest == NULL) {
271 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
272 }
Hanno Becker9198ad12019-02-05 17:00:50 +0000273
Gilles Peskine449bd832023-01-11 14:50:10 +0100274 memcpy(dst->peer_cert_digest, src->peer_cert_digest,
275 src->peer_cert_digest_len);
Hanno Becker9198ad12019-02-05 17:00:50 +0000276 dst->peer_cert_digest_type = src->peer_cert_digest_type;
Hanno Beckeraccc5992019-02-25 10:06:59 +0000277 dst->peer_cert_digest_len = src->peer_cert_digest_len;
Hanno Becker9198ad12019-02-05 17:00:50 +0000278 }
279#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
280
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200281#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200282
Waleed Elmelegy4dfb0e72024-03-14 01:48:40 +0000283#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_ALPN) && \
284 defined(MBEDTLS_SSL_EARLY_DATA)
285 {
286 int ret = mbedtls_ssl_session_set_ticket_alpn(dst, src->ticket_alpn);
287 if (ret != 0) {
288 return ret;
289 }
290 }
291#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_ALPN && MBEDTLS_SSL_EARLY_DATA */
292
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200293#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100294 if (src->ticket != NULL) {
295 dst->ticket = mbedtls_calloc(1, src->ticket_len);
296 if (dst->ticket == NULL) {
297 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
298 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200299
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 memcpy(dst->ticket, src->ticket, src->ticket_len);
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200301 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000302
303#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
304 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100305 if (src->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000306 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100307 ret = mbedtls_ssl_session_set_hostname(dst, src->hostname);
308 if (ret != 0) {
309 return ret;
310 }
Xiaokang Qian126bf8e2022-10-13 02:22:40 +0000311 }
312#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
313 MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200314#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200315
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 return 0;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +0200317}
318
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500319#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200320MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100321static int resize_buffer(unsigned char **buffer, size_t len_new, size_t *len_old)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500322{
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 unsigned char *resized_buffer = mbedtls_calloc(1, len_new);
324 if (resized_buffer == NULL) {
Yanray Wang365ee3e2023-11-22 10:28:28 +0800325 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500327
328 /* We want to copy len_new bytes when downsizing the buffer, and
329 * len_old bytes when upsizing, so we choose the smaller of two sizes,
330 * to fit one buffer into another. Size checks, ensuring that no data is
331 * lost, are done outside of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100332 memcpy(resized_buffer, *buffer,
333 (len_new < *len_old) ? len_new : *len_old);
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100334 mbedtls_zeroize_and_free(*buffer, *len_old);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500335
336 *buffer = resized_buffer;
337 *len_old = len_new;
338
339 return 0;
340}
Andrzej Kurek4a063792020-10-21 15:08:44 +0200341
Gilles Peskine449bd832023-01-11 14:50:10 +0100342static void handle_buffer_resizing(mbedtls_ssl_context *ssl, int downsizing,
343 size_t in_buf_new_len,
344 size_t out_buf_new_len)
Andrzej Kurek4a063792020-10-21 15:08:44 +0200345{
346 int modified = 0;
347 size_t written_in = 0, iv_offset_in = 0, len_offset_in = 0;
348 size_t written_out = 0, iv_offset_out = 0, len_offset_out = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 if (ssl->in_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200350 written_in = ssl->in_msg - ssl->in_buf;
351 iv_offset_in = ssl->in_iv - ssl->in_buf;
352 len_offset_in = ssl->in_len - ssl->in_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200354 ssl->in_buf_len > in_buf_new_len && ssl->in_left < in_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 ssl->in_buf_len < in_buf_new_len) {
356 if (resize_buffer(&ssl->in_buf, in_buf_new_len, &ssl->in_buf_len) != 0) {
357 MBEDTLS_SSL_DEBUG_MSG(1, ("input buffer resizing failed - out of memory"));
358 } else {
359 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating in_buf to %" MBEDTLS_PRINTF_SIZET,
360 in_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200361 modified = 1;
362 }
363 }
364 }
365
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 if (ssl->out_buf != NULL) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200367 written_out = ssl->out_msg - ssl->out_buf;
368 iv_offset_out = ssl->out_iv - ssl->out_buf;
369 len_offset_out = ssl->out_len - ssl->out_buf;
Gilles Peskine449bd832023-01-11 14:50:10 +0100370 if (downsizing ?
Andrzej Kurek4a063792020-10-21 15:08:44 +0200371 ssl->out_buf_len > out_buf_new_len && ssl->out_left < out_buf_new_len :
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 ssl->out_buf_len < out_buf_new_len) {
373 if (resize_buffer(&ssl->out_buf, out_buf_new_len, &ssl->out_buf_len) != 0) {
374 MBEDTLS_SSL_DEBUG_MSG(1, ("output buffer resizing failed - out of memory"));
375 } else {
376 MBEDTLS_SSL_DEBUG_MSG(2, ("Reallocating out_buf to %" MBEDTLS_PRINTF_SIZET,
377 out_buf_new_len));
Andrzej Kurek4a063792020-10-21 15:08:44 +0200378 modified = 1;
379 }
380 }
381 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100382 if (modified) {
Andrzej Kurek4a063792020-10-21 15:08:44 +0200383 /* Update pointers here to avoid doing it twice. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100384 mbedtls_ssl_reset_in_out_pointers(ssl);
Andrzej Kurek4a063792020-10-21 15:08:44 +0200385 /* Fields below might not be properly updated with record
386 * splitting or with CID, so they are manually updated here. */
387 ssl->out_msg = ssl->out_buf + written_out;
388 ssl->out_len = ssl->out_buf + len_offset_out;
389 ssl->out_iv = ssl->out_buf + iv_offset_out;
390
391 ssl->in_msg = ssl->in_buf + written_in;
392 ssl->in_len = ssl->in_buf + len_offset_in;
393 ssl->in_iv = ssl->in_buf + iv_offset_in;
394 }
395}
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500396#endif /* MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH */
397
Jerry Yudb8c48a2022-01-27 14:54:54 +0800398#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yued14c932022-02-17 13:40:45 +0800399
400#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +0100401typedef int (*tls_prf_fn)(const unsigned char *secret, size_t slen,
402 const char *label,
403 const unsigned char *random, size_t rlen,
404 unsigned char *dstbuf, size_t dlen);
Jerry Yued14c932022-02-17 13:40:45 +0800405
Gilles Peskine449bd832023-01-11 14:50:10 +0100406static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id);
Jerry Yued14c932022-02-17 13:40:45 +0800407
408#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
409
410/* Type for the TLS PRF */
411typedef int ssl_tls_prf_t(const unsigned char *, size_t, const char *,
412 const unsigned char *, size_t,
413 unsigned char *, size_t);
414
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200415MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100416static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
417 int ciphersuite,
418 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200419#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200421#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +0100422 ssl_tls_prf_t tls_prf,
423 const unsigned char randbytes[64],
424 mbedtls_ssl_protocol_version tls_version,
425 unsigned endpoint,
426 const mbedtls_ssl_context *ssl);
Jerry Yued14c932022-02-17 13:40:45 +0800427
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100428#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200429MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100430static int tls_prf_sha256(const unsigned char *secret, size_t slen,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300431 const char *label,
432 const unsigned char *random, size_t rlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 unsigned char *dstbuf, size_t dlen);
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100434static int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *, unsigned char *, size_t *);
435static int ssl_calc_finished_tls_sha256(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskine449bd832023-01-11 14:50:10 +0100436
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100437#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100438
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100439#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100440MBEDTLS_CHECK_RETURN_CRITICAL
441static int tls_prf_sha384(const unsigned char *secret, size_t slen,
442 const char *label,
443 const unsigned char *random, size_t rlen,
444 unsigned char *dstbuf, size_t dlen);
445
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100446static int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *, unsigned char *, size_t *);
447static int ssl_calc_finished_tls_sha384(mbedtls_ssl_context *, unsigned char *, int);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100448#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100449
Gilles Peskine449bd832023-01-11 14:50:10 +0100450MBEDTLS_CHECK_RETURN_CRITICAL
451static int ssl_tls12_session_load(mbedtls_ssl_session *session,
452 const unsigned char *buf,
453 size_t len);
454#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
455
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100456static int ssl_update_checksum_start(mbedtls_ssl_context *, const unsigned char *, size_t);
Gilles Peskine449bd832023-01-11 14:50:10 +0100457
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100458#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100459static int ssl_update_checksum_sha256(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100460#endif /* PSA_WANT_ALG_SHA_256*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100461
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100462#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100463static int ssl_update_checksum_sha384(mbedtls_ssl_context *, const unsigned char *, size_t);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100464#endif /* PSA_WANT_ALG_SHA_384*/
Gilles Peskine449bd832023-01-11 14:50:10 +0100465
466int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
467 const unsigned char *secret, size_t slen,
468 const char *label,
469 const unsigned char *random, size_t rlen,
470 unsigned char *dstbuf, size_t dlen)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300471{
472 mbedtls_ssl_tls_prf_cb *tls_prf = NULL;
473
Gilles Peskine449bd832023-01-11 14:50:10 +0100474 switch (prf) {
Ron Eldord2f25f72019-05-15 14:54:22 +0300475#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100476#if defined(PSA_WANT_ALG_SHA_384)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300477 case MBEDTLS_SSL_TLS_PRF_SHA384:
478 tls_prf = tls_prf_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 break;
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100480#endif /* PSA_WANT_ALG_SHA_384*/
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100481#if defined(PSA_WANT_ALG_SHA_256)
Ron Eldor51d3ab52019-05-12 14:54:30 +0300482 case MBEDTLS_SSL_TLS_PRF_SHA256:
483 tls_prf = tls_prf_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100484 break;
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100485#endif /* PSA_WANT_ALG_SHA_256*/
Ron Eldord2f25f72019-05-15 14:54:22 +0300486#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 default:
488 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldor51d3ab52019-05-12 14:54:30 +0300489 }
490
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 return tls_prf(secret, slen, label, random, rlen, dstbuf, dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +0300492}
493
Jerry Yuc73c6182022-02-08 20:29:25 +0800494#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100495static void ssl_clear_peer_cert(mbedtls_ssl_session *session)
Jerry Yuc73c6182022-02-08 20:29:25 +0800496{
497#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +0100498 if (session->peer_cert != NULL) {
499 mbedtls_x509_crt_free(session->peer_cert);
500 mbedtls_free(session->peer_cert);
Jerry Yuc73c6182022-02-08 20:29:25 +0800501 session->peer_cert = NULL;
502 }
503#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +0100504 if (session->peer_cert_digest != NULL) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800505 /* Zeroization is not necessary. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100506 mbedtls_free(session->peer_cert_digest);
Jerry Yuc73c6182022-02-08 20:29:25 +0800507 session->peer_cert_digest = NULL;
508 session->peer_cert_digest_type = MBEDTLS_MD_NONE;
509 session->peer_cert_digest_len = 0;
510 }
511#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
512}
513#endif /* MBEDTLS_X509_CRT_PARSE_C */
514
Gilles Peskine449bd832023-01-11 14:50:10 +0100515uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800516{
Gilles Peskine449bd832023-01-11 14:50:10 +0100517 switch (extension_type) {
Jerry Yu7a485c12022-10-31 13:08:18 +0800518 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 return MBEDTLS_SSL_EXT_ID_SERVERNAME;
Jerry Yu7a485c12022-10-31 13:08:18 +0800520
521 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800523
524 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return MBEDTLS_SSL_EXT_ID_STATUS_REQUEST;
Jerry Yu7a485c12022-10-31 13:08:18 +0800526
527 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800529
530 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return MBEDTLS_SSL_EXT_ID_SIG_ALG;
Jerry Yu7a485c12022-10-31 13:08:18 +0800532
533 case MBEDTLS_TLS_EXT_USE_SRTP:
Gilles Peskine449bd832023-01-11 14:50:10 +0100534 return MBEDTLS_SSL_EXT_ID_USE_SRTP;
Jerry Yu7a485c12022-10-31 13:08:18 +0800535
536 case MBEDTLS_TLS_EXT_HEARTBEAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return MBEDTLS_SSL_EXT_ID_HEARTBEAT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800538
539 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 return MBEDTLS_SSL_EXT_ID_ALPN;
Jerry Yu7a485c12022-10-31 13:08:18 +0800541
542 case MBEDTLS_TLS_EXT_SCT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_SSL_EXT_ID_SCT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800544
545 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 return MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800547
548 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 return MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800550
551 case MBEDTLS_TLS_EXT_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return MBEDTLS_SSL_EXT_ID_PADDING;
Jerry Yu7a485c12022-10-31 13:08:18 +0800553
554 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 return MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY;
Jerry Yu7a485c12022-10-31 13:08:18 +0800556
557 case MBEDTLS_TLS_EXT_EARLY_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 return MBEDTLS_SSL_EXT_ID_EARLY_DATA;
Jerry Yu7a485c12022-10-31 13:08:18 +0800559
560 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 return MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800562
563 case MBEDTLS_TLS_EXT_COOKIE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 return MBEDTLS_SSL_EXT_ID_COOKIE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800565
566 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 return MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES;
Jerry Yu7a485c12022-10-31 13:08:18 +0800568
569 case MBEDTLS_TLS_EXT_CERT_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 return MBEDTLS_SSL_EXT_ID_CERT_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800571
572 case MBEDTLS_TLS_EXT_OID_FILTERS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 return MBEDTLS_SSL_EXT_ID_OID_FILTERS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800574
575 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH;
Jerry Yu7a485c12022-10-31 13:08:18 +0800577
578 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT;
Jerry Yu7a485c12022-10-31 13:08:18 +0800580
581 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 return MBEDTLS_SSL_EXT_ID_KEY_SHARE;
Jerry Yu7a485c12022-10-31 13:08:18 +0800583
584 case MBEDTLS_TLS_EXT_TRUNCATED_HMAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 return MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800586
587 case MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 return MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS;
Jerry Yu7a485c12022-10-31 13:08:18 +0800589
590 case MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC:
Gilles Peskine449bd832023-01-11 14:50:10 +0100591 return MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC;
Jerry Yu7a485c12022-10-31 13:08:18 +0800592
593 case MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 return MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800595
Jan Bruckner151f6422023-02-10 12:45:19 +0100596 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
597 return MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT;
598
Jerry Yu7a485c12022-10-31 13:08:18 +0800599 case MBEDTLS_TLS_EXT_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100600 return MBEDTLS_SSL_EXT_ID_SESSION_TICKET;
Jerry Yu7a485c12022-10-31 13:08:18 +0800601
602 }
603
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 return MBEDTLS_SSL_EXT_ID_UNRECOGNIZED;
Jerry Yu7a485c12022-10-31 13:08:18 +0800605}
606
Gilles Peskine449bd832023-01-11 14:50:10 +0100607uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type)
Jerry Yu7a485c12022-10-31 13:08:18 +0800608{
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 return 1 << mbedtls_ssl_get_extension_id(extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800610}
611
Jerry Yud25cab02022-10-31 12:48:30 +0800612#if defined(MBEDTLS_DEBUG_C)
613static const char *extension_name_table[] = {
Jerry Yuea52ed92022-11-08 21:01:17 +0800614 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = "unrecognized",
Jerry Yud25cab02022-10-31 12:48:30 +0800615 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = "server_name",
616 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = "max_fragment_length",
617 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = "status_request",
618 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = "supported_groups",
619 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = "signature_algorithms",
620 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = "use_srtp",
621 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = "heartbeat",
622 [MBEDTLS_SSL_EXT_ID_ALPN] = "application_layer_protocol_negotiation",
623 [MBEDTLS_SSL_EXT_ID_SCT] = "signed_certificate_timestamp",
624 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = "client_certificate_type",
625 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = "server_certificate_type",
626 [MBEDTLS_SSL_EXT_ID_PADDING] = "padding",
627 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = "pre_shared_key",
628 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = "early_data",
629 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = "supported_versions",
630 [MBEDTLS_SSL_EXT_ID_COOKIE] = "cookie",
631 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = "psk_key_exchange_modes",
632 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = "certificate_authorities",
633 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = "oid_filters",
634 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = "post_handshake_auth",
635 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = "signature_algorithms_cert",
636 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = "key_share",
637 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = "truncated_hmac",
638 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = "supported_point_formats",
639 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = "encrypt_then_mac",
640 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = "extended_master_secret",
Jan Bruckner151f6422023-02-10 12:45:19 +0100641 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = "session_ticket",
642 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = "record_size_limit"
Jerry Yud25cab02022-10-31 12:48:30 +0800643};
644
Chien Wong4e9683e2023-12-28 17:07:43 +0800645static const unsigned int extension_type_table[] = {
Jerry Yud25cab02022-10-31 12:48:30 +0800646 [MBEDTLS_SSL_EXT_ID_UNRECOGNIZED] = 0xff,
647 [MBEDTLS_SSL_EXT_ID_SERVERNAME] = MBEDTLS_TLS_EXT_SERVERNAME,
648 [MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH] = MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH,
649 [MBEDTLS_SSL_EXT_ID_STATUS_REQUEST] = MBEDTLS_TLS_EXT_STATUS_REQUEST,
650 [MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS] = MBEDTLS_TLS_EXT_SUPPORTED_GROUPS,
651 [MBEDTLS_SSL_EXT_ID_SIG_ALG] = MBEDTLS_TLS_EXT_SIG_ALG,
652 [MBEDTLS_SSL_EXT_ID_USE_SRTP] = MBEDTLS_TLS_EXT_USE_SRTP,
653 [MBEDTLS_SSL_EXT_ID_HEARTBEAT] = MBEDTLS_TLS_EXT_HEARTBEAT,
654 [MBEDTLS_SSL_EXT_ID_ALPN] = MBEDTLS_TLS_EXT_ALPN,
655 [MBEDTLS_SSL_EXT_ID_SCT] = MBEDTLS_TLS_EXT_SCT,
656 [MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE] = MBEDTLS_TLS_EXT_CLI_CERT_TYPE,
657 [MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE] = MBEDTLS_TLS_EXT_SERV_CERT_TYPE,
658 [MBEDTLS_SSL_EXT_ID_PADDING] = MBEDTLS_TLS_EXT_PADDING,
659 [MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY] = MBEDTLS_TLS_EXT_PRE_SHARED_KEY,
660 [MBEDTLS_SSL_EXT_ID_EARLY_DATA] = MBEDTLS_TLS_EXT_EARLY_DATA,
661 [MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS] = MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS,
662 [MBEDTLS_SSL_EXT_ID_COOKIE] = MBEDTLS_TLS_EXT_COOKIE,
663 [MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES] = MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES,
664 [MBEDTLS_SSL_EXT_ID_CERT_AUTH] = MBEDTLS_TLS_EXT_CERT_AUTH,
665 [MBEDTLS_SSL_EXT_ID_OID_FILTERS] = MBEDTLS_TLS_EXT_OID_FILTERS,
666 [MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH] = MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH,
667 [MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT] = MBEDTLS_TLS_EXT_SIG_ALG_CERT,
668 [MBEDTLS_SSL_EXT_ID_KEY_SHARE] = MBEDTLS_TLS_EXT_KEY_SHARE,
669 [MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC] = MBEDTLS_TLS_EXT_TRUNCATED_HMAC,
670 [MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS] = MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS,
671 [MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC] = MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC,
672 [MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET] = MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET,
Jan Bruckner151f6422023-02-10 12:45:19 +0100673 [MBEDTLS_SSL_EXT_ID_SESSION_TICKET] = MBEDTLS_TLS_EXT_SESSION_TICKET,
674 [MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT] = MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT
Jerry Yud25cab02022-10-31 12:48:30 +0800675};
676
Gilles Peskine449bd832023-01-11 14:50:10 +0100677const char *mbedtls_ssl_get_extension_name(unsigned int extension_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800678{
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 return extension_name_table[
680 mbedtls_ssl_get_extension_id(extension_type)];
Jerry Yud25cab02022-10-31 12:48:30 +0800681}
682
Gilles Peskine449bd832023-01-11 14:50:10 +0100683static const char *ssl_tls13_get_hs_msg_name(int hs_msg_type)
Jerry Yud25cab02022-10-31 12:48:30 +0800684{
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 switch (hs_msg_type) {
Jerry Yud25cab02022-10-31 12:48:30 +0800686 case MBEDTLS_SSL_HS_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 return "ClientHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800688 case MBEDTLS_SSL_HS_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 return "ServerHello";
Jerry Yud25cab02022-10-31 12:48:30 +0800690 case MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100691 return "HelloRetryRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800692 case MBEDTLS_SSL_HS_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +0100693 return "NewSessionTicket";
Jerry Yud25cab02022-10-31 12:48:30 +0800694 case MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 return "EncryptedExtensions";
Jerry Yud25cab02022-10-31 12:48:30 +0800696 case MBEDTLS_SSL_HS_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100697 return "Certificate";
Jerry Yud25cab02022-10-31 12:48:30 +0800698 case MBEDTLS_SSL_HS_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 return "CertificateRequest";
Jerry Yud25cab02022-10-31 12:48:30 +0800700 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 return "Unknown";
Jerry Yud25cab02022-10-31 12:48:30 +0800702}
703
Gilles Peskine449bd832023-01-11 14:50:10 +0100704void mbedtls_ssl_print_extension(const mbedtls_ssl_context *ssl,
705 int level, const char *file, int line,
706 int hs_msg_type, unsigned int extension_type,
707 const char *extra_msg0, const char *extra_msg1)
Jerry Yud25cab02022-10-31 12:48:30 +0800708{
709 const char *extra_msg;
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 if (extra_msg0 && extra_msg1) {
Jerry Yud25cab02022-10-31 12:48:30 +0800711 mbedtls_debug_print_msg(
712 ssl, level, file, line,
713 "%s: %s(%u) extension %s %s.",
Gilles Peskine449bd832023-01-11 14:50:10 +0100714 ssl_tls13_get_hs_msg_name(hs_msg_type),
715 mbedtls_ssl_get_extension_name(extension_type),
Jerry Yud25cab02022-10-31 12:48:30 +0800716 extension_type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 extra_msg0, extra_msg1);
Jerry Yud25cab02022-10-31 12:48:30 +0800718 return;
719 }
720
721 extra_msg = extra_msg0 ? extra_msg0 : extra_msg1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100722 if (extra_msg) {
Jerry Yud25cab02022-10-31 12:48:30 +0800723 mbedtls_debug_print_msg(
724 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100725 "%s: %s(%u) extension %s.", ssl_tls13_get_hs_msg_name(hs_msg_type),
726 mbedtls_ssl_get_extension_name(extension_type), extension_type,
727 extra_msg);
Jerry Yud25cab02022-10-31 12:48:30 +0800728 return;
729 }
730
731 mbedtls_debug_print_msg(
732 ssl, level, file, line,
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 "%s: %s(%u) extension.", ssl_tls13_get_hs_msg_name(hs_msg_type),
734 mbedtls_ssl_get_extension_name(extension_type), extension_type);
Jerry Yud25cab02022-10-31 12:48:30 +0800735}
736
Gilles Peskine449bd832023-01-11 14:50:10 +0100737void mbedtls_ssl_print_extensions(const mbedtls_ssl_context *ssl,
738 int level, const char *file, int line,
739 int hs_msg_type, uint32_t extensions_mask,
740 const char *extra)
Jerry Yud25cab02022-10-31 12:48:30 +0800741{
742
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 for (unsigned i = 0;
744 i < sizeof(extension_name_table) / sizeof(extension_name_table[0]);
745 i++) {
Jerry Yu79aa7212022-11-08 21:30:21 +0800746 mbedtls_ssl_print_extension(
Jerry Yuea52ed92022-11-08 21:01:17 +0800747 ssl, level, file, line, hs_msg_type, extension_type_table[i],
Gilles Peskine449bd832023-01-11 14:50:10 +0100748 extensions_mask & (1 << i) ? "exists" : "does not exist", extra);
Jerry Yud25cab02022-10-31 12:48:30 +0800749 }
750}
751
Pengyu Lvee455c02023-01-12 14:37:24 +0800752#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvee455c02023-01-12 14:37:24 +0800753static const char *ticket_flag_name_table[] =
754{
755 [0] = "ALLOW_PSK_RESUMPTION",
756 [2] = "ALLOW_PSK_EPHEMERAL_RESUMPTION",
757 [3] = "ALLOW_EARLY_DATA",
758};
759
Pengyu Lv4938a562023-01-16 11:28:49 +0800760void mbedtls_ssl_print_ticket_flags(const mbedtls_ssl_context *ssl,
761 int level, const char *file, int line,
762 unsigned int flags)
Pengyu Lvee455c02023-01-12 14:37:24 +0800763{
764 size_t i;
765
766 mbedtls_debug_print_msg(ssl, level, file, line,
Pengyu Lv4938a562023-01-16 11:28:49 +0800767 "print ticket_flags (0x%02x)", flags);
768
769 flags = flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK;
Pengyu Lvee455c02023-01-12 14:37:24 +0800770
771 for (i = 0; i < ARRAY_LENGTH(ticket_flag_name_table); i++) {
Pengyu Lv4938a562023-01-16 11:28:49 +0800772 if ((flags & (1 << i))) {
Pengyu Lvee455c02023-01-12 14:37:24 +0800773 mbedtls_debug_print_msg(ssl, level, file, line, "- %s is set.",
774 ticket_flag_name_table[i]);
775 }
776 }
777}
778#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
779
Jerry Yud25cab02022-10-31 12:48:30 +0800780#endif /* MBEDTLS_DEBUG_C */
781
Gilles Peskine449bd832023-01-11 14:50:10 +0100782void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
783 const mbedtls_ssl_ciphersuite_t *ciphersuite_info)
Jerry Yuc73c6182022-02-08 20:29:25 +0800784{
785 ((void) ciphersuite_info);
786
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100787#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +0100788 if (ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800789 ssl->handshake->update_checksum = ssl_update_checksum_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800791#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100792#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 if (ciphersuite_info->mac != MBEDTLS_MD_SHA384) {
Jerry Yuc73c6182022-02-08 20:29:25 +0800794 ssl->handshake->update_checksum = ssl_update_checksum_sha256;
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 } else
Jerry Yuc73c6182022-02-08 20:29:25 +0800796#endif
797 {
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yuc73c6182022-02-08 20:29:25 +0800799 return;
800 }
801}
802
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100803int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100804 unsigned hs_type,
805 size_t total_hs_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100806{
807 unsigned char hs_hdr[4];
808
809 /* Build HS header for checksum update. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 hs_hdr[0] = MBEDTLS_BYTE_0(hs_type);
811 hs_hdr[1] = MBEDTLS_BYTE_2(total_hs_len);
812 hs_hdr[2] = MBEDTLS_BYTE_1(total_hs_len);
813 hs_hdr[3] = MBEDTLS_BYTE_0(total_hs_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100814
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100815 return ssl->handshake->update_checksum(ssl, hs_hdr, sizeof(hs_hdr));
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100816}
817
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100818int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100819 unsigned hs_type,
820 unsigned char const *msg,
821 size_t msg_len)
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100822{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100823 int ret;
824 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl, hs_type, msg_len);
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100825 if (ret != 0) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100826 return ret;
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100827 }
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100828 return ssl->handshake->update_checksum(ssl, msg, msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +0100829}
830
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100831int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl)
Jerry Yuc73c6182022-02-08 20:29:25 +0800832{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100833#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100834 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100835#if defined(MBEDTLS_USE_PSA_CRYPTO)
836 psa_status_t status;
837#else
838 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
839#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100840#else /* SHA-256 or SHA-384 */
Jerry Yuc73c6182022-02-08 20:29:25 +0800841 ((void) ssl);
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100842#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100843#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800844#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100845 status = psa_hash_abort(&ssl->handshake->fin_sha256_psa);
846 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200847 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100848 }
849 status = psa_hash_setup(&ssl->handshake->fin_sha256_psa, PSA_ALG_SHA_256);
850 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200851 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100852 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800853#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100854 mbedtls_md_free(&ssl->handshake->fin_sha256);
855 mbedtls_md_init(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100856 ret = mbedtls_md_setup(&ssl->handshake->fin_sha256,
857 mbedtls_md_info_from_type(MBEDTLS_MD_SHA256),
858 0);
859 if (ret != 0) {
860 return ret;
861 }
862 ret = mbedtls_md_starts(&ssl->handshake->fin_sha256);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100863 if (ret != 0) {
864 return ret;
865 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800866#endif
867#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100868#if defined(PSA_WANT_ALG_SHA_384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800869#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100870 status = psa_hash_abort(&ssl->handshake->fin_sha384_psa);
871 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200872 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100873 }
874 status = psa_hash_setup(&ssl->handshake->fin_sha384_psa, PSA_ALG_SHA_384);
875 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200876 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100877 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800878#else
Manuel Pégourié-Gonnard947cee12023-03-06 11:59:59 +0100879 mbedtls_md_free(&ssl->handshake->fin_sha384);
880 mbedtls_md_init(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100881 ret = mbedtls_md_setup(&ssl->handshake->fin_sha384,
882 mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
883 if (ret != 0) {
884 return ret;
885 }
886 ret = mbedtls_md_starts(&ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardb72ff492023-02-06 09:54:49 +0100887 if (ret != 0) {
888 return ret;
889 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800890#endif
891#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100892 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800893}
894
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100895static int ssl_update_checksum_start(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100896 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800897{
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100898#if defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100899 defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100900#if defined(MBEDTLS_USE_PSA_CRYPTO)
901 psa_status_t status;
902#else
903 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
904#endif
Manuel Pégourié-Gonnard626aaed2023-02-06 22:03:06 +0100905#else /* SHA-256 or SHA-384 */
906 ((void) ssl);
907 (void) buf;
908 (void) len;
909#endif /* SHA-256 or SHA-384 */
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100910#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuc73c6182022-02-08 20:29:25 +0800911#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100912 status = psa_hash_update(&ssl->handshake->fin_sha256_psa, buf, len);
913 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200914 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100915 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800916#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100917 ret = mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100918 if (ret != 0) {
919 return ret;
920 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800921#endif
922#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100923#if defined(PSA_WANT_ALG_SHA_384)
Jerry Yuc73c6182022-02-08 20:29:25 +0800924#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100925 status = psa_hash_update(&ssl->handshake->fin_sha384_psa, buf, len);
926 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200927 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100928 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800929#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100930 ret = mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Manuel Pégourié-Gonnarddf949012023-02-06 10:00:52 +0100931 if (ret != 0) {
932 return ret;
933 }
Jerry Yuc73c6182022-02-08 20:29:25 +0800934#endif
935#endif
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100936 return 0;
Jerry Yuc73c6182022-02-08 20:29:25 +0800937}
938
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100939#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100940static int ssl_update_checksum_sha256(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100941 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800942{
943#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200944 return mbedtls_md_error_from_psa(psa_hash_update(
945 &ssl->handshake->fin_sha256_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800946#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100947 return mbedtls_md_update(&ssl->handshake->fin_sha256, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800948#endif
949}
950#endif
951
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100952#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100953static int ssl_update_checksum_sha384(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +0100954 const unsigned char *buf, size_t len)
Jerry Yuc73c6182022-02-08 20:29:25 +0800955{
956#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +0200957 return mbedtls_md_error_from_psa(psa_hash_update(
958 &ssl->handshake->fin_sha384_psa, buf, len));
Jerry Yuc73c6182022-02-08 20:29:25 +0800959#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100960 return mbedtls_md_update(&ssl->handshake->fin_sha384, buf, len);
Jerry Yuc73c6182022-02-08 20:29:25 +0800961#endif
962}
963#endif
964
Gilles Peskine449bd832023-01-11 14:50:10 +0100965static void ssl_handshake_params_init(mbedtls_ssl_handshake_params *handshake)
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200966{
Gilles Peskine449bd832023-01-11 14:50:10 +0100967 memset(handshake, 0, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200968
Elena Uziunaite0916cd72024-05-23 17:01:07 +0100969#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500970#if defined(MBEDTLS_USE_PSA_CRYPTO)
971 handshake->fin_sha256_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500972#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100973 mbedtls_md_init(&handshake->fin_sha256);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200974#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500975#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +0100976#if defined(PSA_WANT_ALG_SHA_384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500977#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500978 handshake->fin_sha384_psa = psa_hash_operation_init();
Andrzej Kurekeb342242019-01-29 09:14:33 -0500979#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100980 mbedtls_md_init(&handshake->fin_sha384);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200981#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500982#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200983
984 handshake->update_checksum = ssl_update_checksum_start;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100985
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100987 mbedtls_dhm_init(&handshake->dhm_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200988#endif
Valerio Setti7aeec542023-07-05 18:57:21 +0200989#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +0200990 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100991 mbedtls_ecdh_init(&handshake->ecdh_ctx);
Paul Bakkeraccaffe2014-06-26 13:37:14 +0200992#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200993#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200994#if defined(MBEDTLS_USE_PSA_CRYPTO)
995 handshake->psa_pake_ctx = psa_pake_operation_init();
996 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
997#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 mbedtls_ecjpake_init(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +0200999#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02001000#if defined(MBEDTLS_SSL_CLI_C)
1001 handshake->ecjpake_cache = NULL;
1002 handshake->ecjpake_cache_len = 0;
1003#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02001004#endif
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001005
Gilles Peskineeccd8882020-03-10 12:19:08 +01001006#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 mbedtls_x509_crt_restart_init(&handshake->ecrs_ctx);
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02001008#endif
1009
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001010#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1011 handshake->sni_authmode = MBEDTLS_SSL_VERIFY_UNSET;
1012#endif
Hanno Becker75173122019-02-06 16:18:31 +00001013
1014#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1015 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 mbedtls_pk_init(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00001017#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001018}
1019
Gilles Peskine449bd832023-01-11 14:50:10 +01001020void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001021{
Gilles Peskine449bd832023-01-11 14:50:10 +01001022 memset(transform, 0, sizeof(mbedtls_ssl_transform));
Paul Bakker84bbeb52014-07-01 14:53:22 +02001023
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001024#if defined(MBEDTLS_USE_PSA_CRYPTO)
1025 transform->psa_key_enc = MBEDTLS_SVC_KEY_ID_INIT;
1026 transform->psa_key_dec = MBEDTLS_SVC_KEY_ID_INIT;
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001027#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 mbedtls_cipher_init(&transform->cipher_ctx_enc);
1029 mbedtls_cipher_init(&transform->cipher_ctx_dec);
Przemyslaw Stekiel8f80fb92022-01-11 08:28:13 +01001030#endif
1031
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001032#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001033#if defined(MBEDTLS_USE_PSA_CRYPTO)
1034 transform->psa_mac_enc = MBEDTLS_SVC_KEY_ID_INIT;
1035 transform->psa_mac_dec = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001036#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 mbedtls_md_init(&transform->md_ctx_enc);
1038 mbedtls_md_init(&transform->md_ctx_dec);
Hanno Beckerd56ed242018-01-03 15:32:51 +00001039#endif
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001040#endif
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001041}
1042
Gilles Peskine449bd832023-01-11 14:50:10 +01001043void mbedtls_ssl_session_init(mbedtls_ssl_session *session)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001044{
Gilles Peskine449bd832023-01-11 14:50:10 +01001045 memset(session, 0, sizeof(mbedtls_ssl_session));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001046}
1047
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001048MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001049static int ssl_handshake_init(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00001050{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001051 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1052
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001053 /* Clear old handshake information if present */
Jerry Yu2e199812022-12-01 18:57:19 +08001054#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 if (ssl->transform_negotiate) {
1056 mbedtls_ssl_transform_free(ssl->transform_negotiate);
1057 }
Jerry Yu2e199812022-12-01 18:57:19 +08001058#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 if (ssl->session_negotiate) {
1060 mbedtls_ssl_session_free(ssl->session_negotiate);
1061 }
1062 if (ssl->handshake) {
1063 mbedtls_ssl_handshake_free(ssl);
1064 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001065
Jerry Yu2e199812022-12-01 18:57:19 +08001066#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001067 /*
1068 * Either the pointers are now NULL or cleared properly and can be freed.
1069 * Now allocate missing structures.
1070 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 if (ssl->transform_negotiate == NULL) {
1072 ssl->transform_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_transform));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001073 }
Jerry Yu2e199812022-12-01 18:57:19 +08001074#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001075
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 if (ssl->session_negotiate == NULL) {
1077 ssl->session_negotiate = mbedtls_calloc(1, sizeof(mbedtls_ssl_session));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001078 }
Paul Bakker48916f92012-09-16 19:57:18 +00001079
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 if (ssl->handshake == NULL) {
1081 ssl->handshake = mbedtls_calloc(1, sizeof(mbedtls_ssl_handshake_params));
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001082 }
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001083#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1084 /* If the buffers are too small - reallocate */
Andrzej Kurek8ea68722020-04-03 06:40:47 -04001085
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 handle_buffer_resizing(ssl, 0, MBEDTLS_SSL_IN_BUFFER_LEN,
1087 MBEDTLS_SSL_OUT_BUFFER_LEN);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05001088#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001089
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001090 /* All pointers should exist and can be directly freed without issue */
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 if (ssl->handshake == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001092#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Paul Bakker48916f92012-09-16 19:57:18 +00001093 ssl->transform_negotiate == NULL ||
Jerry Yu2e199812022-12-01 18:57:19 +08001094#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 ssl->session_negotiate == NULL) {
1096 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc() of ssl sub-contexts failed"));
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001097
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 mbedtls_free(ssl->handshake);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001099 ssl->handshake = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001100
1101#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 mbedtls_free(ssl->transform_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001103 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08001104#endif
1105
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 mbedtls_free(ssl->session_negotiate);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001107 ssl->session_negotiate = NULL;
1108
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Paul Bakker48916f92012-09-16 19:57:18 +00001110 }
1111
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001112#if defined(MBEDTLS_SSL_EARLY_DATA)
1113#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001114 ssl->early_data_state = MBEDTLS_SSL_EARLY_DATA_STATE_IDLE;
Ronald Cron5d0ae902024-01-05 14:20:35 +01001115#endif
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001116#if defined(MBEDTLS_SSL_SRV_C)
1117 ssl->discard_early_data_record = MBEDTLS_SSL_EARLY_DATA_NO_DISCARD;
1118#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001119 ssl->total_early_data_size = 0;
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001120#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron5d0ae902024-01-05 14:20:35 +01001121
Paul Bakkeraccaffe2014-06-26 13:37:14 +02001122 /* Initialize structures */
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 mbedtls_ssl_session_init(ssl->session_negotiate);
1124 ssl_handshake_params_init(ssl->handshake);
Paul Bakker968afaa2014-07-09 11:09:24 +02001125
Jerry Yu2e199812022-12-01 18:57:19 +08001126#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001127 mbedtls_ssl_transform_init(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08001128#endif
1129
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001130 /* Setup handshake checksums */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001131 ret = mbedtls_ssl_reset_checksum(ssl);
1132 if (ret != 0) {
1133 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_checksum", ret);
1134 return ret;
1135 }
Manuel Pégourié-Gonnard537f2312023-02-05 10:17:45 +01001136
Jerry Yud0766ec2022-09-22 10:46:57 +08001137#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
1138 defined(MBEDTLS_SSL_SRV_C) && \
1139 defined(MBEDTLS_SSL_SESSION_TICKETS)
1140 ssl->handshake->new_session_tickets_count =
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 ssl->conf->new_session_tickets_count;
Jerry Yud0766ec2022-09-22 10:46:57 +08001142#endif
1143
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001144#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001145 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001146 ssl->handshake->alt_transform_out = ssl->transform_out;
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001147
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001149 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_PREPARING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001150 } else {
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001151 ssl->handshake->retransmit_state = MBEDTLS_SSL_RETRANS_WAITING;
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 }
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001153
Gilles Peskine449bd832023-01-11 14:50:10 +01001154 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001155 }
Manuel Pégourié-Gonnard5d8ba532014-09-19 15:09:21 +02001156#endif
1157
Brett Warrene0edc842021-08-17 09:53:13 +01001158/*
1159 * curve_list is translated to IANA TLS group identifiers here because
1160 * mbedtls_ssl_conf_curves returns void and so can't return
1161 * any error codes.
1162 */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001163#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01001164#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1165 /* Heap allocate and translate curve_list from internal to IANA group ids */
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 if (ssl->conf->curve_list != NULL) {
Brett Warrene0edc842021-08-17 09:53:13 +01001167 size_t length;
1168 const mbedtls_ecp_group_id *curve_list = ssl->conf->curve_list;
1169
Thomas Daubney850a0792023-05-22 12:05:03 +01001170 for (length = 0; (curve_list[length] != MBEDTLS_ECP_DP_NONE); length++) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 }
Brett Warrene0edc842021-08-17 09:53:13 +01001172
1173 /* Leave room for zero termination */
Gilles Peskine449bd832023-01-11 14:50:10 +01001174 uint16_t *group_list = mbedtls_calloc(length + 1, sizeof(uint16_t));
1175 if (group_list == NULL) {
1176 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1177 }
Brett Warrene0edc842021-08-17 09:53:13 +01001178
Gilles Peskine449bd832023-01-11 14:50:10 +01001179 for (size_t i = 0; i < length; i++) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01001180 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(
Gilles Peskine449bd832023-01-11 14:50:10 +01001181 curve_list[i]);
1182 if (tls_id == 0) {
1183 mbedtls_free(group_list);
1184 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Brett Warrene0edc842021-08-17 09:53:13 +01001185 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01001186 group_list[i] = tls_id;
Brett Warrene0edc842021-08-17 09:53:13 +01001187 }
1188
1189 group_list[length] = 0;
1190
1191 ssl->handshake->group_list = group_list;
1192 ssl->handshake->group_list_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001193 } else {
Brett Warrene0edc842021-08-17 09:53:13 +01001194 ssl->handshake->group_list = ssl->conf->group_list;
1195 ssl->handshake->group_list_heap_allocated = 0;
1196 }
1197#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001198#endif /* MBEDTLS_ECP_C */
Brett Warrene0edc842021-08-17 09:53:13 +01001199
Ronald Crone68ab4f2022-10-05 12:46:29 +02001200#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001201#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yua69269a2022-01-17 21:06:01 +08001202#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Jerry Yu713013f2022-01-17 18:16:35 +08001203 /* Heap allocate and translate sig_hashes from internal hash identifiers to
1204 signature algorithms IANA identifiers. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001205 if (mbedtls_ssl_conf_is_tls12_only(ssl->conf) &&
1206 ssl->conf->sig_hashes != NULL) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001207 const int *md;
1208 const int *sig_hashes = ssl->conf->sig_hashes;
Jerry Yub476a442022-01-21 18:14:45 +08001209 size_t sig_algs_len = 0;
Jerry Yuf017ee42022-01-12 15:49:48 +08001210 uint16_t *p;
1211
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001212 MBEDTLS_STATIC_ASSERT(MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN
1213 <= (SIZE_MAX - (2 * sizeof(uint16_t))),
1214 "MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN too big");
Jerry Yua68dca22022-01-20 16:28:27 +08001215
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1217 if (mbedtls_ssl_hash_from_md_alg(*md) == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001218 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001219 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001220#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001222#endif
Jerry Yua68dca22022-01-20 16:28:27 +08001223
Jerry Yub476a442022-01-21 18:14:45 +08001224#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001225 sig_algs_len += sizeof(uint16_t);
Jerry Yub476a442022-01-21 18:14:45 +08001226#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001227 if (sig_algs_len > MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN) {
1228 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1229 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001230 }
1231
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 if (sig_algs_len < MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN) {
1233 return MBEDTLS_ERR_SSL_BAD_CONFIG;
1234 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001235
Gilles Peskine449bd832023-01-11 14:50:10 +01001236 ssl->handshake->sig_algs = mbedtls_calloc(1, sig_algs_len +
1237 sizeof(uint16_t));
1238 if (ssl->handshake->sig_algs == NULL) {
1239 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1240 }
Jerry Yuf017ee42022-01-12 15:49:48 +08001241
Gilles Peskine449bd832023-01-11 14:50:10 +01001242 p = (uint16_t *) ssl->handshake->sig_algs;
1243 for (md = sig_hashes; *md != MBEDTLS_MD_NONE; md++) {
1244 unsigned char hash = mbedtls_ssl_hash_from_md_alg(*md);
1245 if (hash == MBEDTLS_SSL_HASH_NONE) {
Jerry Yuf017ee42022-01-12 15:49:48 +08001246 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001247 }
Valerio Settie9646ec2023-08-02 20:02:28 +02001248#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001249 *p = ((hash << 8) | MBEDTLS_SSL_SIG_ECDSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001250 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001251#endif
1252#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001253 *p = ((hash << 8) | MBEDTLS_SSL_SIG_RSA);
Jerry Yuf017ee42022-01-12 15:49:48 +08001254 p++;
Jerry Yu6106fdc2022-01-12 16:36:14 +08001255#endif
Jerry Yuf017ee42022-01-12 15:49:48 +08001256 }
Gabor Mezei15b95a62022-05-09 16:37:58 +02001257 *p = MBEDTLS_TLS_SIG_NONE;
Jerry Yuf017ee42022-01-12 15:49:48 +08001258 ssl->handshake->sig_algs_heap_allocated = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01001259 } else
Jerry Yua69269a2022-01-17 21:06:01 +08001260#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Jerry Yuf017ee42022-01-12 15:49:48 +08001261 {
Jerry Yuf017ee42022-01-12 15:49:48 +08001262 ssl->handshake->sig_algs_heap_allocated = 0;
1263 }
Jerry Yucc539102022-06-27 16:27:35 +08001264#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001265#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001266 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001267}
1268
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001269#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001270/* Dummy cookie callbacks for defaults */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001271MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001272static int ssl_cookie_write_dummy(void *ctx,
1273 unsigned char **p, unsigned char *end,
1274 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001275{
1276 ((void) ctx);
1277 ((void) p);
1278 ((void) end);
1279 ((void) cli_id);
1280 ((void) cli_id_len);
1281
Gilles Peskine449bd832023-01-11 14:50:10 +01001282 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001283}
1284
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001285MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001286static int ssl_cookie_check_dummy(void *ctx,
1287 const unsigned char *cookie, size_t cookie_len,
1288 const unsigned char *cli_id, size_t cli_id_len)
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001289{
1290 ((void) ctx);
1291 ((void) cookie);
1292 ((void) cookie_len);
1293 ((void) cli_id);
1294 ((void) cli_id_len);
1295
Gilles Peskine449bd832023-01-11 14:50:10 +01001296 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001297}
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001298#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001299
Paul Bakker5121ce52009-01-03 21:22:43 +00001300/*
1301 * Initialize an SSL context
1302 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001303void mbedtls_ssl_init(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001304{
Gilles Peskine449bd832023-01-11 14:50:10 +01001305 memset(ssl, 0, sizeof(mbedtls_ssl_context));
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001306}
1307
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001308MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001309static int ssl_conf_version_check(const mbedtls_ssl_context *ssl)
Jerry Yu60835a82021-08-04 10:13:52 +08001310{
Ronald Cron086ee0b2022-03-15 15:18:51 +01001311 const mbedtls_ssl_config *conf = ssl->conf;
1312
Ronald Cron6f135e12021-12-08 16:57:54 +01001313#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001314 if (mbedtls_ssl_conf_is_tls13_only(conf)) {
1315 if (conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1316 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS 1.3 is not yet supported."));
1317 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001318 }
1319
Gilles Peskine449bd832023-01-11 14:50:10 +01001320 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls13 only."));
1321 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001322 }
1323#endif
1324
1325#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001326 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
1327 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is tls12 only."));
1328 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001329 }
1330#endif
1331
Ronald Cron6f135e12021-12-08 16:57:54 +01001332#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 if (mbedtls_ssl_conf_is_hybrid_tls12_tls13(conf)) {
1334 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1335 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS not yet supported in Hybrid TLS 1.3 + TLS 1.2"));
1336 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQianed582dd2022-04-13 08:21:05 +00001337 }
1338
Gilles Peskine449bd832023-01-11 14:50:10 +01001339 MBEDTLS_SSL_DEBUG_MSG(4, ("The SSL configuration is TLS 1.3 or TLS 1.2."));
1340 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001341 }
1342#endif
1343
Gilles Peskine449bd832023-01-11 14:50:10 +01001344 MBEDTLS_SSL_DEBUG_MSG(1, ("The SSL configuration is invalid."));
1345 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yu60835a82021-08-04 10:13:52 +08001346}
1347
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001348MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu60835a82021-08-04 10:13:52 +08001349static int ssl_conf_check(const mbedtls_ssl_context *ssl)
1350{
1351 int ret;
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 ret = ssl_conf_version_check(ssl);
1353 if (ret != 0) {
1354 return ret;
1355 }
Jerry Yu60835a82021-08-04 10:13:52 +08001356
Jerry Yudef7ae42022-10-30 14:13:19 +08001357#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1358 /* RFC 8446 section 4.4.3
1359 *
1360 * If the verification fails, the receiver MUST terminate the handshake with
1361 * a "decrypt_error" alert.
1362 *
1363 * If the client is configured as TLS 1.3 only with optional verify, return
1364 * bad config.
1365 *
1366 */
Pengyu Lv0a1ff2b2023-11-14 11:03:32 +08001367 if (mbedtls_ssl_conf_tls13_is_ephemeral_enabled(
Gilles Peskine449bd832023-01-11 14:50:10 +01001368 (mbedtls_ssl_context *) ssl) &&
Jerry Yudef7ae42022-10-30 14:13:19 +08001369 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
1370 ssl->conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1371 ssl->conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 ssl->conf->authmode == MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yudef7ae42022-10-30 14:13:19 +08001373 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001374 1, ("Optional verify auth mode "
1375 "is not available for TLS 1.3 client"));
1376 return MBEDTLS_ERR_SSL_BAD_CONFIG;
Jerry Yudef7ae42022-10-30 14:13:19 +08001377 }
1378#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1379
Yanray Wangb422cab2023-12-01 16:18:10 +08001380 if (ssl->conf->f_rng == NULL) {
1381 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1382 return MBEDTLS_ERR_SSL_NO_RNG;
1383 }
1384
Jerry Yu60835a82021-08-04 10:13:52 +08001385 /* Space for further checks */
1386
Gilles Peskine449bd832023-01-11 14:50:10 +01001387 return 0;
Jerry Yu60835a82021-08-04 10:13:52 +08001388}
1389
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001390/*
1391 * Setup an SSL context
1392 */
Hanno Becker2a43f6f2018-08-10 11:12:52 +01001393
Gilles Peskine449bd832023-01-11 14:50:10 +01001394int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1395 const mbedtls_ssl_config *conf)
Paul Bakker5121ce52009-01-03 21:22:43 +00001396{
Janos Follath865b3eb2019-12-16 11:46:15 +00001397 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Darryl Greenb33cc762019-11-28 14:29:44 +00001398 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1399 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
Paul Bakker5121ce52009-01-03 21:22:43 +00001400
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001401 ssl->conf = conf;
Paul Bakker62f2dee2012-09-28 07:31:51 +00001402
Gilles Peskine449bd832023-01-11 14:50:10 +01001403 if ((ret = ssl_conf_check(ssl)) != 0) {
1404 return ret;
1405 }
Ronald Cron8a12aee2023-03-08 15:30:43 +01001406 ssl->tls_version = ssl->conf->max_tls_version;
Jerry Yu60835a82021-08-04 10:13:52 +08001407
Paul Bakker62f2dee2012-09-28 07:31:51 +00001408 /*
Manuel Pégourié-Gonnard06193482014-02-14 08:39:32 +01001409 * Prepare base structures
Paul Bakker62f2dee2012-09-28 07:31:51 +00001410 */
k-stachowiakc9a5f022018-07-24 13:53:31 +02001411
1412 /* Set to NULL in case of an error condition */
1413 ssl->out_buf = NULL;
k-stachowiaka47911c2018-07-04 17:41:58 +02001414
Darryl Greenb33cc762019-11-28 14:29:44 +00001415#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1416 ssl->in_buf_len = in_buf_len;
1417#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 ssl->in_buf = mbedtls_calloc(1, in_buf_len);
1419 if (ssl->in_buf == NULL) {
1420 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", in_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001421 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001422 goto error;
Angus Grattond8213d02016-05-25 20:56:48 +10001423 }
1424
Darryl Greenb33cc762019-11-28 14:29:44 +00001425#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1426 ssl->out_buf_len = out_buf_len;
1427#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 ssl->out_buf = mbedtls_calloc(1, out_buf_len);
1429 if (ssl->out_buf == NULL) {
1430 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed", out_buf_len));
k-stachowiak9f7798e2018-07-31 16:52:32 +02001431 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
k-stachowiaka47911c2018-07-04 17:41:58 +02001432 goto error;
Paul Bakker5121ce52009-01-03 21:22:43 +00001433 }
1434
Gilles Peskine449bd832023-01-11 14:50:10 +01001435 mbedtls_ssl_reset_in_out_pointers(ssl);
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02001436
Johan Pascalb62bb512015-12-03 21:56:45 +01001437#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01001438 memset(&ssl->dtls_srtp_info, 0, sizeof(ssl->dtls_srtp_info));
Johan Pascalb62bb512015-12-03 21:56:45 +01001439#endif
1440
Gilles Peskine449bd832023-01-11 14:50:10 +01001441 if ((ret = ssl_handshake_init(ssl)) != 0) {
k-stachowiaka47911c2018-07-04 17:41:58 +02001442 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001443 }
Paul Bakker5121ce52009-01-03 21:22:43 +00001444
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 return 0;
k-stachowiaka47911c2018-07-04 17:41:58 +02001446
1447error:
Gilles Peskine449bd832023-01-11 14:50:10 +01001448 mbedtls_free(ssl->in_buf);
1449 mbedtls_free(ssl->out_buf);
k-stachowiaka47911c2018-07-04 17:41:58 +02001450
1451 ssl->conf = NULL;
1452
Darryl Greenb33cc762019-11-28 14:29:44 +00001453#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1454 ssl->in_buf_len = 0;
1455 ssl->out_buf_len = 0;
1456#endif
k-stachowiaka47911c2018-07-04 17:41:58 +02001457 ssl->in_buf = NULL;
1458 ssl->out_buf = NULL;
1459
1460 ssl->in_hdr = NULL;
1461 ssl->in_ctr = NULL;
1462 ssl->in_len = NULL;
1463 ssl->in_iv = NULL;
1464 ssl->in_msg = NULL;
1465
1466 ssl->out_hdr = NULL;
1467 ssl->out_ctr = NULL;
1468 ssl->out_len = NULL;
1469 ssl->out_iv = NULL;
1470 ssl->out_msg = NULL;
1471
Gilles Peskine449bd832023-01-11 14:50:10 +01001472 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00001473}
1474
1475/*
Paul Bakker7eb013f2011-10-06 12:37:39 +00001476 * Reset an initialized and used SSL context for re-use while retaining
1477 * all application-set variables, function pointers and data.
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001478 *
1479 * If partial is non-zero, keep data in the input buffer and client ID.
1480 * (Use when a DTLS client reconnects from the same port.)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001481 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001482void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1483 int partial)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001484{
Darryl Greenb33cc762019-11-28 14:29:44 +00001485#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1486 size_t in_buf_len = ssl->in_buf_len;
1487 size_t out_buf_len = ssl->out_buf_len;
1488#else
1489 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
1490 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
1491#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001492
Hanno Beckerb0302c42021-08-03 09:39:42 +01001493#if !defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE) || !defined(MBEDTLS_SSL_SRV_C)
1494 partial = 0;
Hanno Becker7e772132018-08-10 12:38:21 +01001495#endif
1496
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001497 /* Cancel any possibly running timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01001498 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001499
Gilles Peskine449bd832023-01-11 14:50:10 +01001500 mbedtls_ssl_reset_in_out_pointers(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001501
1502 /* Reset incoming message parsing */
1503 ssl->in_offt = NULL;
1504 ssl->nb_zero = 0;
1505 ssl->in_msgtype = 0;
1506 ssl->in_msglen = 0;
1507 ssl->in_hslen = 0;
1508 ssl->keep_current_message = 0;
1509 ssl->transform_in = NULL;
1510
1511#if defined(MBEDTLS_SSL_PROTO_DTLS)
1512 ssl->next_record_offset = 0;
1513 ssl->in_epoch = 0;
1514#endif
1515
1516 /* Keep current datagram if partial == 1 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001517 if (partial == 0) {
Hanno Beckerb0302c42021-08-03 09:39:42 +01001518 ssl->in_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001519 memset(ssl->in_buf, 0, in_buf_len);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001520 }
1521
Ronald Cronad8c17b2022-06-10 17:18:09 +02001522 ssl->send_alert = 0;
1523
Hanno Beckerb0302c42021-08-03 09:39:42 +01001524 /* Reset outgoing message writing */
1525 ssl->out_msgtype = 0;
1526 ssl->out_msglen = 0;
1527 ssl->out_left = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001528 memset(ssl->out_buf, 0, out_buf_len);
1529 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Hanno Beckerb0302c42021-08-03 09:39:42 +01001530 ssl->transform_out = NULL;
1531
1532#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001533 mbedtls_ssl_dtls_replay_reset(ssl);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001534#endif
1535
XiaokangQian2b01dc32022-01-21 02:53:13 +00001536#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001537 if (ssl->transform) {
1538 mbedtls_ssl_transform_free(ssl->transform);
1539 mbedtls_free(ssl->transform);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001540 ssl->transform = NULL;
1541 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001542#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1543
XiaokangQian2b01dc32022-01-21 02:53:13 +00001544#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001545 mbedtls_ssl_transform_free(ssl->transform_application);
1546 mbedtls_free(ssl->transform_application);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001547 ssl->transform_application = NULL;
1548
Gilles Peskine449bd832023-01-11 14:50:10 +01001549 if (ssl->handshake != NULL) {
Jerry Yu3d9b5902022-11-04 14:07:25 +08001550#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01001551 mbedtls_ssl_transform_free(ssl->handshake->transform_earlydata);
1552 mbedtls_free(ssl->handshake->transform_earlydata);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001553 ssl->handshake->transform_earlydata = NULL;
Jerry Yu3d9b5902022-11-04 14:07:25 +08001554#endif
XiaokangQian2b01dc32022-01-21 02:53:13 +00001555
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 mbedtls_ssl_transform_free(ssl->handshake->transform_handshake);
1557 mbedtls_free(ssl->handshake->transform_handshake);
XiaokangQian2b01dc32022-01-21 02:53:13 +00001558 ssl->handshake->transform_handshake = NULL;
1559 }
1560
XiaokangQian2b01dc32022-01-21 02:53:13 +00001561#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerb0302c42021-08-03 09:39:42 +01001562}
1563
Gilles Peskine449bd832023-01-11 14:50:10 +01001564int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial)
Hanno Beckerb0302c42021-08-03 09:39:42 +01001565{
1566 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1567
1568 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
Ronald Cron195c0bc2024-02-08 08:51:20 +01001569 ssl->tls_version = ssl->conf->max_tls_version;
Hanno Beckerb0302c42021-08-03 09:39:42 +01001570
Gilles Peskine449bd832023-01-11 14:50:10 +01001571 mbedtls_ssl_session_reset_msg_layer(ssl, partial);
Hanno Beckerb0302c42021-08-03 09:39:42 +01001572
1573 /* Reset renegotiation state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001574#if defined(MBEDTLS_SSL_RENEGOTIATION)
1575 ssl->renego_status = MBEDTLS_SSL_INITIAL_HANDSHAKE;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001576 ssl->renego_records_seen = 0;
Paul Bakker48916f92012-09-16 19:57:18 +00001577
1578 ssl->verify_data_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001579 memset(ssl->own_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
1580 memset(ssl->peer_verify_data, 0, MBEDTLS_SSL_VERIFY_DATA_MAX_LEN);
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001581#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001582 ssl->secure_renegotiation = MBEDTLS_SSL_LEGACY_RENEGOTIATION;
Paul Bakker48916f92012-09-16 19:57:18 +00001583
Hanno Beckerb0302c42021-08-03 09:39:42 +01001584 ssl->session_in = NULL;
Hanno Becker78640902018-08-13 16:35:15 +01001585 ssl->session_out = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001586 if (ssl->session) {
1587 mbedtls_ssl_session_free(ssl->session);
1588 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01001589 ssl->session = NULL;
1590 }
1591
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001592#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001593 ssl->alpn_chosen = NULL;
1594#endif
1595
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001596#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
David Horstmann3b2276a2022-10-06 14:49:08 +01001597 int free_cli_id = 1;
Hanno Becker4ccbf062018-08-10 11:20:38 +01001598#if defined(MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE)
Gilles Peskine449bd832023-01-11 14:50:10 +01001599 free_cli_id = (partial == 0);
Hanno Becker4ccbf062018-08-10 11:20:38 +01001600#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001601 if (free_cli_id) {
1602 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001603 ssl->cli_id = NULL;
1604 ssl->cli_id_len = 0;
1605 }
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001606#endif
1607
Gilles Peskine449bd832023-01-11 14:50:10 +01001608 if ((ret = ssl_handshake_init(ssl)) != 0) {
1609 return ret;
1610 }
Paul Bakker2770fbd2012-07-03 13:30:23 +00001611
Gilles Peskine449bd832023-01-11 14:50:10 +01001612 return 0;
Paul Bakker7eb013f2011-10-06 12:37:39 +00001613}
1614
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001615/*
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001616 * Reset an initialized and used SSL context for re-use while retaining
1617 * all application-set variables, function pointers and data.
1618 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001619int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001620{
Gilles Peskine449bd832023-01-11 14:50:10 +01001621 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnard3f09b6d2015-09-08 11:58:14 +02001622}
1623
1624/*
Paul Bakker5121ce52009-01-03 21:22:43 +00001625 * SSL set accessors
1626 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001627void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint)
Paul Bakker5121ce52009-01-03 21:22:43 +00001628{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001629 conf->endpoint = endpoint;
Paul Bakker5121ce52009-01-03 21:22:43 +00001630}
1631
Gilles Peskine449bd832023-01-11 14:50:10 +01001632void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport)
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001633{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001634 conf->transport = transport;
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001635}
1636
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001637#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001638void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001639{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001640 conf->anti_replay = mode;
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001641}
1642#endif
1643
Gilles Peskine449bd832023-01-11 14:50:10 +01001644void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001645{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001646 conf->badmac_limit = limit;
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001647}
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001648
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001649#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001650
Gilles Peskine449bd832023-01-11 14:50:10 +01001651void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
1652 unsigned allow_packing)
Hanno Becker04da1892018-08-14 13:22:10 +01001653{
1654 ssl->disable_datagram_packing = !allow_packing;
1655}
1656
Gilles Peskine449bd832023-01-11 14:50:10 +01001657void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf,
1658 uint32_t min, uint32_t max)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001659{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001660 conf->hs_timeout_min = min;
1661 conf->hs_timeout_max = max;
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001662}
1663#endif
1664
Gilles Peskine449bd832023-01-11 14:50:10 +01001665void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode)
Paul Bakker5121ce52009-01-03 21:22:43 +00001666{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001667 conf->authmode = authmode;
Paul Bakker5121ce52009-01-03 21:22:43 +00001668}
1669
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001670#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001671void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1672 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1673 void *p_vrfy)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001674{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001675 conf->f_vrfy = f_vrfy;
1676 conf->p_vrfy = p_vrfy;
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001677}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001678#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001679
Gilles Peskine449bd832023-01-11 14:50:10 +01001680void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1681 int (*f_rng)(void *, unsigned char *, size_t),
1682 void *p_rng)
Paul Bakker5121ce52009-01-03 21:22:43 +00001683{
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001684 conf->f_rng = f_rng;
1685 conf->p_rng = p_rng;
Paul Bakker5121ce52009-01-03 21:22:43 +00001686}
1687
Gilles Peskine449bd832023-01-11 14:50:10 +01001688void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1689 void (*f_dbg)(void *, int, const char *, int, const char *),
1690 void *p_dbg)
Paul Bakker5121ce52009-01-03 21:22:43 +00001691{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001692 conf->f_dbg = f_dbg;
1693 conf->p_dbg = p_dbg;
Paul Bakker5121ce52009-01-03 21:22:43 +00001694}
1695
Gilles Peskine449bd832023-01-11 14:50:10 +01001696void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1697 void *p_bio,
1698 mbedtls_ssl_send_t *f_send,
1699 mbedtls_ssl_recv_t *f_recv,
1700 mbedtls_ssl_recv_timeout_t *f_recv_timeout)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001701{
1702 ssl->p_bio = p_bio;
1703 ssl->f_send = f_send;
1704 ssl->f_recv = f_recv;
1705 ssl->f_recv_timeout = f_recv_timeout;
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001706}
1707
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001708#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001709void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu)
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001710{
1711 ssl->mtu = mtu;
1712}
1713#endif
1714
Gilles Peskine449bd832023-01-11 14:50:10 +01001715void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001716{
1717 conf->read_timeout = timeout;
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001718}
1719
Gilles Peskine449bd832023-01-11 14:50:10 +01001720void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
1721 void *p_timer,
1722 mbedtls_ssl_set_timer_t *f_set_timer,
1723 mbedtls_ssl_get_timer_t *f_get_timer)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001724{
1725 ssl->p_timer = p_timer;
1726 ssl->f_set_timer = f_set_timer;
1727 ssl->f_get_timer = f_get_timer;
Manuel Pégourié-Gonnard286a1362015-05-13 16:22:05 +02001728
1729 /* Make sure we start with no timer running */
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 mbedtls_ssl_set_timer(ssl, 0);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001731}
1732
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001733#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001734void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
1735 void *p_cache,
1736 mbedtls_ssl_cache_get_t *f_get_cache,
1737 mbedtls_ssl_cache_set_t *f_set_cache)
Paul Bakker5121ce52009-01-03 21:22:43 +00001738{
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001739 conf->p_cache = p_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001740 conf->f_get_cache = f_get_cache;
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001741 conf->f_set_cache = f_set_cache;
Paul Bakker5121ce52009-01-03 21:22:43 +00001742}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001743#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001744
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001745#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001746int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session)
Paul Bakker5121ce52009-01-03 21:22:43 +00001747{
Janos Follath865b3eb2019-12-16 11:46:15 +00001748 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001749
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 if (ssl == NULL ||
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001751 session == NULL ||
1752 ssl->session_negotiate == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001753 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
1754 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001755 }
1756
Gilles Peskine449bd832023-01-11 14:50:10 +01001757 if (ssl->handshake->resume == 1) {
1758 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
1759 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01001760
Jerry Yu21092062022-10-10 21:21:31 +08001761#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 if (session->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Ronald Cron233fcaa2024-04-04 14:05:21 +02001763#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu21092062022-10-10 21:21:31 +08001764 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01001765 mbedtls_ssl_ciphersuite_from_id(session->ciphersuite);
Jerry Yu21092062022-10-10 21:21:31 +08001766
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 if (mbedtls_ssl_validate_ciphersuite(
Jerry Yu21092062022-10-10 21:21:31 +08001768 ssl, ciphersuite_info, MBEDTLS_SSL_VERSION_TLS1_3,
Gilles Peskine449bd832023-01-11 14:50:10 +01001769 MBEDTLS_SSL_VERSION_TLS1_3) != 0) {
1770 MBEDTLS_SSL_DEBUG_MSG(4, ("%d is not a valid TLS 1.3 ciphersuite.",
1771 session->ciphersuite));
1772 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu21092062022-10-10 21:21:31 +08001773 }
Ronald Cron233fcaa2024-04-04 14:05:21 +02001774#else
1775 /*
1776 * If session tickets are not enabled, it is not possible to resume a
1777 * TLS 1.3 session, thus do not make any change to the SSL context in
1778 * the first place.
1779 */
1780 return 0;
1781#endif
Jerry Yu40afab62022-10-08 10:42:13 +08001782 }
Jerry Yu21092062022-10-10 21:21:31 +08001783#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu40afab62022-10-08 10:42:13 +08001784
Gilles Peskine449bd832023-01-11 14:50:10 +01001785 if ((ret = mbedtls_ssl_session_copy(ssl->session_negotiate,
1786 session)) != 0) {
1787 return ret;
1788 }
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001789
Paul Bakker0a597072012-09-25 21:55:46 +00001790 ssl->handshake->resume = 1;
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001791
Gilles Peskine449bd832023-01-11 14:50:10 +01001792 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00001793}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001794#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001795
Gilles Peskine449bd832023-01-11 14:50:10 +01001796void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
1797 const int *ciphersuites)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001798{
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001799 conf->ciphersuite_list = ciphersuites;
Paul Bakker5121ce52009-01-03 21:22:43 +00001800}
1801
Ronald Cron6f135e12021-12-08 16:57:54 +01001802#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001803void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
1804 const int kex_modes)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001805{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001806 conf->tls13_kex_modes = kex_modes & MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Hanno Becker71f1ed62021-07-24 06:01:47 +01001807}
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001808
1809#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08001810void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
1811 int early_data_enabled)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001812{
1813 conf->early_data_enabled = early_data_enabled;
1814}
Jerry Yucc4e0072022-11-22 17:22:22 +08001815
1816#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08001817void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 mbedtls_ssl_config *conf, uint32_t max_early_data_size)
Jerry Yucc4e0072022-11-22 17:22:22 +08001819{
Jerry Yu39da9852022-12-06 16:58:36 +08001820 conf->max_early_data_size = max_early_data_size;
Jerry Yucc4e0072022-11-22 17:22:22 +08001821}
1822#endif /* MBEDTLS_SSL_SRV_C */
1823
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001824#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001825#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001826
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001827#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001828void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
1829 const mbedtls_x509_crt_profile *profile)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001830{
1831 conf->cert_profile = profile;
1832}
1833
Gilles Peskine449bd832023-01-11 14:50:10 +01001834static void ssl_key_cert_free(mbedtls_ssl_key_cert *key_cert)
Glenn Strauss36872db2022-01-22 05:06:31 -05001835{
1836 mbedtls_ssl_key_cert *cur = key_cert, *next;
1837
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 while (cur != NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001839 next = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001840 mbedtls_free(cur);
Glenn Strauss36872db2022-01-22 05:06:31 -05001841 cur = next;
1842 }
1843}
1844
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001845/* Append a new keycert entry to a (possibly empty) list */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001846MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001847static int ssl_append_key_cert(mbedtls_ssl_key_cert **head,
1848 mbedtls_x509_crt *cert,
1849 mbedtls_pk_context *key)
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001850{
niisato8ee24222018-06-25 19:05:48 +09001851 mbedtls_ssl_key_cert *new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001852
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 if (cert == NULL) {
Glenn Strauss36872db2022-01-22 05:06:31 -05001854 /* Free list if cert is null */
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 ssl_key_cert_free(*head);
Glenn Strauss36872db2022-01-22 05:06:31 -05001856 *head = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 return 0;
Glenn Strauss36872db2022-01-22 05:06:31 -05001858 }
1859
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 new_cert = mbedtls_calloc(1, sizeof(mbedtls_ssl_key_cert));
1861 if (new_cert == NULL) {
1862 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
1863 }
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001864
niisato8ee24222018-06-25 19:05:48 +09001865 new_cert->cert = cert;
1866 new_cert->key = key;
1867 new_cert->next = NULL;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001868
Glenn Strauss36872db2022-01-22 05:06:31 -05001869 /* Update head if the list was null, else add to the end */
Gilles Peskine449bd832023-01-11 14:50:10 +01001870 if (*head == NULL) {
niisato8ee24222018-06-25 19:05:48 +09001871 *head = new_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001872 } else {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001873 mbedtls_ssl_key_cert *cur = *head;
Gilles Peskine449bd832023-01-11 14:50:10 +01001874 while (cur->next != NULL) {
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001875 cur = cur->next;
Gilles Peskine449bd832023-01-11 14:50:10 +01001876 }
niisato8ee24222018-06-25 19:05:48 +09001877 cur->next = new_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001878 }
1879
Gilles Peskine449bd832023-01-11 14:50:10 +01001880 return 0;
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001881}
1882
Gilles Peskine449bd832023-01-11 14:50:10 +01001883int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001884 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01001885 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001886{
Gilles Peskine449bd832023-01-11 14:50:10 +01001887 return ssl_append_key_cert(&conf->key_cert, own_cert, pk_key);
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001888}
1889
Gilles Peskine449bd832023-01-11 14:50:10 +01001890void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001891 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01001892 mbedtls_x509_crl *ca_crl)
Paul Bakker5121ce52009-01-03 21:22:43 +00001893{
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001894 conf->ca_chain = ca_chain;
1895 conf->ca_crl = ca_crl;
Hanno Becker5adaad92019-03-27 16:54:37 +00001896
1897#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1898 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1899 * cannot be used together. */
1900 conf->f_ca_cb = NULL;
1901 conf->p_ca_cb = NULL;
1902#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Paul Bakker5121ce52009-01-03 21:22:43 +00001903}
Hanno Becker5adaad92019-03-27 16:54:37 +00001904
1905#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01001906void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
1907 mbedtls_x509_crt_ca_cb_t f_ca_cb,
1908 void *p_ca_cb)
Hanno Becker5adaad92019-03-27 16:54:37 +00001909{
1910 conf->f_ca_cb = f_ca_cb;
1911 conf->p_ca_cb = p_ca_cb;
1912
1913 /* mbedtls_ssl_conf_ca_chain() and mbedtls_ssl_conf_ca_cb()
1914 * cannot be used together. */
1915 conf->ca_chain = NULL;
1916 conf->ca_crl = NULL;
1917}
1918#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001919#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +00001920
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001921#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001922const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
1923 size_t *name_len)
Glenn Strauss69894072022-01-24 12:58:00 -05001924{
1925 *name_len = ssl->handshake->sni_name_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001926 return ssl->handshake->sni_name;
Glenn Strauss69894072022-01-24 12:58:00 -05001927}
1928
Gilles Peskine449bd832023-01-11 14:50:10 +01001929int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
1930 mbedtls_x509_crt *own_cert,
1931 mbedtls_pk_context *pk_key)
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001932{
Gilles Peskine449bd832023-01-11 14:50:10 +01001933 return ssl_append_key_cert(&ssl->handshake->sni_key_cert,
1934 own_cert, pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001935}
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001936
Gilles Peskine449bd832023-01-11 14:50:10 +01001937void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
1938 mbedtls_x509_crt *ca_chain,
1939 mbedtls_x509_crl *ca_crl)
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001940{
1941 ssl->handshake->sni_ca_chain = ca_chain;
1942 ssl->handshake->sni_ca_crl = ca_crl;
1943}
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001944
Glenn Strauss999ef702022-03-11 01:37:23 -05001945#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001946void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
1947 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05001948{
1949 ssl->handshake->dn_hints = crt;
1950}
1951#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
1952
Gilles Peskine449bd832023-01-11 14:50:10 +01001953void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
1954 int authmode)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001955{
1956 ssl->handshake->sni_authmode = authmode;
1957}
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001958#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1959
Hanno Becker8927c832019-04-03 12:52:50 +01001960#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001961void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1962 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1963 void *p_vrfy)
Hanno Becker8927c832019-04-03 12:52:50 +01001964{
1965 ssl->f_vrfy = f_vrfy;
1966 ssl->p_vrfy = p_vrfy;
1967}
1968#endif
1969
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001970#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001971
Valerio Setti016f6822022-12-09 14:17:50 +01001972#if defined(MBEDTLS_USE_PSA_CRYPTO)
Przemek Stekielfde11282023-03-13 16:06:09 +01001973static const uint8_t jpake_server_id[] = { 's', 'e', 'r', 'v', 'e', 'r' };
1974static const uint8_t jpake_client_id[] = { 'c', 'l', 'i', 'e', 'n', 't' };
1975
Valerio Setti016f6822022-12-09 14:17:50 +01001976static psa_status_t mbedtls_ssl_set_hs_ecjpake_password_common(
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 mbedtls_ssl_context *ssl,
1978 mbedtls_svc_key_id_t pwd)
Valerio Setti016f6822022-12-09 14:17:50 +01001979{
1980 psa_status_t status;
Valerio Setti016f6822022-12-09 14:17:50 +01001981 psa_pake_cipher_suite_t cipher_suite = psa_pake_cipher_suite_init();
Przemek Stekielfde11282023-03-13 16:06:09 +01001982 const uint8_t *user = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001983 size_t user_len = 0;
Przemek Stekielfde11282023-03-13 16:06:09 +01001984 const uint8_t *peer = NULL;
Przemek Stekiel4cd20312023-03-01 11:11:28 +01001985 size_t peer_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 psa_pake_cs_set_algorithm(&cipher_suite, PSA_ALG_JPAKE);
1987 psa_pake_cs_set_primitive(&cipher_suite,
1988 PSA_PAKE_PRIMITIVE(PSA_PAKE_PRIMITIVE_TYPE_ECC,
1989 PSA_ECC_FAMILY_SECP_R1,
1990 256));
1991 psa_pake_cs_set_hash(&cipher_suite, PSA_ALG_SHA_256);
Valerio Setti016f6822022-12-09 14:17:50 +01001992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 status = psa_pake_setup(&ssl->handshake->psa_pake_ctx, &cipher_suite);
1994 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01001995 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001997
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Przemek Stekielfde11282023-03-13 16:06:09 +01001999 user = jpake_server_id;
2000 user_len = sizeof(jpake_server_id);
2001 peer = jpake_client_id;
2002 peer_len = sizeof(jpake_client_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 } else {
Przemek Stekielfde11282023-03-13 16:06:09 +01002004 user = jpake_client_id;
2005 user_len = sizeof(jpake_client_id);
2006 peer = jpake_server_id;
2007 peer_len = sizeof(jpake_server_id);
Gilles Peskine449bd832023-01-11 14:50:10 +01002008 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02002009
Przemek Stekiel4cd20312023-03-01 11:11:28 +01002010 status = psa_pake_set_user(&ssl->handshake->psa_pake_ctx, user, user_len);
2011 if (status != PSA_SUCCESS) {
2012 return status;
2013 }
2014
2015 status = psa_pake_set_peer(&ssl->handshake->psa_pake_ctx, peer, peer_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01002017 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002018 }
Valerio Setti016f6822022-12-09 14:17:50 +01002019
Gilles Peskine449bd832023-01-11 14:50:10 +01002020 status = psa_pake_set_password_key(&ssl->handshake->psa_pake_ctx, pwd);
2021 if (status != PSA_SUCCESS) {
Valerio Setti016f6822022-12-09 14:17:50 +01002022 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002023 }
Valerio Setti016f6822022-12-09 14:17:50 +01002024
2025 ssl->handshake->psa_pake_ctx_is_ok = 1;
2026
Gilles Peskine449bd832023-01-11 14:50:10 +01002027 return PSA_SUCCESS;
Valerio Setti016f6822022-12-09 14:17:50 +01002028}
2029
Gilles Peskine449bd832023-01-11 14:50:10 +01002030int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2031 const unsigned char *pw,
2032 size_t pw_len)
Valerio Setti016f6822022-12-09 14:17:50 +01002033{
2034 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
2035 psa_status_t status;
2036
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 if (ssl->handshake == NULL || ssl->conf == NULL) {
2038 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002039 }
2040
Gilles Peskine449bd832023-01-11 14:50:10 +01002041 /* Empty password is not valid */
2042 if ((pw == NULL) || (pw_len == 0)) {
2043 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2044 }
2045
2046 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DERIVE);
2047 psa_set_key_algorithm(&attributes, PSA_ALG_JPAKE);
2048 psa_set_key_type(&attributes, PSA_KEY_TYPE_PASSWORD);
2049
2050 status = psa_import_key(&attributes, pw, pw_len,
2051 &ssl->handshake->psa_pake_password);
2052 if (status != PSA_SUCCESS) {
2053 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2054 }
2055
2056 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl,
2057 ssl->handshake->psa_pake_password);
2058 if (status != PSA_SUCCESS) {
2059 psa_destroy_key(ssl->handshake->psa_pake_password);
2060 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2061 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2062 }
2063
2064 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002065}
Valerio Settia9a97dc2022-11-28 18:26:16 +01002066
Gilles Peskine449bd832023-01-11 14:50:10 +01002067int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
2068 mbedtls_svc_key_id_t pwd)
Valerio Settia9a97dc2022-11-28 18:26:16 +01002069{
Valerio Settia9a97dc2022-11-28 18:26:16 +01002070 psa_status_t status;
2071
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 if (ssl->handshake == NULL || ssl->conf == NULL) {
2073 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstrongca7d5062022-05-31 14:43:23 +02002074 }
2075
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 if (mbedtls_svc_key_id_is_null(pwd)) {
2077 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2078 }
2079
2080 status = mbedtls_ssl_set_hs_ecjpake_password_common(ssl, pwd);
2081 if (status != PSA_SUCCESS) {
2082 psa_pake_abort(&ssl->handshake->psa_pake_ctx);
2083 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2084 }
2085
2086 return 0;
Valerio Setti02c25b52022-11-15 14:08:42 +01002087}
2088#else /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002089int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
2090 const unsigned char *pw,
2091 size_t pw_len)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002092{
2093 mbedtls_ecjpake_role role;
2094
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 if (ssl->handshake == NULL || ssl->conf == NULL) {
2096 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2097 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002098
Valerio Settic689ed82022-12-07 14:40:38 +01002099 /* Empty password is not valid */
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 if ((pw == NULL) || (pw_len == 0)) {
2101 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2102 }
Valerio Settic689ed82022-12-07 14:40:38 +01002103
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002105 role = MBEDTLS_ECJPAKE_SERVER;
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 } else {
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002107 role = MBEDTLS_ECJPAKE_CLIENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 }
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002109
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 return mbedtls_ecjpake_setup(&ssl->handshake->ecjpake_ctx,
2111 role,
2112 MBEDTLS_MD_SHA256,
2113 MBEDTLS_ECP_DP_SECP256R1,
2114 pw, pw_len);
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002115}
Valerio Setti02c25b52022-11-15 14:08:42 +01002116#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002117#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002118
Ronald Cron73fe8df2022-10-05 14:31:43 +02002119#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002120int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf)
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002121{
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 if (conf->psk_identity == NULL ||
2123 conf->psk_identity_len == 0) {
2124 return 0;
Ronald Crond29e13e2022-10-19 10:33:48 +02002125 }
2126
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002127#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
2129 return 1;
2130 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002131#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Crond29e13e2022-10-19 10:33:48 +02002132
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 if (conf->psk != NULL && conf->psk_len != 0) {
2134 return 1;
2135 }
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002136
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 return 0;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002138}
2139
Gilles Peskine449bd832023-01-11 14:50:10 +01002140static void ssl_conf_remove_psk(mbedtls_ssl_config *conf)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002141{
2142 /* Remove reference to existing PSK, if any. */
2143#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002145 /* The maintenance of the PSK key slot is the
2146 * user's responsibility. */
Ronald Croncf56a0a2020-08-04 09:51:30 +02002147 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002148 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002149#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002151 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002152 conf->psk = NULL;
2153 conf->psk_len = 0;
2154 }
2155
2156 /* Remove reference to PSK identity, if any. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 if (conf->psk_identity != NULL) {
2158 mbedtls_free(conf->psk_identity);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002159 conf->psk_identity = NULL;
2160 conf->psk_identity_len = 0;
2161 }
2162}
2163
Hanno Becker7390c712018-11-15 13:33:04 +00002164/* This function assumes that PSK identity in the SSL config is unset.
2165 * It checks that the provided identity is well-formed and attempts
2166 * to make a copy of it in the SSL config.
2167 * On failure, the PSK identity in the config remains unset. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002168MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002169static int ssl_conf_set_psk_identity(mbedtls_ssl_config *conf,
2170 unsigned char const *psk_identity,
2171 size_t psk_identity_len)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002172{
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002173 /* Identity len will be encoded on two bytes */
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 if (psk_identity == NULL ||
Ronald Cron2a87e9b2022-10-19 10:55:26 +02002175 psk_identity_len == 0 ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 (psk_identity_len >> 16) != 0 ||
2177 psk_identity_len > MBEDTLS_SSL_OUT_CONTENT_LEN) {
2178 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardc6b5d832015-08-27 16:37:35 +02002179 }
2180
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 conf->psk_identity = mbedtls_calloc(1, psk_identity_len);
2182 if (conf->psk_identity == NULL) {
2183 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2184 }
Paul Bakker6db455e2013-09-18 17:29:31 +02002185
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002186 conf->psk_identity_len = psk_identity_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002187 memcpy(conf->psk_identity, psk_identity, conf->psk_identity_len);
Paul Bakker5ad403f2013-09-18 21:21:30 +02002188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 return 0;
Paul Bakker6db455e2013-09-18 17:29:31 +02002190}
2191
Gilles Peskine449bd832023-01-11 14:50:10 +01002192int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2193 const unsigned char *psk, size_t psk_len,
2194 const unsigned char *psk_identity, size_t psk_identity_len)
Hanno Becker7390c712018-11-15 13:33:04 +00002195{
Janos Follath865b3eb2019-12-16 11:46:15 +00002196 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002197
2198 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2200 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2201 }
Hanno Becker7390c712018-11-15 13:33:04 +00002202
2203 /* Check and set raw PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 if (psk == NULL) {
2205 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2206 }
2207 if (psk_len == 0) {
2208 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2209 }
2210 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2211 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2212 }
Piotr Nowicki9926eaf2019-11-20 14:54:36 +01002213
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 if ((conf->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2215 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2216 }
Hanno Becker7390c712018-11-15 13:33:04 +00002217 conf->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 memcpy(conf->psk, psk, conf->psk_len);
Hanno Becker7390c712018-11-15 13:33:04 +00002219
2220 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002221 ret = ssl_conf_set_psk_identity(conf, psk_identity, psk_identity_len);
2222 if (ret != 0) {
2223 ssl_conf_remove_psk(conf);
2224 }
Hanno Becker7390c712018-11-15 13:33:04 +00002225
Gilles Peskine449bd832023-01-11 14:50:10 +01002226 return ret;
Hanno Becker7390c712018-11-15 13:33:04 +00002227}
2228
Gilles Peskine449bd832023-01-11 14:50:10 +01002229static void ssl_remove_psk(mbedtls_ssl_context *ssl)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002230{
2231#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02002233 /* The maintenance of the external PSK key slot is the
2234 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 if (ssl->handshake->psk_opaque_is_internal) {
2236 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02002237 ssl->handshake->psk_opaque_is_internal = 0;
2238 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002239 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002240 }
Neil Armstronge952a302022-05-03 10:22:14 +02002241#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002242 if (ssl->handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002243 mbedtls_zeroize_and_free(ssl->handshake->psk,
Gilles Peskine449bd832023-01-11 14:50:10 +01002244 ssl->handshake->psk_len);
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002245 ssl->handshake->psk_len = 0;
lhuang0454adeab2024-06-10 12:16:29 -07002246 ssl->handshake->psk = NULL;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002247 }
Neil Armstronge952a302022-05-03 10:22:14 +02002248#endif /* MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002249}
2250
Gilles Peskine449bd832023-01-11 14:50:10 +01002251int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2252 const unsigned char *psk, size_t psk_len)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002253{
Neil Armstrong501c9322022-05-03 09:35:09 +02002254#if defined(MBEDTLS_USE_PSA_CRYPTO)
2255 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Jerry Yu5d01c052022-08-17 10:18:10 +08002256 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Jerry Yu24b8c812022-08-20 19:06:56 +08002257 psa_algorithm_t alg = PSA_ALG_NONE;
Jerry Yu5d01c052022-08-17 10:18:10 +08002258 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong501c9322022-05-03 09:35:09 +02002259#endif /* MBEDTLS_USE_PSA_CRYPTO */
2260
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 if (psk == NULL || ssl->handshake == NULL) {
2262 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2263 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002264
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 if (psk_len > MBEDTLS_PSK_MAX_LEN) {
2266 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2267 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002268
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 ssl_remove_psk(ssl);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002270
Neil Armstrong501c9322022-05-03 09:35:09 +02002271#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yuccc68a42022-07-26 16:39:20 +08002272#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2274 if (ssl->handshake->ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
2275 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
2276 } else {
2277 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
2278 }
2279 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
Jerry Yuccc68a42022-07-26 16:39:20 +08002280 }
2281#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Neil Armstrong501c9322022-05-03 09:35:09 +02002282
Jerry Yu568ec252022-07-22 21:27:34 +08002283#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2285 alg = PSA_ALG_HKDF_EXTRACT(PSA_ALG_ANY_HASH);
2286 psa_set_key_usage_flags(&key_attributes,
2287 PSA_KEY_USAGE_DERIVE | PSA_KEY_USAGE_EXPORT);
Jerry Yuccc68a42022-07-26 16:39:20 +08002288 }
2289#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2290
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 psa_set_key_algorithm(&key_attributes, alg);
2292 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Neil Armstrong501c9322022-05-03 09:35:09 +02002293
Gilles Peskine449bd832023-01-11 14:50:10 +01002294 status = psa_import_key(&key_attributes, psk, psk_len, &key);
2295 if (status != PSA_SUCCESS) {
2296 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
2297 }
Neil Armstrong501c9322022-05-03 09:35:09 +02002298
2299 /* Allow calling psa_destroy_key() on psk remove */
2300 ssl->handshake->psk_opaque_is_internal = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 return mbedtls_ssl_set_hs_psk_opaque(ssl, key);
Neil Armstrong501c9322022-05-03 09:35:09 +02002302#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 if ((ssl->handshake->psk = mbedtls_calloc(1, psk_len)) == NULL) {
2304 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2305 }
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002306
2307 ssl->handshake->psk_len = psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 memcpy(ssl->handshake->psk, psk, ssl->handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002309
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 return 0;
Neil Armstrong501c9322022-05-03 09:35:09 +02002311#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002312}
2313
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002314#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002315int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2316 mbedtls_svc_key_id_t psk,
2317 const unsigned char *psk_identity,
2318 size_t psk_identity_len)
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002319{
Janos Follath865b3eb2019-12-16 11:46:15 +00002320 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Becker2ed3dce2021-04-19 21:59:14 +01002321
2322 /* We currently only support one PSK, raw or opaque. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 if (mbedtls_ssl_conf_has_static_psk(conf)) {
2324 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2325 }
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002326
Hanno Becker7390c712018-11-15 13:33:04 +00002327 /* Check and set opaque PSK */
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 if (mbedtls_svc_key_id_is_null(psk)) {
2329 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2330 }
Ronald Croncf56a0a2020-08-04 09:51:30 +02002331 conf->psk_opaque = psk;
Hanno Becker7390c712018-11-15 13:33:04 +00002332
2333 /* Check and set PSK Identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01002334 ret = ssl_conf_set_psk_identity(conf, psk_identity,
2335 psk_identity_len);
2336 if (ret != 0) {
2337 ssl_conf_remove_psk(conf);
2338 }
Hanno Becker7390c712018-11-15 13:33:04 +00002339
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 return ret;
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002341}
2342
Gilles Peskine449bd832023-01-11 14:50:10 +01002343int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2344 mbedtls_svc_key_id_t psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002345{
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 if ((mbedtls_svc_key_id_is_null(psk)) ||
2347 (ssl->handshake == NULL)) {
2348 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2349 }
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002350
Gilles Peskine449bd832023-01-11 14:50:10 +01002351 ssl_remove_psk(ssl);
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002352 ssl->handshake->psk_opaque = psk;
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 return 0;
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002354}
2355#endif /* MBEDTLS_USE_PSA_CRYPTO */
2356
Jerry Yu8897c072022-08-12 13:56:53 +08002357#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002358void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
2359 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
2360 size_t),
2361 void *p_psk)
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002362{
2363 conf->f_psk = f_psk;
2364 conf->p_psk = p_psk;
2365}
Jerry Yu8897c072022-08-12 13:56:53 +08002366#endif /* MBEDTLS_SSL_SRV_C */
2367
Ronald Cron73fe8df2022-10-05 14:31:43 +02002368#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Przemyslaw Stekiel6928a512022-02-03 13:50:35 +01002369
2370#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine301711e2022-04-26 16:57:05 +02002371static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 psa_algorithm_t alg)
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002373{
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002374#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 if (alg == PSA_ALG_CBC_NO_PADDING) {
2376 return MBEDTLS_SSL_MODE_CBC;
2377 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002378#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 if (PSA_ALG_IS_AEAD(alg)) {
2380 return MBEDTLS_SSL_MODE_AEAD;
2381 }
2382 return MBEDTLS_SSL_MODE_STREAM;
Gilles Peskine301711e2022-04-26 16:57:05 +02002383}
2384
2385#else /* MBEDTLS_USE_PSA_CRYPTO */
2386
2387static mbedtls_ssl_mode_t mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 mbedtls_cipher_mode_t mode)
Gilles Peskine301711e2022-04-26 16:57:05 +02002389{
2390#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 if (mode == MBEDTLS_MODE_CBC) {
2392 return MBEDTLS_SSL_MODE_CBC;
2393 }
Gilles Peskine301711e2022-04-26 16:57:05 +02002394#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
2395
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002396#if defined(MBEDTLS_GCM_C) || \
2397 defined(MBEDTLS_CCM_C) || \
2398 defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 if (mode == MBEDTLS_MODE_GCM ||
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002400 mode == MBEDTLS_MODE_CCM ||
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 mode == MBEDTLS_MODE_CHACHAPOLY) {
2402 return MBEDTLS_SSL_MODE_AEAD;
2403 }
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002404#endif /* MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002405
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 return MBEDTLS_SSL_MODE_STREAM;
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002407}
Gilles Peskine301711e2022-04-26 16:57:05 +02002408#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002409
Gilles Peskinee108d982022-04-26 16:50:40 +02002410static mbedtls_ssl_mode_t mbedtls_ssl_get_actual_mode(
2411 mbedtls_ssl_mode_t base_mode,
Gilles Peskine449bd832023-01-11 14:50:10 +01002412 int encrypt_then_mac)
Gilles Peskinee108d982022-04-26 16:50:40 +02002413{
2414#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 if (encrypt_then_mac == MBEDTLS_SSL_ETM_ENABLED &&
2416 base_mode == MBEDTLS_SSL_MODE_CBC) {
2417 return MBEDTLS_SSL_MODE_CBC_ETM;
Gilles Peskinee108d982022-04-26 16:50:40 +02002418 }
2419#else
2420 (void) encrypt_then_mac;
2421#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 return base_mode;
Gilles Peskinee108d982022-04-26 16:50:40 +02002423}
2424
Neil Armstrongab555e02022-04-04 11:07:59 +02002425mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 const mbedtls_ssl_transform *transform)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002427{
Gilles Peskinee108d982022-04-26 16:50:40 +02002428 mbedtls_ssl_mode_t base_mode = mbedtls_ssl_get_base_mode(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002429#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 transform->psa_alg
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002431#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 mbedtls_cipher_get_cipher_mode(&transform->cipher_ctx_enc)
Gilles Peskinee108d982022-04-26 16:50:40 +02002433#endif
2434 );
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002435
Gilles Peskinee108d982022-04-26 16:50:40 +02002436 int encrypt_then_mac = 0;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002437#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskinee108d982022-04-26 16:50:40 +02002438 encrypt_then_mac = transform->encrypt_then_mac;
2439#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002441}
2442
Neil Armstrongab555e02022-04-04 11:07:59 +02002443mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002444#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01002445 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002446#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 const mbedtls_ssl_ciphersuite_t *suite)
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002448{
Gilles Peskinee108d982022-04-26 16:50:40 +02002449 mbedtls_ssl_mode_t base_mode = MBEDTLS_SSL_MODE_STREAM;
2450
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002451#if defined(MBEDTLS_USE_PSA_CRYPTO)
2452 psa_status_t status;
2453 psa_algorithm_t alg;
2454 psa_key_type_t type;
2455 size_t size;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002456 status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) suite->cipher,
2457 0, &alg, &type, &size);
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 if (status == PSA_SUCCESS) {
2459 base_mode = mbedtls_ssl_get_base_mode(alg);
2460 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002461#else
2462 const mbedtls_cipher_info_t *cipher =
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002463 mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) suite->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 if (cipher != NULL) {
Gilles Peskinee108d982022-04-26 16:50:40 +02002465 base_mode =
2466 mbedtls_ssl_get_base_mode(
Gilles Peskine449bd832023-01-11 14:50:10 +01002467 mbedtls_cipher_info_get_mode(cipher));
Gilles Peskinee108d982022-04-26 16:50:40 +02002468 }
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002469#endif /* MBEDTLS_USE_PSA_CRYPTO */
2470
Gilles Peskinee108d982022-04-26 16:50:40 +02002471#if !defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
2472 int encrypt_then_mac = 0;
2473#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 return mbedtls_ssl_get_actual_mode(base_mode, encrypt_then_mac);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002475}
2476
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002477#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu251a12e2022-07-13 15:15:48 +08002478
Gilles Peskine449bd832023-01-11 14:50:10 +01002479psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2480 size_t taglen,
2481 psa_algorithm_t *alg,
2482 psa_key_type_t *key_type,
2483 size_t *key_size)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002484{
Elena Uziunaitec2561722024-07-05 11:37:33 +01002485#if !defined(PSA_WANT_ALG_CCM)
Yanray Wang19e4dc82023-11-16 18:02:05 +08002486 (void) taglen;
2487#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002488 switch (mbedtls_cipher_type) {
Elena Uziunaite74342c72024-07-05 11:31:29 +01002489#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002490 case MBEDTLS_CIPHER_AES_128_CBC:
2491 *alg = PSA_ALG_CBC_NO_PADDING;
2492 *key_type = PSA_KEY_TYPE_AES;
2493 *key_size = 128;
2494 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002495#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002496#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002497 case MBEDTLS_CIPHER_AES_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002498 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002499 *key_type = PSA_KEY_TYPE_AES;
2500 *key_size = 128;
2501 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002502#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002503#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002504 case MBEDTLS_CIPHER_AES_128_GCM:
2505 *alg = PSA_ALG_GCM;
2506 *key_type = PSA_KEY_TYPE_AES;
2507 *key_size = 128;
2508 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002509#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002510#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002511 case MBEDTLS_CIPHER_AES_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002513 *key_type = PSA_KEY_TYPE_AES;
2514 *key_size = 192;
2515 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002516#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002517#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002518 case MBEDTLS_CIPHER_AES_192_GCM:
2519 *alg = PSA_ALG_GCM;
2520 *key_type = PSA_KEY_TYPE_AES;
2521 *key_size = 192;
2522 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002523#endif
Elena Uziunaite74342c72024-07-05 11:31:29 +01002524#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002525 case MBEDTLS_CIPHER_AES_256_CBC:
2526 *alg = PSA_ALG_CBC_NO_PADDING;
2527 *key_type = PSA_KEY_TYPE_AES;
2528 *key_size = 256;
2529 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002530#endif
Elena Uziunaitec2561722024-07-05 11:37:33 +01002531#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002532 case MBEDTLS_CIPHER_AES_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002533 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002534 *key_type = PSA_KEY_TYPE_AES;
2535 *key_size = 256;
2536 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002537#endif
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +01002538#if defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002539 case MBEDTLS_CIPHER_AES_256_GCM:
2540 *alg = PSA_ALG_GCM;
2541 *key_type = PSA_KEY_TYPE_AES;
2542 *key_size = 256;
2543 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002544#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002545#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002546 case MBEDTLS_CIPHER_ARIA_128_CBC:
2547 *alg = PSA_ALG_CBC_NO_PADDING;
2548 *key_type = PSA_KEY_TYPE_ARIA;
2549 *key_size = 128;
2550 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002551#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002552#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002553 case MBEDTLS_CIPHER_ARIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002555 *key_type = PSA_KEY_TYPE_ARIA;
2556 *key_size = 128;
2557 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002558#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002559#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002560 case MBEDTLS_CIPHER_ARIA_128_GCM:
2561 *alg = PSA_ALG_GCM;
2562 *key_type = PSA_KEY_TYPE_ARIA;
2563 *key_size = 128;
2564 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002565#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002566#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002567 case MBEDTLS_CIPHER_ARIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002569 *key_type = PSA_KEY_TYPE_ARIA;
2570 *key_size = 192;
2571 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002572#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002573#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002574 case MBEDTLS_CIPHER_ARIA_192_GCM:
2575 *alg = PSA_ALG_GCM;
2576 *key_type = PSA_KEY_TYPE_ARIA;
2577 *key_size = 192;
2578 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002579#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002580#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002581 case MBEDTLS_CIPHER_ARIA_256_CBC:
2582 *alg = PSA_ALG_CBC_NO_PADDING;
2583 *key_type = PSA_KEY_TYPE_ARIA;
2584 *key_size = 256;
2585 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002586#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002587#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002588 case MBEDTLS_CIPHER_ARIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002590 *key_type = PSA_KEY_TYPE_ARIA;
2591 *key_size = 256;
2592 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002593#endif
Elena Uziunaite51c85a02024-07-05 11:20:17 +01002594#if defined(PSA_WANT_KEY_TYPE_ARIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002595 case MBEDTLS_CIPHER_ARIA_256_GCM:
2596 *alg = PSA_ALG_GCM;
2597 *key_type = PSA_KEY_TYPE_ARIA;
2598 *key_size = 256;
2599 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002600#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002601#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002602 case MBEDTLS_CIPHER_CAMELLIA_128_CBC:
2603 *alg = PSA_ALG_CBC_NO_PADDING;
2604 *key_type = PSA_KEY_TYPE_CAMELLIA;
2605 *key_size = 128;
2606 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002607#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002608#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002609 case MBEDTLS_CIPHER_CAMELLIA_128_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002611 *key_type = PSA_KEY_TYPE_CAMELLIA;
2612 *key_size = 128;
2613 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002614#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002615#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002616 case MBEDTLS_CIPHER_CAMELLIA_128_GCM:
2617 *alg = PSA_ALG_GCM;
2618 *key_type = PSA_KEY_TYPE_CAMELLIA;
2619 *key_size = 128;
2620 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002621#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002622#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002623 case MBEDTLS_CIPHER_CAMELLIA_192_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002624 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002625 *key_type = PSA_KEY_TYPE_CAMELLIA;
2626 *key_size = 192;
2627 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002628#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002629#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002630 case MBEDTLS_CIPHER_CAMELLIA_192_GCM:
2631 *alg = PSA_ALG_GCM;
2632 *key_type = PSA_KEY_TYPE_CAMELLIA;
2633 *key_size = 192;
2634 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002635#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002636#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CBC_NO_PADDING)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002637 case MBEDTLS_CIPHER_CAMELLIA_256_CBC:
2638 *alg = PSA_ALG_CBC_NO_PADDING;
2639 *key_type = PSA_KEY_TYPE_CAMELLIA;
2640 *key_size = 256;
2641 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002642#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002643#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002644 case MBEDTLS_CIPHER_CAMELLIA_256_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 *alg = taglen ? PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen) : PSA_ALG_CCM;
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002646 *key_type = PSA_KEY_TYPE_CAMELLIA;
2647 *key_size = 256;
2648 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002649#endif
Elena Uziunaiteda41b602024-07-05 11:27:21 +01002650#if defined(PSA_WANT_KEY_TYPE_CAMELLIA) && defined(PSA_WANT_ALG_GCM)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002651 case MBEDTLS_CIPHER_CAMELLIA_256_GCM:
2652 *alg = PSA_ALG_GCM;
2653 *key_type = PSA_KEY_TYPE_CAMELLIA;
2654 *key_size = 256;
2655 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002656#endif
Elena Uziunaite5c70c302024-07-05 11:44:44 +01002657#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002658 case MBEDTLS_CIPHER_CHACHA20_POLY1305:
2659 *alg = PSA_ALG_CHACHA20_POLY1305;
2660 *key_type = PSA_KEY_TYPE_CHACHA20;
2661 *key_size = 256;
2662 break;
Yanray Wang1a369d62023-11-16 15:17:31 +08002663#endif
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01002664 case MBEDTLS_CIPHER_NULL:
2665 *alg = MBEDTLS_SSL_NULL_CIPHER;
2666 *key_type = 0;
2667 *key_size = 0;
2668 break;
2669 default:
2670 return PSA_ERROR_NOT_SUPPORTED;
2671 }
2672
2673 return PSA_SUCCESS;
2674}
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002675#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Beckerd20a8ca2018-10-22 15:31:26 +01002676
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002677#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002678int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
2679 const unsigned char *dhm_P, size_t P_len,
2680 const unsigned char *dhm_G, size_t G_len)
Hanno Beckera90658f2017-10-04 15:29:08 +01002681{
Janos Follath865b3eb2019-12-16 11:46:15 +00002682 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Hanno Beckera90658f2017-10-04 15:29:08 +01002683
Gilles Peskine449bd832023-01-11 14:50:10 +01002684 mbedtls_mpi_free(&conf->dhm_P);
2685 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002686
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 if ((ret = mbedtls_mpi_read_binary(&conf->dhm_P, dhm_P, P_len)) != 0 ||
2688 (ret = mbedtls_mpi_read_binary(&conf->dhm_G, dhm_G, G_len)) != 0) {
2689 mbedtls_mpi_free(&conf->dhm_P);
2690 mbedtls_mpi_free(&conf->dhm_G);
2691 return ret;
Hanno Beckera90658f2017-10-04 15:29:08 +01002692 }
2693
Gilles Peskine449bd832023-01-11 14:50:10 +01002694 return 0;
Hanno Beckera90658f2017-10-04 15:29:08 +01002695}
Paul Bakker5121ce52009-01-03 21:22:43 +00002696
Gilles Peskine449bd832023-01-11 14:50:10 +01002697int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx)
Paul Bakker1b57b062011-01-06 15:48:19 +00002698{
Janos Follath865b3eb2019-12-16 11:46:15 +00002699 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker1b57b062011-01-06 15:48:19 +00002700
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 mbedtls_mpi_free(&conf->dhm_P);
2702 mbedtls_mpi_free(&conf->dhm_G);
Glenn Strausscee11292021-12-20 01:43:17 -05002703
Gilles Peskine449bd832023-01-11 14:50:10 +01002704 if ((ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_P,
2705 &conf->dhm_P)) != 0 ||
2706 (ret = mbedtls_dhm_get_value(dhm_ctx, MBEDTLS_DHM_PARAM_G,
2707 &conf->dhm_G)) != 0) {
2708 mbedtls_mpi_free(&conf->dhm_P);
2709 mbedtls_mpi_free(&conf->dhm_G);
2710 return ret;
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002711 }
Paul Bakker1b57b062011-01-06 15:48:19 +00002712
Gilles Peskine449bd832023-01-11 14:50:10 +01002713 return 0;
Paul Bakker1b57b062011-01-06 15:48:19 +00002714}
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002715#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_SRV_C */
Paul Bakker1b57b062011-01-06 15:48:19 +00002716
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002717#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2718/*
2719 * Set the minimum length for Diffie-Hellman parameters
2720 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002721void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
2722 unsigned int bitlen)
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002723{
2724 conf->dhm_min_bitlen = bitlen;
2725}
2726#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2727
Ronald Crone68ab4f2022-10-05 12:46:29 +02002728#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002729#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002730/*
2731 * Set allowed/preferred hashes for handshake signatures
2732 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002733void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
2734 const int *hashes)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002735{
2736 conf->sig_hashes = hashes;
2737}
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002738#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01002739
Jerry Yuf017ee42022-01-12 15:49:48 +08002740/* Configure allowed signature algorithms for handshake */
Gilles Peskine449bd832023-01-11 14:50:10 +01002741void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
2742 const uint16_t *sig_algs)
Hanno Becker1cd6e002021-08-10 13:27:10 +01002743{
Jerry Yuf017ee42022-01-12 15:49:48 +08002744#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2745 conf->sig_hashes = NULL;
2746#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2747 conf->sig_algs = sig_algs;
Hanno Becker1cd6e002021-08-10 13:27:10 +01002748}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002749#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002750
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002751#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01002752#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002753/*
2754 * Set the allowed elliptic curves
Brett Warrene0edc842021-08-17 09:53:13 +01002755 *
2756 * mbedtls_ssl_setup() takes the provided list
2757 * and translates it to a list of IANA TLS group identifiers,
2758 * stored in ssl->handshake->group_list.
2759 *
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002760 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002761void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
2762 const mbedtls_ecp_group_id *curve_list)
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002763{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002764 conf->curve_list = curve_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002765 conf->group_list = NULL;
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002766}
Brett Warrene0edc842021-08-17 09:53:13 +01002767#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002768#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard7f38ed02014-02-04 15:52:33 +01002769
Brett Warrene0edc842021-08-17 09:53:13 +01002770/*
2771 * Set the allowed groups
2772 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002773void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
2774 const uint16_t *group_list)
Brett Warrene0edc842021-08-17 09:53:13 +01002775{
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02002776#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01002777 conf->curve_list = NULL;
2778#endif
2779 conf->group_list = group_list;
2780}
2781
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002782#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002783int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname)
Paul Bakker5121ce52009-01-03 21:22:43 +00002784{
Hanno Becker947194e2017-04-07 13:25:49 +01002785 /* Initialize to suppress unnecessary compiler warning */
2786 size_t hostname_len = 0;
2787
2788 /* Check if new hostname is valid before
2789 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 if (hostname != NULL) {
2791 hostname_len = strlen(hostname);
Hanno Becker947194e2017-04-07 13:25:49 +01002792
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
2794 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2795 }
Hanno Becker947194e2017-04-07 13:25:49 +01002796 }
2797
2798 /* Now it's clear that we will overwrite the old hostname,
2799 * so we can free it safely */
2800
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01002802 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Hanno Becker947194e2017-04-07 13:25:49 +01002803 }
2804
2805 /* Passing NULL as hostname shall clear the old one */
Manuel Pégourié-Gonnardba26c242015-05-06 10:47:06 +01002806
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 if (hostname == NULL) {
Hanno Becker947194e2017-04-07 13:25:49 +01002808 ssl->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 } else {
2810 ssl->hostname = mbedtls_calloc(1, hostname_len + 1);
2811 if (ssl->hostname == NULL) {
2812 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
2813 }
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002814
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 memcpy(ssl->hostname, hostname, hostname_len);
Paul Bakker75c1a6f2013-08-19 14:25:29 +02002816
Hanno Becker947194e2017-04-07 13:25:49 +01002817 ssl->hostname[hostname_len] = '\0';
2818 }
Paul Bakker5121ce52009-01-03 21:22:43 +00002819
Gilles Peskine449bd832023-01-11 14:50:10 +01002820 return 0;
Paul Bakker5121ce52009-01-03 21:22:43 +00002821}
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002822#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002823
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002824#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002825void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
2826 int (*f_sni)(void *, mbedtls_ssl_context *,
2827 const unsigned char *, size_t),
2828 void *p_sni)
Paul Bakker5701cdc2012-09-27 21:49:42 +00002829{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002830 conf->f_sni = f_sni;
2831 conf->p_sni = p_sni;
Paul Bakker5701cdc2012-09-27 21:49:42 +00002832}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002833#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002834
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002835#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002836int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002837{
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002838 size_t cur_len, tot_len;
2839 const char **p;
2840
2841 /*
Brian J Murray1903fb32016-11-06 04:45:15 -08002842 * RFC 7301 3.1: "Empty strings MUST NOT be included and byte strings
2843 * MUST NOT be truncated."
2844 * We check lengths now rather than later.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002845 */
2846 tot_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 for (p = protos; *p != NULL; p++) {
2848 cur_len = strlen(*p);
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002849 tot_len += cur_len;
2850
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 if ((cur_len == 0) ||
2852 (cur_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) ||
2853 (tot_len > MBEDTLS_SSL_MAX_ALPN_LIST_LEN)) {
2854 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2855 }
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002856 }
2857
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002858 conf->alpn_list = protos;
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002859
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 return 0;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002861}
2862
Gilles Peskine449bd832023-01-11 14:50:10 +01002863const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002864{
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 return ssl->alpn_chosen;
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002866}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002867#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002868
Johan Pascalb62bb512015-12-03 21:56:45 +01002869#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine449bd832023-01-11 14:50:10 +01002870void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
2871 int support_mki_value)
Ron Eldor591f1622018-01-22 12:30:04 +02002872{
2873 conf->dtls_srtp_mki_support = support_mki_value;
2874}
2875
Gilles Peskine449bd832023-01-11 14:50:10 +01002876int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
2877 unsigned char *mki_value,
2878 uint16_t mki_len)
Ron Eldor591f1622018-01-22 12:30:04 +02002879{
Gilles Peskine449bd832023-01-11 14:50:10 +01002880 if (mki_len > MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH) {
2881 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Ron Eldora9788042018-12-05 11:04:31 +02002882 }
Ron Eldor591f1622018-01-22 12:30:04 +02002883
Gilles Peskine449bd832023-01-11 14:50:10 +01002884 if (ssl->conf->dtls_srtp_mki_support == MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED) {
2885 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Ron Eldora9788042018-12-05 11:04:31 +02002886 }
Ron Eldor591f1622018-01-22 12:30:04 +02002887
Gilles Peskine449bd832023-01-11 14:50:10 +01002888 memcpy(ssl->dtls_srtp_info.mki_value, mki_value, mki_len);
Ron Eldor591f1622018-01-22 12:30:04 +02002889 ssl->dtls_srtp_info.mki_len = mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002890 return 0;
Ron Eldor591f1622018-01-22 12:30:04 +02002891}
2892
Gilles Peskine449bd832023-01-11 14:50:10 +01002893int mbedtls_ssl_conf_dtls_srtp_protection_profiles(mbedtls_ssl_config *conf,
2894 const mbedtls_ssl_srtp_profile *profiles)
Johan Pascalb62bb512015-12-03 21:56:45 +01002895{
Johan Pascal253d0262020-09-22 13:04:45 +02002896 const mbedtls_ssl_srtp_profile *p;
2897 size_t list_size = 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002898
Johan Pascal253d0262020-09-22 13:04:45 +02002899 /* check the profiles list: all entry must be valid,
2900 * its size cannot be more than the total number of supported profiles, currently 4 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002901 for (p = profiles; *p != MBEDTLS_TLS_SRTP_UNSET &&
2902 list_size <= MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH;
2903 p++) {
2904 if (mbedtls_ssl_check_srtp_profile_value(*p) != MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002905 list_size++;
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 } else {
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002907 /* unsupported value, stop parsing and set the size to an error value */
2908 list_size = MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH + 1;
Johan Pascalb62bb512015-12-03 21:56:45 +01002909 }
2910 }
2911
Gilles Peskine449bd832023-01-11 14:50:10 +01002912 if (list_size > MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH) {
2913 conf->dtls_srtp_profile_list = NULL;
2914 conf->dtls_srtp_profile_list_len = 0;
2915 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Johan Pascal253d0262020-09-22 13:04:45 +02002916 }
2917
Johan Pascal9bc97ca2020-09-21 23:44:45 +02002918 conf->dtls_srtp_profile_list = profiles;
Johan Pascal253d0262020-09-22 13:04:45 +02002919 conf->dtls_srtp_profile_list_len = list_size;
Johan Pascalb62bb512015-12-03 21:56:45 +01002920
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 return 0;
Johan Pascalb62bb512015-12-03 21:56:45 +01002922}
2923
Gilles Peskine449bd832023-01-11 14:50:10 +01002924void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
2925 mbedtls_dtls_srtp_info *dtls_srtp_info)
Johan Pascalb62bb512015-12-03 21:56:45 +01002926{
Johan Pascal2258a4f2020-10-28 13:53:09 +01002927 dtls_srtp_info->chosen_dtls_srtp_profile = ssl->dtls_srtp_info.chosen_dtls_srtp_profile;
2928 /* do not copy the mki value if there is no chosen profile */
Gilles Peskine449bd832023-01-11 14:50:10 +01002929 if (dtls_srtp_info->chosen_dtls_srtp_profile == MBEDTLS_TLS_SRTP_UNSET) {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002930 dtls_srtp_info->mki_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 } else {
Johan Pascal2258a4f2020-10-28 13:53:09 +01002932 dtls_srtp_info->mki_len = ssl->dtls_srtp_info.mki_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 memcpy(dtls_srtp_info->mki_value, ssl->dtls_srtp_info.mki_value,
2934 ssl->dtls_srtp_info.mki_len);
Johan Pascal2258a4f2020-10-28 13:53:09 +01002935 }
Johan Pascalb62bb512015-12-03 21:56:45 +01002936}
Johan Pascalb62bb512015-12-03 21:56:45 +01002937#endif /* MBEDTLS_SSL_DTLS_SRTP */
2938
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302939#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002940void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker490ecc82011-10-06 13:04:09 +00002941{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002942 conf->max_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00002943}
2944
Gilles Peskine449bd832023-01-11 14:50:10 +01002945void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002946{
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01002947 conf->min_tls_version = (mbedtls_ssl_protocol_version) ((major << 8) | minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00002948}
Aditya Patwardhan3096f332022-07-26 14:31:46 +05302949#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00002950
Janos Follath088ce432017-04-10 12:42:31 +01002951#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002952void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
2953 char cert_req_ca_list)
Janos Follath088ce432017-04-10 12:42:31 +01002954{
2955 conf->cert_req_ca_list = cert_req_ca_list;
2956}
2957#endif
2958
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002959#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01002960void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002961{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002962 conf->encrypt_then_mac = etm;
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002963}
2964#endif
2965
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002966#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01002967void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002968{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002969 conf->extended_ms = ems;
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002970}
2971#endif
2972
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002973#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002974int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002975{
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 if (mfl_code >= MBEDTLS_SSL_MAX_FRAG_LEN_INVALID ||
2977 ssl_mfl_code_to_length(mfl_code) > MBEDTLS_TLS_EXT_ADV_CONTENT_LEN) {
2978 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002979 }
2980
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002981 conf->mfl_code = mfl_code;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002982
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 return 0;
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002984}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002985#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002986
Gilles Peskine449bd832023-01-11 14:50:10 +01002987void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy)
Paul Bakker48916f92012-09-16 19:57:18 +00002988{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002989 conf->allow_legacy_renegotiation = allow_legacy;
Paul Bakker48916f92012-09-16 19:57:18 +00002990}
2991
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002992#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002993void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation)
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002994{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002995 conf->disable_renegotiation = renegotiation;
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01002996}
2997
Gilles Peskine449bd832023-01-11 14:50:10 +01002998void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002999{
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003000 conf->renego_max_records = max_records;
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003001}
3002
Gilles Peskine449bd832023-01-11 14:50:10 +01003003void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3004 const unsigned char period[8])
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003005{
Gilles Peskine449bd832023-01-11 14:50:10 +01003006 memcpy(conf->renego_period, period, 8);
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003007}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003008#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003009
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003010#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003011#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003012void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003013{
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003014 conf->session_tickets = use_tickets;
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003015}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003016#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +02003017
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003018#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003019
Jerry Yud0766ec2022-09-22 10:46:57 +08003020#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003021void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
3022 uint16_t num_tickets)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003023{
Jerry Yud0766ec2022-09-22 10:46:57 +08003024 conf->new_session_tickets_count = num_tickets;
Jerry Yu1ad7ace2022-08-09 13:28:39 +08003025}
3026#endif
3027
Gilles Peskine449bd832023-01-11 14:50:10 +01003028void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
3029 mbedtls_ssl_ticket_write_t *f_ticket_write,
3030 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
3031 void *p_ticket)
Paul Bakker606b4ba2013-08-14 16:52:14 +02003032{
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02003033 conf->f_ticket_write = f_ticket_write;
3034 conf->f_ticket_parse = f_ticket_parse;
3035 conf->p_ticket = p_ticket;
Paul Bakker606b4ba2013-08-14 16:52:14 +02003036}
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003037#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003038#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003039
Gilles Peskine449bd832023-01-11 14:50:10 +01003040void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
3041 mbedtls_ssl_export_keys_t *f_export_keys,
3042 void *p_export_keys)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003043{
Hanno Becker7e6c1782021-06-08 09:24:55 +01003044 ssl->f_export_keys = f_export_keys;
3045 ssl->p_export_keys = p_export_keys;
Ron Eldorf5cc10d2019-05-07 18:33:40 +03003046}
Robert Cragie4feb7ae2015-10-02 13:33:37 +01003047
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003048#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003049void mbedtls_ssl_conf_async_private_cb(
3050 mbedtls_ssl_config *conf,
3051 mbedtls_ssl_async_sign_t *f_async_sign,
3052 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
3053 mbedtls_ssl_async_resume_t *f_async_resume,
3054 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 void *async_config_data)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003056{
3057 conf->f_async_sign_start = f_async_sign;
3058 conf->f_async_decrypt_start = f_async_decrypt;
3059 conf->f_async_resume = f_async_resume;
3060 conf->f_async_cancel = f_async_cancel;
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003061 conf->p_async_config_data = async_config_data;
3062}
3063
Gilles Peskine449bd832023-01-11 14:50:10 +01003064void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf)
Gilles Peskine8f97af72018-04-26 11:46:10 +02003065{
Gilles Peskine449bd832023-01-11 14:50:10 +01003066 return conf->p_async_config_data;
Gilles Peskine8f97af72018-04-26 11:46:10 +02003067}
3068
Gilles Peskine449bd832023-01-11 14:50:10 +01003069void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003070{
Gilles Peskine449bd832023-01-11 14:50:10 +01003071 if (ssl->handshake == NULL) {
3072 return NULL;
3073 } else {
3074 return ssl->handshake->user_async_ctx;
3075 }
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003076}
3077
Gilles Peskine449bd832023-01-11 14:50:10 +01003078void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
3079 void *ctx)
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003080{
Gilles Peskine449bd832023-01-11 14:50:10 +01003081 if (ssl->handshake != NULL) {
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02003082 ssl->handshake->user_async_ctx = ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01003083 }
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003084}
Gilles Peskineb74a1c72018-04-24 13:09:22 +02003085#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01003086
Paul Bakker5121ce52009-01-03 21:22:43 +00003087/*
3088 * SSL get accessors
3089 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003090uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00003091{
Gilles Peskine449bd832023-01-11 14:50:10 +01003092 if (ssl->session != NULL) {
3093 return ssl->session->verify_result;
3094 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003095
Gilles Peskine449bd832023-01-11 14:50:10 +01003096 if (ssl->session_negotiate != NULL) {
3097 return ssl->session_negotiate->verify_result;
3098 }
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00003099
Gilles Peskine449bd832023-01-11 14:50:10 +01003100 return 0xFFFFFFFF;
Paul Bakker5121ce52009-01-03 21:22:43 +00003101}
3102
Gilles Peskine449bd832023-01-11 14:50:10 +01003103int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl)
Glenn Strauss8f526902022-01-13 00:04:49 -05003104{
Gilles Peskine449bd832023-01-11 14:50:10 +01003105 if (ssl == NULL || ssl->session == NULL) {
3106 return 0;
3107 }
Glenn Strauss8f526902022-01-13 00:04:49 -05003108
Gilles Peskine449bd832023-01-11 14:50:10 +01003109 return ssl->session->ciphersuite;
Glenn Strauss8f526902022-01-13 00:04:49 -05003110}
3111
Gilles Peskine449bd832023-01-11 14:50:10 +01003112const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl)
Paul Bakker72f62662011-01-16 21:27:44 +00003113{
Gilles Peskine449bd832023-01-11 14:50:10 +01003114 if (ssl == NULL || ssl->session == NULL) {
3115 return NULL;
3116 }
Paul Bakker926c8e42013-03-06 10:23:34 +01003117
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 return mbedtls_ssl_get_ciphersuite_name(ssl->session->ciphersuite);
Paul Bakker72f62662011-01-16 21:27:44 +00003119}
3120
Gilles Peskine449bd832023-01-11 14:50:10 +01003121const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003122{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003123#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003124 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
3125 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003126 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 return "DTLSv1.2";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003128 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003129 return "unknown (DTLS)";
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01003130 }
3131 }
3132#endif
3133
Gilles Peskine449bd832023-01-11 14:50:10 +01003134 switch (ssl->tls_version) {
Glenn Strauss60bfe602022-03-14 19:04:24 -04003135 case MBEDTLS_SSL_VERSION_TLS1_2:
Gilles Peskine449bd832023-01-11 14:50:10 +01003136 return "TLSv1.2";
Glenn Strauss60bfe602022-03-14 19:04:24 -04003137 case MBEDTLS_SSL_VERSION_TLS1_3:
Gilles Peskine449bd832023-01-11 14:50:10 +01003138 return "TLSv1.3";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003139 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003140 return "unknown";
Paul Bakker43ca69c2011-01-15 17:35:19 +00003141 }
Paul Bakker43ca69c2011-01-15 17:35:19 +00003142}
3143
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003144#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3145
3146size_t mbedtls_ssl_get_output_record_size_limit(const mbedtls_ssl_context *ssl)
3147{
3148 const size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3149 size_t record_size_limit = max_len;
3150
3151 if (ssl->session != NULL &&
3152 ssl->session->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3153 ssl->session->record_size_limit < max_len) {
3154 record_size_limit = ssl->session->record_size_limit;
3155 }
3156
3157 // TODO: this is currently untested
3158 /* During a handshake, use the value being negotiated */
3159 if (ssl->session_negotiate != NULL &&
3160 ssl->session_negotiate->record_size_limit >= MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN &&
3161 ssl->session_negotiate->record_size_limit < max_len) {
3162 record_size_limit = ssl->session_negotiate->record_size_limit;
3163 }
3164
3165 return record_size_limit;
3166}
3167#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3168
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003169#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003170size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003171{
David Horstmann95d516f2021-05-04 18:36:56 +01003172 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003173 size_t read_mfl;
3174
Jerry Yuddda0502022-12-01 19:43:12 +08003175#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003176 /* Use the configured MFL for the client if we're past SERVER_HELLO_DONE */
Gilles Peskine449bd832023-01-11 14:50:10 +01003177 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3178 ssl->state >= MBEDTLS_SSL_SERVER_HELLO_DONE) {
3179 return ssl_mfl_code_to_length(ssl->conf->mfl_code);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003180 }
Jerry Yuddda0502022-12-01 19:43:12 +08003181#endif
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003182
3183 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003184 if (ssl->session_out != NULL) {
3185 read_mfl = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
3186 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003187 max_len = read_mfl;
3188 }
3189 }
3190
Jerry Yuddda0502022-12-01 19:43:12 +08003191 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003192 if (ssl->session_negotiate != NULL) {
3193 read_mfl = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
3194 if (read_mfl < max_len) {
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003195 max_len = read_mfl;
3196 }
3197 }
3198
Gilles Peskine449bd832023-01-11 14:50:10 +01003199 return max_len;
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003200}
3201
Gilles Peskine449bd832023-01-11 14:50:10 +01003202size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003203{
3204 size_t max_len;
3205
3206 /*
3207 * Assume mfl_code is correct since it was checked when set
3208 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003209 max_len = ssl_mfl_code_to_length(ssl->conf->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003210
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003211 /* Check if a smaller max length was negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 if (ssl->session_out != NULL &&
3213 ssl_mfl_code_to_length(ssl->session_out->mfl_code) < max_len) {
3214 max_len = ssl_mfl_code_to_length(ssl->session_out->mfl_code);
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003215 }
3216
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003217 /* During a handshake, use the value being negotiated */
Gilles Peskine449bd832023-01-11 14:50:10 +01003218 if (ssl->session_negotiate != NULL &&
3219 ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code) < max_len) {
3220 max_len = ssl_mfl_code_to_length(ssl->session_negotiate->mfl_code);
Manuel Pégourié-Gonnard2cb17e22017-09-19 13:00:47 +02003221 }
3222
Gilles Peskine449bd832023-01-11 14:50:10 +01003223 return max_len;
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003224}
3225#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3226
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003227#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003228size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003229{
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003230 /* Return unlimited mtu for client hello messages to avoid fragmentation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01003231 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
3232 (ssl->state == MBEDTLS_SSL_CLIENT_HELLO ||
3233 ssl->state == MBEDTLS_SSL_SERVER_HELLO)) {
3234 return 0;
3235 }
Andrzej Kurekef43ce62018-10-09 08:24:12 -04003236
Gilles Peskine449bd832023-01-11 14:50:10 +01003237 if (ssl->handshake == NULL || ssl->handshake->mtu == 0) {
3238 return ssl->mtu;
3239 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003240
Gilles Peskine449bd832023-01-11 14:50:10 +01003241 if (ssl->mtu == 0) {
3242 return ssl->handshake->mtu;
3243 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003244
Gilles Peskine449bd832023-01-11 14:50:10 +01003245 return ssl->mtu < ssl->handshake->mtu ?
3246 ssl->mtu : ssl->handshake->mtu;
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003247}
3248#endif /* MBEDTLS_SSL_PROTO_DTLS */
3249
Gilles Peskine449bd832023-01-11 14:50:10 +01003250int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003251{
3252 size_t max_len = MBEDTLS_SSL_OUT_CONTENT_LEN;
3253
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003254#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003255 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT) && \
Manuel Pégourié-Gonnard000281e2018-08-21 11:20:58 +02003256 !defined(MBEDTLS_SSL_PROTO_DTLS)
3257 (void) ssl;
3258#endif
3259
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003260#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003261 const size_t mfl = mbedtls_ssl_get_output_max_frag_len(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003262
Gilles Peskine449bd832023-01-11 14:50:10 +01003263 if (max_len > mfl) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003264 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003265 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003266#endif
3267
Jan Brucknerf482dcc2023-03-15 09:09:06 +01003268#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3269 const size_t record_size_limit = mbedtls_ssl_get_output_record_size_limit(ssl);
3270
3271 if (max_len > record_size_limit) {
3272 max_len = record_size_limit;
3273 }
3274#endif
3275
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003276 if (ssl->transform_out != NULL &&
3277 ssl->transform_out->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Waleed Elmelegyf5017902024-01-09 14:18:34 +00003278 /*
3279 * In TLS 1.3 case, when records are protected, `max_len` as computed
3280 * above is the maximum length of the TLSInnerPlaintext structure that
3281 * along the plaintext payload contains the inner content type (one byte)
3282 * and some zero padding. Given the algorithm used for padding
3283 * in mbedtls_ssl_encrypt_buf(), compute the maximum length for
3284 * the plaintext payload. Round down to a multiple of
3285 * MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY and
3286 * subtract 1.
Waleed Elmelegy6a971fd2023-12-28 17:48:16 +00003287 */
3288 max_len = ((max_len / MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) *
3289 MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY) - 1;
3290 }
3291
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003292#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01003293 if (mbedtls_ssl_get_current_mtu(ssl) != 0) {
3294 const size_t mtu = mbedtls_ssl_get_current_mtu(ssl);
3295 const int ret = mbedtls_ssl_get_record_expansion(ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003296 const size_t overhead = (size_t) ret;
3297
Gilles Peskine449bd832023-01-11 14:50:10 +01003298 if (ret < 0) {
3299 return ret;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003300 }
3301
Gilles Peskine449bd832023-01-11 14:50:10 +01003302 if (mtu <= overhead) {
3303 MBEDTLS_SSL_DEBUG_MSG(1, ("MTU too low for record expansion"));
3304 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3305 }
3306
3307 if (max_len > mtu - overhead) {
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003308 max_len = mtu - overhead;
Gilles Peskine449bd832023-01-11 14:50:10 +01003309 }
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003310 }
Manuel Pégourié-Gonnardb8eec192018-08-20 09:34:02 +02003311#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003312
Hanno Becker0defedb2018-08-10 12:35:02 +01003313#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) && \
Waleed Elmelegy049cd302023-12-20 17:28:31 +00003314 !defined(MBEDTLS_SSL_PROTO_DTLS) && \
3315 !defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Hanno Becker0defedb2018-08-10 12:35:02 +01003316 ((void) ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003317#endif
3318
Gilles Peskine449bd832023-01-11 14:50:10 +01003319 return (int) max_len;
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003320}
3321
Gilles Peskine449bd832023-01-11 14:50:10 +01003322int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl)
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003323{
3324 size_t max_len = MBEDTLS_SSL_IN_CONTENT_LEN;
3325
3326#if !defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3327 (void) ssl;
3328#endif
3329
3330#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +01003331 const size_t mfl = mbedtls_ssl_get_input_max_frag_len(ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003332
Gilles Peskine449bd832023-01-11 14:50:10 +01003333 if (max_len > mfl) {
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003334 max_len = mfl;
Gilles Peskine449bd832023-01-11 14:50:10 +01003335 }
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003336#endif
3337
Gilles Peskine449bd832023-01-11 14:50:10 +01003338 return (int) max_len;
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003339}
3340
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003341#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003342const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003343{
Gilles Peskine449bd832023-01-11 14:50:10 +01003344 if (ssl == NULL || ssl->session == NULL) {
3345 return NULL;
3346 }
Paul Bakkerb0550d92012-10-30 07:51:03 +00003347
Hanno Beckere6824572019-02-07 13:18:46 +00003348#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01003349 return ssl->session->peer_cert;
Hanno Beckere6824572019-02-07 13:18:46 +00003350#else
Gilles Peskine449bd832023-01-11 14:50:10 +01003351 return NULL;
Hanno Beckere6824572019-02-07 13:18:46 +00003352#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003353}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003354#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003355
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003356#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003357int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
3358 mbedtls_ssl_session *dst)
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003359{
Hanno Beckere810bbc2021-05-14 16:01:05 +01003360 int ret;
3361
Gilles Peskine449bd832023-01-11 14:50:10 +01003362 if (ssl == NULL ||
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003363 dst == NULL ||
3364 ssl->session == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01003365 ssl->conf->endpoint != MBEDTLS_SSL_IS_CLIENT) {
3366 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003367 }
3368
Hanno Beckere810bbc2021-05-14 16:01:05 +01003369 /* Since Mbed TLS 3.0, mbedtls_ssl_get_session() is no longer
3370 * idempotent: Each session can only be exported once.
3371 *
3372 * (This is in preparation for TLS 1.3 support where we will
3373 * need the ability to export multiple sessions (aka tickets),
3374 * which will be achieved by calling mbedtls_ssl_get_session()
3375 * multiple times until it fails.)
3376 *
3377 * Check whether we have already exported the current session,
3378 * and fail if so.
3379 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003380 if (ssl->session->exported == 1) {
3381 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
3382 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003383
Gilles Peskine449bd832023-01-11 14:50:10 +01003384 ret = mbedtls_ssl_session_copy(dst, ssl->session);
3385 if (ret != 0) {
3386 return ret;
3387 }
Hanno Beckere810bbc2021-05-14 16:01:05 +01003388
3389 /* Remember that we've exported the session. */
3390 ssl->session->exported = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01003391 return 0;
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003392}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003393#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003394
David Horstmanncb01b362024-02-29 17:31:46 +00003395#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
3396
3397/* Serialization of TLS 1.2 sessions
David Horstmanne59f9702024-02-29 16:08:57 +00003398 *
David Horstmanncb01b362024-02-29 17:31:46 +00003399 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003400 */
3401static size_t ssl_tls12_session_save(const mbedtls_ssl_session *session,
3402 unsigned char *buf,
3403 size_t buf_len)
3404{
3405 unsigned char *p = buf;
3406 size_t used = 0;
3407
3408#if defined(MBEDTLS_HAVE_TIME)
3409 uint64_t start;
3410#endif
3411#if defined(MBEDTLS_X509_CRT_PARSE_C)
3412#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3413 size_t cert_len;
3414#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3415#endif /* MBEDTLS_X509_CRT_PARSE_C */
3416
3417 /*
3418 * Time
3419 */
3420#if defined(MBEDTLS_HAVE_TIME)
3421 used += 8;
3422
3423 if (used <= buf_len) {
3424 start = (uint64_t) session->start;
3425
3426 MBEDTLS_PUT_UINT64_BE(start, p, 0);
3427 p += 8;
3428 }
3429#endif /* MBEDTLS_HAVE_TIME */
3430
3431 /*
3432 * Basic mandatory fields
3433 */
3434 used += 1 /* id_len */
3435 + sizeof(session->id)
3436 + sizeof(session->master)
3437 + 4; /* verify_result */
3438
3439 if (used <= buf_len) {
3440 *p++ = MBEDTLS_BYTE_0(session->id_len);
3441 memcpy(p, session->id, 32);
3442 p += 32;
3443
3444 memcpy(p, session->master, 48);
3445 p += 48;
3446
3447 MBEDTLS_PUT_UINT32_BE(session->verify_result, p, 0);
3448 p += 4;
3449 }
3450
3451 /*
3452 * Peer's end-entity certificate
3453 */
3454#if defined(MBEDTLS_X509_CRT_PARSE_C)
3455#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3456 if (session->peer_cert == NULL) {
3457 cert_len = 0;
3458 } else {
3459 cert_len = session->peer_cert->raw.len;
3460 }
3461
3462 used += 3 + cert_len;
3463
3464 if (used <= buf_len) {
3465 *p++ = MBEDTLS_BYTE_2(cert_len);
3466 *p++ = MBEDTLS_BYTE_1(cert_len);
3467 *p++ = MBEDTLS_BYTE_0(cert_len);
3468
3469 if (session->peer_cert != NULL) {
3470 memcpy(p, session->peer_cert->raw.p, cert_len);
3471 p += cert_len;
3472 }
3473 }
3474#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3475 if (session->peer_cert_digest != NULL) {
3476 used += 1 /* type */ + 1 /* length */ + session->peer_cert_digest_len;
3477 if (used <= buf_len) {
3478 *p++ = (unsigned char) session->peer_cert_digest_type;
3479 *p++ = (unsigned char) session->peer_cert_digest_len;
3480 memcpy(p, session->peer_cert_digest,
3481 session->peer_cert_digest_len);
3482 p += session->peer_cert_digest_len;
3483 }
3484 } else {
3485 used += 2;
3486 if (used <= buf_len) {
3487 *p++ = (unsigned char) MBEDTLS_MD_NONE;
3488 *p++ = 0;
3489 }
3490 }
3491#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3492#endif /* MBEDTLS_X509_CRT_PARSE_C */
3493
3494 /*
3495 * Session ticket if any, plus associated data
3496 */
3497#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3498#if defined(MBEDTLS_SSL_CLI_C)
3499 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3500 used += 3 + session->ticket_len + 4; /* len + ticket + lifetime */
3501
3502 if (used <= buf_len) {
3503 *p++ = MBEDTLS_BYTE_2(session->ticket_len);
3504 *p++ = MBEDTLS_BYTE_1(session->ticket_len);
3505 *p++ = MBEDTLS_BYTE_0(session->ticket_len);
3506
3507 if (session->ticket != NULL) {
3508 memcpy(p, session->ticket, session->ticket_len);
3509 p += session->ticket_len;
3510 }
3511
3512 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3513 p += 4;
3514 }
3515 }
3516#endif /* MBEDTLS_SSL_CLI_C */
3517#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3518 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3519 used += 8;
3520
3521 if (used <= buf_len) {
3522 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3523 p += 8;
3524 }
3525 }
3526#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3527#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3528
3529 /*
3530 * Misc extension-related info
3531 */
3532#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3533 used += 1;
3534
3535 if (used <= buf_len) {
3536 *p++ = session->mfl_code;
3537 }
3538#endif
3539
3540#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3541 used += 1;
3542
3543 if (used <= buf_len) {
3544 *p++ = MBEDTLS_BYTE_0(session->encrypt_then_mac);
3545 }
3546#endif
3547
3548 return used;
3549}
3550
3551MBEDTLS_CHECK_RETURN_CRITICAL
3552static int ssl_tls12_session_load(mbedtls_ssl_session *session,
3553 const unsigned char *buf,
3554 size_t len)
3555{
3556#if defined(MBEDTLS_HAVE_TIME)
3557 uint64_t start;
3558#endif
3559#if defined(MBEDTLS_X509_CRT_PARSE_C)
3560#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3561 size_t cert_len;
3562#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3563#endif /* MBEDTLS_X509_CRT_PARSE_C */
3564
3565 const unsigned char *p = buf;
3566 const unsigned char * const end = buf + len;
3567
3568 /*
3569 * Time
3570 */
3571#if defined(MBEDTLS_HAVE_TIME)
3572 if (8 > (size_t) (end - p)) {
3573 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3574 }
3575
3576 start = MBEDTLS_GET_UINT64_BE(p, 0);
3577 p += 8;
3578
3579 session->start = (time_t) start;
3580#endif /* MBEDTLS_HAVE_TIME */
3581
3582 /*
3583 * Basic mandatory fields
3584 */
3585 if (1 + 32 + 48 + 4 > (size_t) (end - p)) {
3586 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3587 }
3588
3589 session->id_len = *p++;
3590 memcpy(session->id, p, 32);
3591 p += 32;
3592
3593 memcpy(session->master, p, 48);
3594 p += 48;
3595
3596 session->verify_result = MBEDTLS_GET_UINT32_BE(p, 0);
3597 p += 4;
3598
3599 /* Immediately clear invalid pointer values that have been read, in case
3600 * we exit early before we replaced them with valid ones. */
3601#if defined(MBEDTLS_X509_CRT_PARSE_C)
3602#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3603 session->peer_cert = NULL;
3604#else
3605 session->peer_cert_digest = NULL;
3606#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3607#endif /* MBEDTLS_X509_CRT_PARSE_C */
3608#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
3609 session->ticket = NULL;
3610#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
3611
3612 /*
3613 * Peer certificate
3614 */
3615#if defined(MBEDTLS_X509_CRT_PARSE_C)
3616#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
3617 /* Deserialize CRT from the end of the ticket. */
3618 if (3 > (size_t) (end - p)) {
3619 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3620 }
3621
3622 cert_len = MBEDTLS_GET_UINT24_BE(p, 0);
3623 p += 3;
3624
3625 if (cert_len != 0) {
3626 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3627
3628 if (cert_len > (size_t) (end - p)) {
3629 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3630 }
3631
3632 session->peer_cert = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
3633
3634 if (session->peer_cert == NULL) {
3635 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3636 }
3637
3638 mbedtls_x509_crt_init(session->peer_cert);
3639
3640 if ((ret = mbedtls_x509_crt_parse_der(session->peer_cert,
3641 p, cert_len)) != 0) {
3642 mbedtls_x509_crt_free(session->peer_cert);
3643 mbedtls_free(session->peer_cert);
3644 session->peer_cert = NULL;
3645 return ret;
3646 }
3647
3648 p += cert_len;
3649 }
3650#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3651 /* Deserialize CRT digest from the end of the ticket. */
3652 if (2 > (size_t) (end - p)) {
3653 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3654 }
3655
3656 session->peer_cert_digest_type = (mbedtls_md_type_t) *p++;
3657 session->peer_cert_digest_len = (size_t) *p++;
3658
3659 if (session->peer_cert_digest_len != 0) {
3660 const mbedtls_md_info_t *md_info =
3661 mbedtls_md_info_from_type(session->peer_cert_digest_type);
3662 if (md_info == NULL) {
3663 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3664 }
3665 if (session->peer_cert_digest_len != mbedtls_md_get_size(md_info)) {
3666 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3667 }
3668
3669 if (session->peer_cert_digest_len > (size_t) (end - p)) {
3670 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3671 }
3672
3673 session->peer_cert_digest =
3674 mbedtls_calloc(1, session->peer_cert_digest_len);
3675 if (session->peer_cert_digest == NULL) {
3676 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3677 }
3678
3679 memcpy(session->peer_cert_digest, p,
3680 session->peer_cert_digest_len);
3681 p += session->peer_cert_digest_len;
3682 }
3683#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
3684#endif /* MBEDTLS_X509_CRT_PARSE_C */
3685
3686 /*
3687 * Session ticket and associated data
3688 */
3689#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3690#if defined(MBEDTLS_SSL_CLI_C)
3691 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3692 if (3 > (size_t) (end - p)) {
3693 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3694 }
3695
3696 session->ticket_len = MBEDTLS_GET_UINT24_BE(p, 0);
3697 p += 3;
3698
3699 if (session->ticket_len != 0) {
3700 if (session->ticket_len > (size_t) (end - p)) {
3701 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3702 }
3703
3704 session->ticket = mbedtls_calloc(1, session->ticket_len);
3705 if (session->ticket == NULL) {
3706 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
3707 }
3708
3709 memcpy(session->ticket, p, session->ticket_len);
3710 p += session->ticket_len;
3711 }
3712
3713 if (4 > (size_t) (end - p)) {
3714 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3715 }
3716
3717 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
3718 p += 4;
3719 }
3720#endif /* MBEDTLS_SSL_CLI_C */
3721#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_SRV_C)
3722 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3723 if (8 > (size_t) (end - p)) {
3724 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3725 }
3726 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3727 p += 8;
3728 }
3729#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_SRV_C */
3730#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3731
3732 /*
3733 * Misc extension-related info
3734 */
3735#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3736 if (1 > (size_t) (end - p)) {
3737 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3738 }
3739
3740 session->mfl_code = *p++;
3741#endif
3742
3743#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
3744 if (1 > (size_t) (end - p)) {
3745 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3746 }
3747
3748 session->encrypt_then_mac = *p++;
3749#endif
3750
3751 /* Done, should have consumed entire buffer */
3752 if (p != end) {
3753 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3754 }
3755
3756 return 0;
3757}
3758
3759#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
3760
3761#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
3762/* Serialization of TLS 1.3 sessions:
3763 *
David Horstmanncb01b362024-02-29 17:31:46 +00003764 * For more detail, see the description of ssl_session_save().
David Horstmanne59f9702024-02-29 16:08:57 +00003765 */
3766#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3767MBEDTLS_CHECK_RETURN_CRITICAL
3768static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
3769 unsigned char *buf,
3770 size_t buf_len,
3771 size_t *olen)
3772{
3773 unsigned char *p = buf;
3774#if defined(MBEDTLS_SSL_CLI_C) && \
3775 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3776 size_t hostname_len = (session->hostname == NULL) ?
3777 0 : strlen(session->hostname) + 1;
3778#endif
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003779
3780#if defined(MBEDTLS_SSL_SRV_C) && \
3781 defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003782 const size_t alpn_len = (session->ticket_alpn == NULL) ?
Waleed Elmelegyb28ab0a2024-03-13 16:48:28 +00003783 0 : strlen(session->ticket_alpn) + 1;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003784#endif
David Horstmanne59f9702024-02-29 16:08:57 +00003785 size_t needed = 4 /* ticket_age_add */
3786 + 1 /* ticket_flags */
3787 + 1; /* resumption_key length */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003788
David Horstmanne59f9702024-02-29 16:08:57 +00003789 *olen = 0;
3790
3791 if (session->resumption_key_len > MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN) {
3792 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3793 }
3794 needed += session->resumption_key_len; /* resumption_key */
3795
3796#if defined(MBEDTLS_SSL_EARLY_DATA)
3797 needed += 4; /* max_early_data_size */
3798#endif
3799#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3800 needed += 2; /* record_size_limit */
3801#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3802
3803#if defined(MBEDTLS_HAVE_TIME)
3804 needed += 8; /* ticket_creation_time or ticket_reception_time */
3805#endif
3806
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003807#if defined(MBEDTLS_SSL_SRV_C)
3808 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
3809#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003810 needed += 2 /* alpn_len */
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003811 + alpn_len; /* alpn */
3812#endif
3813 }
3814#endif /* MBEDTLS_SSL_SRV_C */
3815
David Horstmanne59f9702024-02-29 16:08:57 +00003816#if defined(MBEDTLS_SSL_CLI_C)
3817 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3818#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3819 needed += 2 /* hostname_len */
3820 + hostname_len; /* hostname */
3821#endif
3822
3823 needed += 4 /* ticket_lifetime */
3824 + 2; /* ticket_len */
3825
3826 /* Check size_t overflow */
3827 if (session->ticket_len > SIZE_MAX - needed) {
3828 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3829 }
3830
3831 needed += session->ticket_len; /* ticket */
3832 }
3833#endif /* MBEDTLS_SSL_CLI_C */
3834
3835 *olen = needed;
3836 if (needed > buf_len) {
3837 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
3838 }
3839
3840 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 0);
3841 p[4] = session->ticket_flags;
3842
3843 /* save resumption_key */
3844 p[5] = session->resumption_key_len;
3845 p += 6;
3846 memcpy(p, session->resumption_key, session->resumption_key_len);
3847 p += session->resumption_key_len;
3848
3849#if defined(MBEDTLS_SSL_EARLY_DATA)
3850 MBEDTLS_PUT_UINT32_BE(session->max_early_data_size, p, 0);
3851 p += 4;
3852#endif
3853#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3854 MBEDTLS_PUT_UINT16_BE(session->record_size_limit, p, 0);
3855 p += 2;
3856#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3857
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003858#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003859 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003860#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003861 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_creation_time, p, 0);
3862 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003863#endif /* MBEDTLS_HAVE_TIME */
3864
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003865#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003866 MBEDTLS_PUT_UINT16_BE(alpn_len, p, 0);
3867 p += 2;
3868
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003869 if (alpn_len > 0) {
3870 /* save chosen alpn */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003871 memcpy(p, session->ticket_alpn, alpn_len);
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003872 p += alpn_len;
3873 }
3874#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3875 }
3876#endif /* MBEDTLS_SSL_SRV_C */
3877
David Horstmanne59f9702024-02-29 16:08:57 +00003878#if defined(MBEDTLS_SSL_CLI_C)
3879 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3880#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3881 MBEDTLS_PUT_UINT16_BE(hostname_len, p, 0);
3882 p += 2;
3883 if (hostname_len > 0) {
3884 /* save host name */
3885 memcpy(p, session->hostname, hostname_len);
3886 p += hostname_len;
3887 }
3888#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
3889
3890#if defined(MBEDTLS_HAVE_TIME)
3891 MBEDTLS_PUT_UINT64_BE((uint64_t) session->ticket_reception_time, p, 0);
3892 p += 8;
3893#endif
3894 MBEDTLS_PUT_UINT32_BE(session->ticket_lifetime, p, 0);
3895 p += 4;
3896
3897 MBEDTLS_PUT_UINT16_BE(session->ticket_len, p, 0);
3898 p += 2;
3899
3900 if (session->ticket != NULL && session->ticket_len > 0) {
3901 memcpy(p, session->ticket, session->ticket_len);
3902 p += session->ticket_len;
3903 }
3904 }
3905#endif /* MBEDTLS_SSL_CLI_C */
3906 return 0;
3907}
3908
3909MBEDTLS_CHECK_RETURN_CRITICAL
3910static int ssl_tls13_session_load(mbedtls_ssl_session *session,
3911 const unsigned char *buf,
3912 size_t len)
3913{
3914 const unsigned char *p = buf;
3915 const unsigned char *end = buf + len;
3916
3917 if (end - p < 6) {
3918 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3919 }
3920 session->ticket_age_add = MBEDTLS_GET_UINT32_BE(p, 0);
3921 session->ticket_flags = p[4];
3922
3923 /* load resumption_key */
3924 session->resumption_key_len = p[5];
3925 p += 6;
3926
3927 if (end - p < session->resumption_key_len) {
3928 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3929 }
3930
3931 if (sizeof(session->resumption_key) < session->resumption_key_len) {
3932 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3933 }
3934 memcpy(session->resumption_key, p, session->resumption_key_len);
3935 p += session->resumption_key_len;
3936
3937#if defined(MBEDTLS_SSL_EARLY_DATA)
3938 if (end - p < 4) {
3939 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3940 }
3941 session->max_early_data_size = MBEDTLS_GET_UINT32_BE(p, 0);
3942 p += 4;
3943#endif
3944#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
3945 if (end - p < 2) {
3946 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3947 }
3948 session->record_size_limit = MBEDTLS_GET_UINT16_BE(p, 0);
3949 p += 2;
3950#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
3951
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003952#if defined(MBEDTLS_SSL_SRV_C)
David Horstmanne59f9702024-02-29 16:08:57 +00003953 if (session->endpoint == MBEDTLS_SSL_IS_SERVER) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003954#if defined(MBEDTLS_HAVE_TIME)
David Horstmanne59f9702024-02-29 16:08:57 +00003955 if (end - p < 8) {
3956 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3957 }
3958 session->ticket_creation_time = MBEDTLS_GET_UINT64_BE(p, 0);
3959 p += 8;
David Horstmanne59f9702024-02-29 16:08:57 +00003960#endif /* MBEDTLS_HAVE_TIME */
3961
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003962#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003963 size_t alpn_len;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003964
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003965 if (end - p < 2) {
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003966 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3967 }
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00003968
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003969 alpn_len = MBEDTLS_GET_UINT16_BE(p, 0);
3970 p += 2;
3971
3972 if (end - p < (long int) alpn_len) {
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00003973 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3974 }
3975
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003976 if (alpn_len > 0) {
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00003977 int ret = mbedtls_ssl_session_set_ticket_alpn(session, (char *) p);
3978 if (ret != 0) {
3979 return ret;
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003980 }
Waleed Elmelegy2824a202024-02-23 17:51:47 +00003981 p += alpn_len;
3982 }
3983#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
3984 }
3985#endif /* MBEDTLS_SSL_SRV_C */
3986
David Horstmanne59f9702024-02-29 16:08:57 +00003987#if defined(MBEDTLS_SSL_CLI_C)
3988 if (session->endpoint == MBEDTLS_SSL_IS_CLIENT) {
3989#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
3990 size_t hostname_len;
3991 /* load host name */
3992 if (end - p < 2) {
3993 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3994 }
3995 hostname_len = MBEDTLS_GET_UINT16_BE(p, 0);
3996 p += 2;
3997
3998 if (end - p < (long int) hostname_len) {
3999 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4000 }
4001 if (hostname_len > 0) {
4002 session->hostname = mbedtls_calloc(1, hostname_len);
4003 if (session->hostname == NULL) {
4004 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4005 }
4006 memcpy(session->hostname, p, hostname_len);
4007 p += hostname_len;
4008 }
4009#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4010
4011#if defined(MBEDTLS_HAVE_TIME)
4012 if (end - p < 8) {
4013 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4014 }
4015 session->ticket_reception_time = MBEDTLS_GET_UINT64_BE(p, 0);
4016 p += 8;
4017#endif
4018 if (end - p < 4) {
4019 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4020 }
4021 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE(p, 0);
4022 p += 4;
4023
4024 if (end - p < 2) {
4025 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4026 }
4027 session->ticket_len = MBEDTLS_GET_UINT16_BE(p, 0);
4028 p += 2;
4029
4030 if (end - p < (long int) session->ticket_len) {
4031 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4032 }
4033 if (session->ticket_len > 0) {
4034 session->ticket = mbedtls_calloc(1, session->ticket_len);
4035 if (session->ticket == NULL) {
4036 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
4037 }
4038 memcpy(session->ticket, p, session->ticket_len);
4039 p += session->ticket_len;
4040 }
4041 }
4042#endif /* MBEDTLS_SSL_CLI_C */
4043
4044 return 0;
4045
4046}
4047#else /* MBEDTLS_SSL_SESSION_TICKETS */
4048MBEDTLS_CHECK_RETURN_CRITICAL
4049static int ssl_tls13_session_save(const mbedtls_ssl_session *session,
4050 unsigned char *buf,
4051 size_t buf_len,
4052 size_t *olen)
4053{
4054 ((void) session);
4055 ((void) buf);
4056 ((void) buf_len);
4057 *olen = 0;
4058 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4059}
4060
4061static int ssl_tls13_session_load(const mbedtls_ssl_session *session,
Norbert Fabritiusd36913a2023-01-24 17:48:29 +01004062 const unsigned char *buf,
David Horstmanne59f9702024-02-29 16:08:57 +00004063 size_t buf_len)
4064{
4065 ((void) session);
4066 ((void) buf);
4067 ((void) buf_len);
4068 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
4069}
4070#endif /* !MBEDTLS_SSL_SESSION_TICKETS */
4071#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4072
Paul Bakker5121ce52009-01-03 21:22:43 +00004073/*
Hanno Beckera835da52019-05-16 12:39:07 +01004074 * Define ticket header determining Mbed TLS version
4075 * and structure of the ticket.
4076 */
4077
Hanno Becker94ef3b32019-05-16 12:50:45 +01004078/*
Hanno Becker50b59662019-05-28 14:30:45 +01004079 * Define bitflag determining compile-time settings influencing
4080 * structure of serialized SSL sessions.
Hanno Becker94ef3b32019-05-16 12:50:45 +01004081 */
4082
Hanno Becker50b59662019-05-28 14:30:45 +01004083#if defined(MBEDTLS_HAVE_TIME)
Hanno Becker3e088662019-05-29 11:10:18 +01004084#define SSL_SERIALIZED_SESSION_CONFIG_TIME 1
Hanno Becker50b59662019-05-28 14:30:45 +01004085#else
Hanno Becker3e088662019-05-29 11:10:18 +01004086#define SSL_SERIALIZED_SESSION_CONFIG_TIME 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004087#endif /* MBEDTLS_HAVE_TIME */
4088
4089#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker3e088662019-05-29 11:10:18 +01004090#define SSL_SERIALIZED_SESSION_CONFIG_CRT 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004091#else
Hanno Becker3e088662019-05-29 11:10:18 +01004092#define SSL_SERIALIZED_SESSION_CONFIG_CRT 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004093#endif /* MBEDTLS_X509_CRT_PARSE_C */
4094
David Horstmann5c5a32f2024-02-13 17:53:35 +00004095#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
David Horstmannf686f1d2024-03-01 11:20:32 +00004096#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 1
David Horstmann5c5a32f2024-02-13 17:53:35 +00004097#else
David Horstmannf686f1d2024-03-01 11:20:32 +00004098#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT 0
David Horstmann5c5a32f2024-02-13 17:53:35 +00004099#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4100
Hanno Becker94ef3b32019-05-16 12:50:45 +01004101#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Hanno Becker3e088662019-05-29 11:10:18 +01004102#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004103#else
Hanno Becker3e088662019-05-29 11:10:18 +01004104#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004105#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_SESSION_TICKETS */
4106
4107#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Hanno Becker3e088662019-05-29 11:10:18 +01004108#define SSL_SERIALIZED_SESSION_CONFIG_MFL 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004109#else
Hanno Becker3e088662019-05-29 11:10:18 +01004110#define SSL_SERIALIZED_SESSION_CONFIG_MFL 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004111#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
4112
Hanno Becker94ef3b32019-05-16 12:50:45 +01004113#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Hanno Becker3e088662019-05-29 11:10:18 +01004114#define SSL_SERIALIZED_SESSION_CONFIG_ETM 1
Hanno Becker94ef3b32019-05-16 12:50:45 +01004115#else
Hanno Becker3e088662019-05-29 11:10:18 +01004116#define SSL_SERIALIZED_SESSION_CONFIG_ETM 0
Hanno Becker94ef3b32019-05-16 12:50:45 +01004117#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
4118
Hanno Becker94ef3b32019-05-16 12:50:45 +01004119#if defined(MBEDTLS_SSL_SESSION_TICKETS)
4120#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 1
4121#else
4122#define SSL_SERIALIZED_SESSION_CONFIG_TICKET 0
4123#endif /* MBEDTLS_SSL_SESSION_TICKETS */
4124
David Horstmann92b258b2024-02-13 17:23:34 +00004125#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4126#define SSL_SERIALIZED_SESSION_CONFIG_SNI 1
4127#else
4128#define SSL_SERIALIZED_SESSION_CONFIG_SNI 0
4129#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
4130
4131#if defined(MBEDTLS_SSL_EARLY_DATA)
4132#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 1
4133#else
4134#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA 0
4135#endif /* MBEDTLS_SSL_EARLY_DATA */
4136
4137#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4138#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 1
4139#else
4140#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE 0
4141#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
4142
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004143#if defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C) && \
4144 defined(MBEDTLS_SSL_EARLY_DATA)
Waleed Elmelegy11025632024-03-07 15:25:52 +00004145#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 1
4146#else
4147#define SSL_SERIALIZED_SESSION_CONFIG_ALPN 0
4148#endif /* MBEDTLS_SSL_ALPN */
4149
Hanno Becker3e088662019-05-29 11:10:18 +01004150#define SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT 0
4151#define SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT 1
4152#define SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT 2
4153#define SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT 3
Hanno Becker37bdbe62021-08-01 05:38:58 +01004154#define SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT 4
4155#define SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT 5
David Horstmannf686f1d2024-03-01 11:20:32 +00004156#define SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT 6
David Horstmann92b258b2024-02-13 17:23:34 +00004157#define SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT 7
4158#define SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT 8
4159#define SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT 9
Waleed Elmelegy11025632024-03-07 15:25:52 +00004160#define SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT 10
Hanno Becker3e088662019-05-29 11:10:18 +01004161
Hanno Becker50b59662019-05-28 14:30:45 +01004162#define SSL_SERIALIZED_SESSION_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004163 ((uint16_t) ( \
4164 (SSL_SERIALIZED_SESSION_CONFIG_TIME << SSL_SERIALIZED_SESSION_CONFIG_TIME_BIT) | \
4165 (SSL_SERIALIZED_SESSION_CONFIG_CRT << SSL_SERIALIZED_SESSION_CONFIG_CRT_BIT) | \
4166 (SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET << \
4167 SSL_SERIALIZED_SESSION_CONFIG_CLIENT_TICKET_BIT) | \
4168 (SSL_SERIALIZED_SESSION_CONFIG_MFL << SSL_SERIALIZED_SESSION_CONFIG_MFL_BIT) | \
4169 (SSL_SERIALIZED_SESSION_CONFIG_ETM << SSL_SERIALIZED_SESSION_CONFIG_ETM_BIT) | \
David Horstmann5c5a32f2024-02-13 17:53:35 +00004170 (SSL_SERIALIZED_SESSION_CONFIG_TICKET << SSL_SERIALIZED_SESSION_CONFIG_TICKET_BIT) | \
David Horstmann71fa1a92024-03-01 12:32:18 +00004171 (SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT << \
4172 SSL_SERIALIZED_SESSION_CONFIG_KEEP_PEER_CRT_BIT) | \
David Horstmann92b258b2024-02-13 17:23:34 +00004173 (SSL_SERIALIZED_SESSION_CONFIG_SNI << SSL_SERIALIZED_SESSION_CONFIG_SNI_BIT) | \
4174 (SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA << \
4175 SSL_SERIALIZED_SESSION_CONFIG_EARLY_DATA_BIT) | \
4176 (SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004177 SSL_SERIALIZED_SESSION_CONFIG_RECORD_SIZE_BIT) | \
Waleed Elmelegy75e33fa2024-03-07 16:57:58 +00004178 (SSL_SERIALIZED_SESSION_CONFIG_ALPN << \
Waleed Elmelegy11025632024-03-07 15:25:52 +00004179 SSL_SERIALIZED_SESSION_CONFIG_ALPN_BIT)))
Hanno Becker94ef3b32019-05-16 12:50:45 +01004180
Chien Wong4e9683e2023-12-28 17:07:43 +08004181static const unsigned char ssl_serialized_session_header[] = {
Hanno Becker94ef3b32019-05-16 12:50:45 +01004182 MBEDTLS_VERSION_MAJOR,
4183 MBEDTLS_VERSION_MINOR,
4184 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004185 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
4186 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
Hanno Beckerf8787072019-05-16 12:41:07 +01004187};
Hanno Beckera835da52019-05-16 12:39:07 +01004188
4189/*
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004190 * Serialize a session in the following format:
Manuel Pégourié-Gonnard35eb8022019-05-16 11:11:08 +02004191 * (in the presentation language of TLS, RFC 8446 section 3)
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004192 *
David Horstmanncb01b362024-02-29 17:31:46 +00004193 * TLS 1.2 session:
4194 *
4195 * struct {
4196 * #if defined(MBEDTLS_SSL_SESSION_TICKETS)
4197 * opaque ticket<0..2^24-1>; // length 0 means no ticket
4198 * uint32 ticket_lifetime;
4199 * #endif
4200 * } ClientOnlyData;
4201 *
4202 * struct {
4203 * #if defined(MBEDTLS_HAVE_TIME)
4204 * uint64 start_time;
4205 * #endif
4206 * uint8 session_id_len; // at most 32
4207 * opaque session_id[32];
4208 * opaque master[48]; // fixed length in the standard
4209 * uint32 verify_result;
4210 * #if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
4211 * opaque peer_cert<0..2^24-1>; // length 0 means no peer cert
4212 * #else
David Horstmann76ba26a2024-03-01 12:03:35 +00004213 * uint8 peer_cert_digest_type;
David Horstmanncb01b362024-02-29 17:31:46 +00004214 * opaque peer_cert_digest<0..2^8-1>
4215 * #endif
4216 * select (endpoint) {
4217 * case client: ClientOnlyData;
4218 * case server: uint64 ticket_creation_time;
4219 * };
4220 * #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
4221 * uint8 mfl_code; // up to 255 according to standard
4222 * #endif
4223 * #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
4224 * uint8 encrypt_then_mac; // 0 or 1
4225 * #endif
4226 * } serialized_session_tls12;
4227 *
4228 *
4229 * TLS 1.3 Session:
4230 *
4231 * struct {
4232 * #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
4233 * opaque hostname<0..2^16-1>;
4234 * #endif
4235 * #if defined(MBEDTLS_HAVE_TIME)
4236 * uint64 ticket_reception_time;
4237 * #endif
4238 * uint32 ticket_lifetime;
4239 * opaque ticket<1..2^16-1>;
4240 * } ClientOnlyData;
4241 *
4242 * struct {
4243 * uint32 ticket_age_add;
4244 * uint8 ticket_flags;
4245 * opaque resumption_key<0..255>;
4246 * #if defined(MBEDTLS_SSL_EARLY_DATA)
4247 * uint32 max_early_data_size;
4248 * #endif
4249 * #if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
4250 * uint16 record_size_limit;
4251 * #endif
4252 * select ( endpoint ) {
4253 * case client: ClientOnlyData;
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004254 * case server:
David Horstmanncb01b362024-02-29 17:31:46 +00004255 * #if defined(MBEDTLS_HAVE_TIME)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00004256 * uint64 ticket_creation_time;
David Horstmanncb01b362024-02-29 17:31:46 +00004257 * #endif
Waleed Elmelegyfe9ae082024-03-07 15:47:31 +00004258 * #if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegydaa4da72024-03-13 16:25:34 +00004259 * opaque ticket_alpn<0..256>;
David Horstmanncb01b362024-02-29 17:31:46 +00004260 * #endif
4261 * };
4262 * } serialized_session_tls13;
4263 *
4264 *
4265 * SSL session:
4266 *
4267 * struct {
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004268 *
Hanno Beckerdce50972021-08-01 05:39:23 +01004269 * opaque mbedtls_version[3]; // library version: major, minor, patch
4270 * opaque session_format[2]; // library-version specific 16-bit field
4271 * // determining the format of the remaining
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004272 * // serialized data.
Hanno Beckerdc28b6c2019-05-29 11:08:00 +01004273 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004274 * Note: When updating the format, remember to keep
4275 * these version+format bytes.
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004276 *
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004277 * // In this version, `session_format` determines
4278 * // the setting of those compile-time
4279 * // configuration options which influence
4280 * // the structure of mbedtls_ssl_session.
4281 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004282 * uint8_t minor_ver; // Protocol minor version. Possible values:
Jerry Yu0c2a7382022-12-06 13:27:25 +08004283 * // - TLS 1.2 (0x0303)
4284 * // - TLS 1.3 (0x0304)
David Horstmann531aca22024-02-29 18:14:28 +00004285 * uint8_t endpoint;
4286 * uint16_t ciphersuite;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004287 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004288 * select (serialized_session.tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004289 *
Glenn Straussda7851c2022-03-14 13:29:48 -04004290 * case MBEDTLS_SSL_VERSION_TLS1_2:
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004291 * serialized_session_tls12 data;
Jerry Yu0c2a7382022-12-06 13:27:25 +08004292 * case MBEDTLS_SSL_VERSION_TLS1_3:
Jerry Yuddda0502022-12-01 19:43:12 +08004293 * serialized_session_tls13 data;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004294 *
4295 * };
4296 *
4297 * } serialized_session;
4298 *
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004299 */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004300
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004301MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004302static int ssl_session_save(const mbedtls_ssl_session *session,
4303 unsigned char omit_header,
4304 unsigned char *buf,
4305 size_t buf_len,
4306 size_t *olen)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004307{
4308 unsigned char *p = buf;
4309 size_t used = 0;
Jerry Yu251a12e2022-07-13 15:15:48 +08004310 size_t remaining_len;
Jerry Yue36fdd62022-08-17 21:31:36 +08004311#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4312 size_t out_len;
4313 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4314#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004315 if (session == NULL) {
4316 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4317 }
Jerry Yu438ddd82022-07-07 06:55:50 +00004318
Gilles Peskine449bd832023-01-11 14:50:10 +01004319 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004320 /*
4321 * Add Mbed TLS version identifier
4322 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004323 used += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004324
Gilles Peskine449bd832023-01-11 14:50:10 +01004325 if (used <= buf_len) {
4326 memcpy(p, ssl_serialized_session_header,
4327 sizeof(ssl_serialized_session_header));
4328 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004329 }
4330 }
4331
4332 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004333 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004334 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004335 used += 1 /* TLS version */
4336 + 1 /* endpoint */
4337 + 2; /* ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01004338 if (used <= buf_len) {
4339 *p++ = MBEDTLS_BYTE_0(session->tls_version);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004340 *p++ = session->endpoint;
4341 MBEDTLS_PUT_UINT16_BE(session->ciphersuite, p, 0);
4342 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004343 }
4344
4345 /* Forward to version-specific serialization routine. */
Jerry Yufca4d572022-07-21 10:37:48 +08004346 remaining_len = (buf_len >= used) ? buf_len - used : 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004347 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004348#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004349 case MBEDTLS_SSL_VERSION_TLS1_2:
4350 used += ssl_tls12_session_save(session, p, remaining_len);
4351 break;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004352#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4353
Jerry Yu251a12e2022-07-13 15:15:48 +08004354#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004355 case MBEDTLS_SSL_VERSION_TLS1_3:
4356 ret = ssl_tls13_session_save(session, p, remaining_len, &out_len);
4357 if (ret != 0 && ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
4358 return ret;
4359 }
4360 used += out_len;
4361 break;
Jerry Yu251a12e2022-07-13 15:15:48 +08004362#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4363
Gilles Peskine449bd832023-01-11 14:50:10 +01004364 default:
4365 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004366 }
4367
4368 *olen = used;
Gilles Peskine449bd832023-01-11 14:50:10 +01004369 if (used > buf_len) {
4370 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
4371 }
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004372
Gilles Peskine449bd832023-01-11 14:50:10 +01004373 return 0;
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004374}
4375
4376/*
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004377 * Public wrapper for ssl_session_save()
4378 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004379int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
4380 unsigned char *buf,
4381 size_t buf_len,
4382 size_t *olen)
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004383{
Gilles Peskine449bd832023-01-11 14:50:10 +01004384 return ssl_session_save(session, 0, buf, buf_len, olen);
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02004385}
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004386
Jerry Yuf1b23ca2022-02-18 11:48:47 +08004387/*
4388 * Deserialize session, see mbedtls_ssl_session_save() for format.
4389 *
4390 * This internal version is wrapped by a public function that cleans up in
4391 * case of error, and has an extra option omit_header.
4392 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004393MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004394static int ssl_session_load(mbedtls_ssl_session *session,
4395 unsigned char omit_header,
4396 const unsigned char *buf,
4397 size_t len)
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004398{
4399 const unsigned char *p = buf;
4400 const unsigned char * const end = buf + len;
Jerry Yu438ddd82022-07-07 06:55:50 +00004401 size_t remaining_len;
4402
4403
Gilles Peskine449bd832023-01-11 14:50:10 +01004404 if (session == NULL) {
4405 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
4406 }
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004407
Gilles Peskine449bd832023-01-11 14:50:10 +01004408 if (!omit_header) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004409 /*
4410 * Check Mbed TLS version identifier
4411 */
4412
Gilles Peskine449bd832023-01-11 14:50:10 +01004413 if ((size_t) (end - p) < sizeof(ssl_serialized_session_header)) {
4414 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004415 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004416
4417 if (memcmp(p, ssl_serialized_session_header,
4418 sizeof(ssl_serialized_session_header)) != 0) {
4419 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
4420 }
4421 p += sizeof(ssl_serialized_session_header);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004422 }
4423
4424 /*
Ronald Cron40a4ab02024-01-15 10:21:30 +01004425 * TLS version identifier, endpoint, ciphersuite
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004426 */
Ronald Cron40a4ab02024-01-15 10:21:30 +01004427 if (4 > (size_t) (end - p)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004428 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4429 }
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004430 session->tls_version = (mbedtls_ssl_protocol_version) (0x0300 | *p++);
Ronald Cron40a4ab02024-01-15 10:21:30 +01004431 session->endpoint = *p++;
4432 session->ciphersuite = MBEDTLS_GET_UINT16_BE(p, 0);
4433 p += 2;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004434
4435 /* Dispatch according to TLS version. */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00004436 remaining_len = (size_t) (end - p);
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 switch (session->tls_version) {
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004438#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004439 case MBEDTLS_SSL_VERSION_TLS1_2:
4440 return ssl_tls12_session_load(session, p, remaining_len);
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004441#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
4442
Jerry Yu438ddd82022-07-07 06:55:50 +00004443#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 case MBEDTLS_SSL_VERSION_TLS1_3:
4445 return ssl_tls13_session_load(session, p, remaining_len);
Jerry Yu438ddd82022-07-07 06:55:50 +00004446#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
4447
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 default:
4449 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01004450 }
4451}
4452
Manuel Pégourié-Gonnarda3e7c652019-05-16 10:08:35 +02004453/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02004454 * Deserialize session: public wrapper for error cleaning
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004455 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004456int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
4457 const unsigned char *buf,
4458 size_t len)
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004459{
Gilles Peskine449bd832023-01-11 14:50:10 +01004460 int ret = ssl_session_load(session, 0, buf, len);
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004461
Gilles Peskine449bd832023-01-11 14:50:10 +01004462 if (ret != 0) {
4463 mbedtls_ssl_session_free(session);
4464 }
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004465
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 return ret;
Manuel Pégourié-Gonnarda3d831b2019-05-23 12:28:45 +02004467}
4468
4469/*
Paul Bakker1961b702013-01-25 14:49:24 +01004470 * Perform a single step of the SSL handshake
Paul Bakker5121ce52009-01-03 21:22:43 +00004471 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004472MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004473static int ssl_prepare_handshake_step(mbedtls_ssl_context *ssl)
Hanno Becker41934dd2021-08-07 19:13:43 +01004474{
4475 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
4476
Ronald Cron66dbf912022-02-02 15:33:46 +01004477 /*
4478 * We may have not been able to send to the peer all the handshake data
Ronald Cron3f20b772022-03-08 16:00:02 +01004479 * that were written into the output buffer by the previous handshake step,
4480 * if the write to the network callback returned with the
Ronald Cron66dbf912022-02-02 15:33:46 +01004481 * #MBEDTLS_ERR_SSL_WANT_WRITE error code.
4482 * We proceed to the next handshake step only when all data from the
4483 * previous one have been sent to the peer, thus we make sure that this is
4484 * the case here by calling `mbedtls_ssl_flush_output()`. The function may
4485 * return with the #MBEDTLS_ERR_SSL_WANT_WRITE error code in which case
4486 * we have to wait before to go ahead.
4487 * In the case of TLS 1.3, handshake step handlers do not send data to the
4488 * peer. Data are only sent here and through
4489 * `mbedtls_ssl_handle_pending_alert` in case an error that triggered an
Andrzej Kurek5c65c572022-04-13 14:28:52 -04004490 * alert occurred.
Ronald Cron66dbf912022-02-02 15:33:46 +01004491 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 if ((ret = mbedtls_ssl_flush_output(ssl)) != 0) {
4493 return ret;
4494 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004495
4496#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004497 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4498 ssl->handshake->retransmit_state == MBEDTLS_SSL_RETRANS_SENDING) {
4499 if ((ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
4500 return ret;
4501 }
Hanno Becker41934dd2021-08-07 19:13:43 +01004502 }
4503#endif /* MBEDTLS_SSL_PROTO_DTLS */
4504
Gilles Peskine449bd832023-01-11 14:50:10 +01004505 return ret;
Hanno Becker41934dd2021-08-07 19:13:43 +01004506}
4507
Gilles Peskine449bd832023-01-11 14:50:10 +01004508int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00004509{
Hanno Becker41934dd2021-08-07 19:13:43 +01004510 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker5121ce52009-01-03 21:22:43 +00004511
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 if (ssl == NULL ||
Hanno Becker41934dd2021-08-07 19:13:43 +01004513 ssl->conf == NULL ||
4514 ssl->handshake == NULL ||
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER) {
4516 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Becker41934dd2021-08-07 19:13:43 +01004517 }
4518
Gilles Peskine449bd832023-01-11 14:50:10 +01004519 ret = ssl_prepare_handshake_step(ssl);
4520 if (ret != 0) {
4521 return ret;
4522 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004523
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 ret = mbedtls_ssl_handle_pending_alert(ssl);
4525 if (ret != 0) {
Jerry Yue7047812021-09-13 19:26:39 +08004526 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 }
Jerry Yue7047812021-09-13 19:26:39 +08004528
Tom Cosgrove2fdc7b32022-09-21 12:33:17 +01004529 /* If ssl->conf->endpoint is not one of MBEDTLS_SSL_IS_CLIENT or
4530 * MBEDTLS_SSL_IS_SERVER, this is the return code we give */
4531 ret = MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4532
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004533#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
4535 MBEDTLS_SSL_DEBUG_MSG(2, ("client state: %s",
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01004536 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state)));
Jerry Yub9930e72021-08-06 17:11:51 +08004537
Gilles Peskine449bd832023-01-11 14:50:10 +01004538 switch (ssl->state) {
Ronald Cron9f0fba32022-02-10 16:45:15 +01004539 case MBEDTLS_SSL_HELLO_REQUEST:
4540 ssl->state = MBEDTLS_SSL_CLIENT_HELLO;
Tom Cosgrove87d9c6c2022-09-22 09:27:56 +01004541 ret = 0;
Ronald Cron9f0fba32022-02-10 16:45:15 +01004542 break;
Jerry Yub9930e72021-08-06 17:11:51 +08004543
Ronald Cron9f0fba32022-02-10 16:45:15 +01004544 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 ret = mbedtls_ssl_write_client_hello(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004546 break;
4547
4548 default:
4549#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
4551 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
4552 } else {
4553 ret = mbedtls_ssl_handshake_client_step(ssl);
4554 }
Ronald Cron9f0fba32022-02-10 16:45:15 +01004555#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01004556 ret = mbedtls_ssl_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004557#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 ret = mbedtls_ssl_tls13_handshake_client_step(ssl);
Ronald Cron9f0fba32022-02-10 16:45:15 +01004559#endif
4560 }
Jerry Yub9930e72021-08-06 17:11:51 +08004561 }
Ronald Cron6291b232023-03-08 15:51:25 +01004562#endif /* MBEDTLS_SSL_CLI_C */
4563
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004564#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004565 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Ronald Cron6291b232023-03-08 15:51:25 +01004566#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
4567 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004568 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Ronald Cron6291b232023-03-08 15:51:25 +01004569 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 ret = mbedtls_ssl_handshake_server_step(ssl);
4571 }
Ronald Cron6291b232023-03-08 15:51:25 +01004572#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
4573 ret = mbedtls_ssl_handshake_server_step(ssl);
4574#else
4575 ret = mbedtls_ssl_tls13_handshake_server_step(ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004576#endif
Ronald Cron6291b232023-03-08 15:51:25 +01004577 }
4578#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004579
Gilles Peskine449bd832023-01-11 14:50:10 +01004580 if (ret != 0) {
Jerry Yubbd5a3f2021-09-18 20:50:22 +08004581 /* handshake_step return error. And it is same
4582 * with alert_reason.
4583 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 if (ssl->send_alert) {
4585 ret = mbedtls_ssl_handle_pending_alert(ssl);
Jerry Yue7047812021-09-13 19:26:39 +08004586 goto cleanup;
4587 }
4588 }
4589
4590cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 return ret;
Paul Bakker1961b702013-01-25 14:49:24 +01004592}
4593
4594/*
4595 * Perform the SSL handshake
4596 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004597int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl)
Paul Bakker1961b702013-01-25 14:49:24 +01004598{
4599 int ret = 0;
4600
Hanno Beckera817ea42020-10-20 15:20:23 +01004601 /* Sanity checks */
4602
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 if (ssl == NULL || ssl->conf == NULL) {
4604 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4605 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004606
Hanno Beckera817ea42020-10-20 15:20:23 +01004607#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004608 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4609 (ssl->f_set_timer == NULL || ssl->f_get_timer == NULL)) {
4610 MBEDTLS_SSL_DEBUG_MSG(1, ("You must use "
4611 "mbedtls_ssl_set_timer_cb() for DTLS"));
4612 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Hanno Beckera817ea42020-10-20 15:20:23 +01004613 }
4614#endif /* MBEDTLS_SSL_PROTO_DTLS */
4615
Gilles Peskine449bd832023-01-11 14:50:10 +01004616 MBEDTLS_SSL_DEBUG_MSG(2, ("=> handshake"));
Paul Bakker1961b702013-01-25 14:49:24 +01004617
Hanno Beckera817ea42020-10-20 15:20:23 +01004618 /* Main handshake loop */
Gilles Peskine449bd832023-01-11 14:50:10 +01004619 while (ssl->state != MBEDTLS_SSL_HANDSHAKE_OVER) {
4620 ret = mbedtls_ssl_handshake_step(ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004621
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 if (ret != 0) {
Paul Bakker1961b702013-01-25 14:49:24 +01004623 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 }
Paul Bakker1961b702013-01-25 14:49:24 +01004625 }
4626
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 MBEDTLS_SSL_DEBUG_MSG(2, ("<= handshake"));
Paul Bakker5121ce52009-01-03 21:22:43 +00004628
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 return ret;
Paul Bakker5121ce52009-01-03 21:22:43 +00004630}
4631
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004632#if defined(MBEDTLS_SSL_RENEGOTIATION)
4633#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00004634/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004635 * Write HelloRequest to request renegotiation on server
Paul Bakker48916f92012-09-16 19:57:18 +00004636 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02004637MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01004638static int ssl_write_hello_request(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004639{
Janos Follath865b3eb2019-12-16 11:46:15 +00004640 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004641
Gilles Peskine449bd832023-01-11 14:50:10 +01004642 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004643
4644 ssl->out_msglen = 4;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004645 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
4646 ssl->out_msg[0] = MBEDTLS_SSL_HS_HELLO_REQUEST;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004647
Gilles Peskine449bd832023-01-11 14:50:10 +01004648 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
4649 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
4650 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004651 }
4652
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello request"));
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004654
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 return 0;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004656}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004657#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004658
4659/*
4660 * Actually renegotiate current connection, triggered by either:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004661 * - any side: calling mbedtls_ssl_renegotiate(),
4662 * - client: receiving a HelloRequest during mbedtls_ssl_read(),
4663 * - server: receiving any handshake message on server during mbedtls_ssl_read() after
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +02004664 * the initial handshake is completed.
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004665 * If the handshake doesn't complete due to waiting for I/O, it will continue
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004666 * during the next calls to mbedtls_ssl_renegotiate() or mbedtls_ssl_read() respectively.
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004667 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004668int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004669{
Janos Follath865b3eb2019-12-16 11:46:15 +00004670 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker48916f92012-09-16 19:57:18 +00004671
Gilles Peskine449bd832023-01-11 14:50:10 +01004672 MBEDTLS_SSL_DEBUG_MSG(2, ("=> renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004673
Gilles Peskine449bd832023-01-11 14:50:10 +01004674 if ((ret = ssl_handshake_init(ssl)) != 0) {
4675 return ret;
4676 }
Paul Bakker48916f92012-09-16 19:57:18 +00004677
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004678 /* RFC 6347 4.2.2: "[...] the HelloRequest will have message_seq = 0 and
4679 * the ServerHello will have message_seq = 1" */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004680#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004681 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
4682 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_PENDING) {
4683 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004684 ssl->handshake->out_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004685 } else {
Manuel Pégourié-Gonnard1aa586e2014-09-03 12:54:04 +02004686 ssl->handshake->in_msg_seq = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 }
Manuel Pégourié-Gonnard0557bd52014-08-19 19:18:39 +02004688 }
4689#endif
4690
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004691 ssl->state = MBEDTLS_SSL_HELLO_REQUEST;
4692 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS;
Paul Bakker48916f92012-09-16 19:57:18 +00004693
Gilles Peskine449bd832023-01-11 14:50:10 +01004694 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4695 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4696 return ret;
Paul Bakker48916f92012-09-16 19:57:18 +00004697 }
4698
Gilles Peskine449bd832023-01-11 14:50:10 +01004699 MBEDTLS_SSL_DEBUG_MSG(2, ("<= renegotiate"));
Paul Bakker48916f92012-09-16 19:57:18 +00004700
Gilles Peskine449bd832023-01-11 14:50:10 +01004701 return 0;
Paul Bakker48916f92012-09-16 19:57:18 +00004702}
4703
4704/*
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004705 * Renegotiate current connection on client,
4706 * or request renegotiation on server
4707 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004708int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004709{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004710 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004711
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 if (ssl == NULL || ssl->conf == NULL) {
4713 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4714 }
Manuel Pégourié-Gonnardf81ee2e2015-09-01 17:43:40 +02004715
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004716#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004717 /* On server, just send the request */
Gilles Peskine449bd832023-01-11 14:50:10 +01004718 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
4719 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4720 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
4721 }
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004722
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004723 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_PENDING;
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004724
4725 /* Did we already try/start sending HelloRequest? */
Gilles Peskine449bd832023-01-11 14:50:10 +01004726 if (ssl->out_left != 0) {
4727 return mbedtls_ssl_flush_output(ssl);
4728 }
Manuel Pégourié-Gonnardf07f4212014-08-15 19:04:47 +02004729
Gilles Peskine449bd832023-01-11 14:50:10 +01004730 return ssl_write_hello_request(ssl);
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004731 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004732#endif /* MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004733
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004734#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004735 /*
4736 * On client, either start the renegotiation process or,
4737 * if already in progress, continue the handshake
4738 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 if (ssl->renego_status != MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
4740 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
4741 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004742 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004743
4744 if ((ret = mbedtls_ssl_start_renegotiation(ssl)) != 0) {
4745 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_start_renegotiation", ret);
4746 return ret;
4747 }
4748 } else {
4749 if ((ret = mbedtls_ssl_handshake(ssl)) != 0) {
4750 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_handshake", ret);
4751 return ret;
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004752 }
4753 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004754#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004755
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 return ret;
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004757}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004758#endif /* MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard214eed32013-10-30 13:06:54 +01004759
Gilles Peskine449bd832023-01-11 14:50:10 +01004760void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl)
Paul Bakker48916f92012-09-16 19:57:18 +00004761{
Gilles Peskine9b562d52018-04-25 20:32:43 +02004762 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
4763
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 if (handshake == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004765 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004766 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004767
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004768#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Brett Warrene0edc842021-08-17 09:53:13 +01004769#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004770 if (ssl->handshake->group_list_heap_allocated) {
4771 mbedtls_free((void *) handshake->group_list);
4772 }
Brett Warrene0edc842021-08-17 09:53:13 +01004773 handshake->group_list = NULL;
4774#endif /* MBEDTLS_DEPRECATED_REMOVED */
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01004775#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Brett Warrene0edc842021-08-17 09:53:13 +01004776
Ronald Crone68ab4f2022-10-05 12:46:29 +02004777#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08004778#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004779 if (ssl->handshake->sig_algs_heap_allocated) {
4780 mbedtls_free((void *) handshake->sig_algs);
4781 }
Jerry Yuf017ee42022-01-12 15:49:48 +08004782 handshake->sig_algs = NULL;
4783#endif /* MBEDTLS_DEPRECATED_REMOVED */
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004784#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004785 if (ssl->handshake->certificate_request_context) {
4786 mbedtls_free((void *) handshake->certificate_request_context);
Xiaofei Baic234ecf2022-02-08 09:59:23 +00004787 }
4788#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02004789#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuf017ee42022-01-12 15:49:48 +08004790
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004791#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004792 if (ssl->conf->f_async_cancel != NULL && handshake->async_in_progress != 0) {
4793 ssl->conf->f_async_cancel(ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02004794 handshake->async_in_progress = 0;
4795 }
4796#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
4797
Elena Uziunaite0916cd72024-05-23 17:01:07 +01004798#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004799#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004800 psa_hash_abort(&handshake->fin_sha256_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004801#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004802 mbedtls_md_free(&handshake->fin_sha256);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004803#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004804#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01004805#if defined(PSA_WANT_ALG_SHA_384)
Andrzej Kurekeb342242019-01-29 09:14:33 -05004806#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004807 psa_hash_abort(&handshake->fin_sha384_psa);
Andrzej Kurekeb342242019-01-29 09:14:33 -05004808#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01004809 mbedtls_md_free(&handshake->fin_sha384);
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004810#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -05004811#endif
Manuel Pégourié-Gonnardb9d64e52015-07-06 14:18:56 +02004812
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004813#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 mbedtls_dhm_free(&handshake->dhm_ctx);
Paul Bakker48916f92012-09-16 19:57:18 +00004815#endif
Valerio Setti7aeec542023-07-05 18:57:21 +02004816#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
Valerio Setti6eb00542023-07-07 17:04:24 +02004817 defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_1_2_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 mbedtls_ecdh_free(&handshake->ecdh_ctx);
Paul Bakker61d113b2013-07-04 11:51:43 +02004819#endif
Valerio Setti02c25b52022-11-15 14:08:42 +01004820
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004821#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02004822#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004823 psa_pake_abort(&handshake->psa_pake_ctx);
Valerio Settieb3f7882022-12-08 18:42:58 +01004824 /*
4825 * Opaque keys are not stored in the handshake's data and it's the user
4826 * responsibility to destroy them. Clear ones, instead, are created by
4827 * the TLS library and should be destroyed at the same level
4828 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004829 if (!mbedtls_svc_key_id_is_null(handshake->psa_pake_password)) {
4830 psa_destroy_key(handshake->psa_pake_password);
Valerio Settieb3f7882022-12-08 18:42:58 +01004831 }
Neil Armstrongca7d5062022-05-31 14:43:23 +02004832 handshake->psa_pake_password = MBEDTLS_SVC_KEY_ID_INIT;
4833#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004834 mbedtls_ecjpake_free(&handshake->ecjpake_ctx);
Neil Armstrongca7d5062022-05-31 14:43:23 +02004835#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004836#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004837 mbedtls_free(handshake->ecjpake_cache);
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +02004838 handshake->ecjpake_cache = NULL;
4839 handshake->ecjpake_cache_len = 0;
4840#endif
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +02004841#endif
Paul Bakker61d113b2013-07-04 11:51:43 +02004842
Valerio Setti7aeec542023-07-05 18:57:21 +02004843#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED) || \
Valerio Setti45d56f32023-07-13 17:23:20 +02004844 defined(MBEDTLS_KEY_EXCHANGE_WITH_ECDSA_ANY_ENABLED) || \
Janos Follath4ae5c292016-02-10 11:27:43 +00004845 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Paul Bakker9af723c2014-05-01 13:03:14 +02004846 /* explicit void pointer cast for buggy MS compiler */
Gilles Peskine449bd832023-01-11 14:50:10 +01004847 mbedtls_free((void *) handshake->curves_tls_id);
Manuel Pégourié-Gonnardd09453c2013-09-23 19:11:32 +02004848#endif
4849
Ronald Cron73fe8df2022-10-05 14:31:43 +02004850#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02004851#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02004853 /* The maintenance of the external PSK key slot is the
4854 * user's responsibility. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004855 if (ssl->handshake->psk_opaque_is_internal) {
4856 psa_destroy_key(ssl->handshake->psk_opaque);
Neil Armstrong501c9322022-05-03 09:35:09 +02004857 ssl->handshake->psk_opaque_is_internal = 0;
4858 }
4859 ssl->handshake->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
4860 }
Neil Armstronge952a302022-05-03 10:22:14 +02004861#else
Gilles Peskine449bd832023-01-11 14:50:10 +01004862 if (handshake->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01004863 mbedtls_zeroize_and_free(handshake->psk, handshake->psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004864 }
Neil Armstronge952a302022-05-03 10:22:14 +02004865#endif /* MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02004866#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01004867
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004868#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4869 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnard83724542013-09-24 22:30:56 +02004870 /*
4871 * Free only the linked list wrapper, not the keys themselves
4872 * since the belong to the SNI callback
4873 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 ssl_key_cert_free(handshake->sni_key_cert);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004875#endif /* MBEDTLS_X509_CRT_PARSE_C && MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnard705fcca2013-09-23 20:04:20 +02004876
Gilles Peskineeccd8882020-03-10 12:19:08 +01004877#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01004878 mbedtls_x509_crt_restart_free(&handshake->ecrs_ctx);
4879 if (handshake->ecrs_peer_cert != NULL) {
4880 mbedtls_x509_crt_free(handshake->ecrs_peer_cert);
4881 mbedtls_free(handshake->ecrs_peer_cert);
Hanno Becker3dad3112019-02-05 17:19:52 +00004882 }
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +02004883#endif
4884
Hanno Becker75173122019-02-06 16:18:31 +00004885#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
4886 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 mbedtls_pk_free(&handshake->peer_pubkey);
Hanno Becker75173122019-02-06 16:18:31 +00004888#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
4889
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004890#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01004891 (defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
4892 mbedtls_free(handshake->cookie);
XiaokangQian9b93c0d2022-02-09 06:02:25 +00004893#endif /* MBEDTLS_SSL_CLI_C &&
4894 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
XiaokangQian8499b6c2022-01-27 09:00:11 +00004895
4896#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01004897 mbedtls_ssl_flight_free(handshake->flight);
4898 mbedtls_ssl_buffering_free(ssl);
XiaokangQian8499b6c2022-01-27 09:00:11 +00004899#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard74848812014-07-11 02:43:49 +02004900
Valerio Settiea59c432023-07-25 11:14:03 +02004901#if defined(MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED)
Przemek Stekiel7ac93be2023-07-04 10:02:38 +02004902 if (handshake->xxdh_psa_privkey_is_external == 0) {
4903 psa_destroy_key(handshake->xxdh_psa_privkey);
Gilles Peskine449bd832023-01-11 14:50:10 +01004904 }
Valerio Settiea59c432023-07-25 11:14:03 +02004905#endif /* MBEDTLS_KEY_EXCHANGE_SOME_XXDH_PSA_ANY_ENABLED */
Hanno Becker4a63ed42019-01-08 11:39:35 +00004906
Ronald Cron6f135e12021-12-08 16:57:54 +01004907#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01004908 mbedtls_ssl_transform_free(handshake->transform_handshake);
4909 mbedtls_free(handshake->transform_handshake);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004910#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01004911 mbedtls_ssl_transform_free(handshake->transform_earlydata);
4912 mbedtls_free(handshake->transform_earlydata);
Jerry Yu3d9b5902022-11-04 14:07:25 +08004913#endif
Ronald Cron6f135e12021-12-08 16:57:54 +01004914#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yuba9c7272021-10-30 11:54:10 +08004915
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004916
4917#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
4918 /* If the buffers are too big - reallocate. Because of the way Mbed TLS
4919 * processes datagrams and the fact that a datagram is allowed to have
4920 * several records in it, it is possible that the I/O buffers are not
4921 * empty at this stage */
Gilles Peskine449bd832023-01-11 14:50:10 +01004922 handle_buffer_resizing(ssl, 1, mbedtls_ssl_get_input_buflen(ssl),
4923 mbedtls_ssl_get_output_buflen(ssl));
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05004924#endif
Hanno Becker3aa186f2021-08-10 09:24:19 +01004925
Jerry Yuba9c7272021-10-30 11:54:10 +08004926 /* mbedtls_platform_zeroize MUST be last one in this function */
Gilles Peskine449bd832023-01-11 14:50:10 +01004927 mbedtls_platform_zeroize(handshake,
4928 sizeof(mbedtls_ssl_handshake_params));
Paul Bakker48916f92012-09-16 19:57:18 +00004929}
4930
Gilles Peskine449bd832023-01-11 14:50:10 +01004931void mbedtls_ssl_session_free(mbedtls_ssl_session *session)
Paul Bakker48916f92012-09-16 19:57:18 +00004932{
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 if (session == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004934 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004936
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004937#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004938 ssl_clear_peer_cert(session);
Paul Bakkered27a042013-04-18 22:46:23 +02004939#endif
Paul Bakker0a597072012-09-25 21:55:46 +00004940
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004941#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qianbc663a02022-10-09 11:14:39 +00004942#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
4943 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01004944 mbedtls_free(session->hostname);
Xiaokang Qian281fd1b2022-09-20 11:35:41 +00004945#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01004946 mbedtls_free(session->ticket);
Paul Bakkera503a632013-08-14 13:48:06 +02004947#endif
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02004948
Waleed Elmelegy2824a202024-02-23 17:51:47 +00004949#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && \
4950 defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00004951 mbedtls_free(session->ticket_alpn);
Paul Bakker5121ce52009-01-03 21:22:43 +00004952#endif
4953
Gilles Peskine449bd832023-01-11 14:50:10 +01004954 mbedtls_platform_zeroize(session, sizeof(mbedtls_ssl_session));
Paul Bakker5121ce52009-01-03 21:22:43 +00004955}
4956
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004957#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004958
4959#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
4960#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 1u
4961#else
4962#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID 0u
4963#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
4964
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004965#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT 1u
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004966
4967#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
4968#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 1u
4969#else
4970#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY 0u
4971#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
4972
4973#if defined(MBEDTLS_SSL_ALPN)
4974#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 1u
4975#else
4976#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN 0u
4977#endif /* MBEDTLS_SSL_ALPN */
4978
4979#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT 0
4980#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT 1
4981#define SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT 2
4982#define SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT 3
4983
4984#define SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG \
Gilles Peskine449bd832023-01-11 14:50:10 +01004985 ((uint32_t) ( \
4986 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID << \
4987 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_CONNECTION_ID_BIT) | \
4988 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT << \
4989 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_BADMAC_LIMIT_BIT) | \
4990 (SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY << \
4991 SSL_SERIALIZED_CONTEXT_CONFIG_DTLS_ANTI_REPLAY_BIT) | \
4992 (SSL_SERIALIZED_CONTEXT_CONFIG_ALPN << SSL_SERIALIZED_CONTEXT_CONFIG_ALPN_BIT) | \
4993 0u))
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02004994
Chien Wong4e9683e2023-12-28 17:07:43 +08004995static const unsigned char ssl_serialized_context_header[] = {
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004996 MBEDTLS_VERSION_MAJOR,
4997 MBEDTLS_VERSION_MINOR,
4998 MBEDTLS_VERSION_PATCH,
Gilles Peskine449bd832023-01-11 14:50:10 +01004999 MBEDTLS_BYTE_1(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
5000 MBEDTLS_BYTE_0(SSL_SERIALIZED_SESSION_CONFIG_BITFLAG),
5001 MBEDTLS_BYTE_2(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
5002 MBEDTLS_BYTE_1(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
5003 MBEDTLS_BYTE_0(SSL_SERIALIZED_CONTEXT_CONFIG_BITFLAG),
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005004};
5005
Paul Bakker5121ce52009-01-03 21:22:43 +00005006/*
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005007 * Serialize a full SSL context
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005008 *
5009 * The format of the serialized data is:
5010 * (in the presentation language of TLS, RFC 8446 section 3)
5011 *
5012 * // header
5013 * opaque mbedtls_version[3]; // major, minor, patch
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005014 * opaque context_format[5]; // version-specific field determining
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005015 * // the format of the remaining
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005016 * // serialized data.
Manuel Pégourié-Gonnard4e9370b2019-07-23 16:31:16 +02005017 * Note: When updating the format, remember to keep these
5018 * version+format bytes. (We may make their size part of the API.)
Manuel Pégourié-Gonnard00400c22019-07-10 14:58:45 +02005019 *
5020 * // session sub-structure
5021 * opaque session<1..2^32-1>; // see mbedtls_ssl_session_save()
5022 * // transform sub-structure
5023 * uint8 random[64]; // ServerHello.random+ClientHello.random
5024 * uint8 in_cid<0..2^8-1> // Connection ID: expected incoming value
5025 * uint8 out_cid<0..2^8-1> // Connection ID: outgoing value to use
5026 * // fields from ssl_context
5027 * uint32 badmac_seen; // DTLS: number of records with failing MAC
5028 * uint64 in_window_top; // DTLS: last validated record seq_num
5029 * uint64 in_window; // DTLS: bitmask for replay protection
5030 * uint8 disable_datagram_packing; // DTLS: only one record per datagram
5031 * uint64 cur_out_ctr; // Record layer: outgoing sequence number
5032 * uint16 mtu; // DTLS: path mtu (max outgoing fragment size)
5033 * uint8 alpn_chosen<0..2^8-1> // ALPN: negotiated application protocol
5034 *
5035 * Note that many fields of the ssl_context or sub-structures are not
5036 * serialized, as they fall in one of the following categories:
5037 *
5038 * 1. forced value (eg in_left must be 0)
5039 * 2. pointer to dynamically-allocated memory (eg session, transform)
5040 * 3. value can be re-derived from other data (eg session keys from MS)
5041 * 4. value was temporary (eg content of input buffer)
5042 * 5. value will be provided by the user again (eg I/O callbacks and context)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005043 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005044int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5045 unsigned char *buf,
5046 size_t buf_len,
5047 size_t *olen)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005048{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005049 unsigned char *p = buf;
5050 size_t used = 0;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005051 size_t session_len;
5052 int ret = 0;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005053
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005054 /*
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005055 * Enforce usage restrictions, see "return BAD_INPUT_DATA" in
5056 * this function's documentation.
5057 *
5058 * These are due to assumptions/limitations in the implementation. Some of
5059 * them are likely to stay (no handshake in progress) some might go away
5060 * (only DTLS) but are currently used to simplify the implementation.
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005061 */
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005062 /* The initial handshake must be over */
Gilles Peskine449bd832023-01-11 14:50:10 +01005063 if (mbedtls_ssl_is_handshake_over(ssl) == 0) {
5064 MBEDTLS_SSL_DEBUG_MSG(1, ("Initial handshake isn't over"));
5065 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005066 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005067 if (ssl->handshake != NULL) {
5068 MBEDTLS_SSL_DEBUG_MSG(1, ("Handshake isn't completed"));
5069 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005070 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005071 /* Double-check that sub-structures are indeed ready */
Gilles Peskine449bd832023-01-11 14:50:10 +01005072 if (ssl->transform == NULL || ssl->session == NULL) {
5073 MBEDTLS_SSL_DEBUG_MSG(1, ("Serialised structures aren't ready"));
5074 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005075 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005076 /* There must be no pending incoming or outgoing data */
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 if (mbedtls_ssl_check_pending(ssl) != 0) {
5078 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending incoming data"));
5079 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005080 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005081 if (ssl->out_left != 0) {
5082 MBEDTLS_SSL_DEBUG_MSG(1, ("There is pending outgoing data"));
5083 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005084 }
Dave Rodgman556e8a32022-12-06 16:31:25 +00005085 /* Protocol must be DTLS, not TLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01005086 if (ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
5087 MBEDTLS_SSL_DEBUG_MSG(1, ("Only DTLS is supported"));
5088 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005089 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005090 /* Version must be 1.2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005091 if (ssl->tls_version != MBEDTLS_SSL_VERSION_TLS1_2) {
5092 MBEDTLS_SSL_DEBUG_MSG(1, ("Only version 1.2 supported"));
5093 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005094 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005095 /* We must be using an AEAD ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01005096 if (mbedtls_ssl_transform_uses_aead(ssl->transform) != 1) {
5097 MBEDTLS_SSL_DEBUG_MSG(1, ("Only AEAD ciphersuites supported"));
5098 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005099 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005100 /* Renegotiation must not be enabled */
5101#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01005102 if (ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED) {
5103 MBEDTLS_SSL_DEBUG_MSG(1, ("Renegotiation must not be enabled"));
5104 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jarno Lamsa8c51b7c2019-08-21 13:45:05 +03005105 }
Manuel Pégourié-Gonnarde4588692019-07-29 12:28:52 +02005106#endif
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005107
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005108 /*
5109 * Version and format identifier
5110 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005111 used += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005112
Gilles Peskine449bd832023-01-11 14:50:10 +01005113 if (used <= buf_len) {
5114 memcpy(p, ssl_serialized_context_header,
5115 sizeof(ssl_serialized_context_header));
5116 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005117 }
5118
5119 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005120 * Session (length + data)
5121 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005122 ret = ssl_session_save(ssl->session, 1, NULL, 0, &session_len);
5123 if (ret != MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL) {
5124 return ret;
5125 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005126
5127 used += 4 + session_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005128 if (used <= buf_len) {
5129 MBEDTLS_PUT_UINT32_BE(session_len, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005130 p += 4;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005131
Gilles Peskine449bd832023-01-11 14:50:10 +01005132 ret = ssl_session_save(ssl->session, 1,
5133 p, session_len, &session_len);
5134 if (ret != 0) {
5135 return ret;
5136 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005137
5138 p += session_len;
5139 }
5140
5141 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005142 * Transform
5143 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 used += sizeof(ssl->transform->randbytes);
5145 if (used <= buf_len) {
5146 memcpy(p, ssl->transform->randbytes,
5147 sizeof(ssl->transform->randbytes));
5148 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005149 }
5150
5151#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Dave Rodgmanc37ad442023-11-03 23:36:06 +00005152 used += 2U + ssl->transform->in_cid_len + ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005153 if (used <= buf_len) {
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005154 *p++ = ssl->transform->in_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005155 memcpy(p, ssl->transform->in_cid, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005156 p += ssl->transform->in_cid_len;
5157
5158 *p++ = ssl->transform->out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005159 memcpy(p, ssl->transform->out_cid, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005160 p += ssl->transform->out_cid_len;
5161 }
5162#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5163
5164 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005165 * Saved fields from top-level ssl_context structure
5166 */
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005167 used += 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 if (used <= buf_len) {
5169 MBEDTLS_PUT_UINT32_BE(ssl->badmac_seen, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005170 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005171 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005172
5173#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5174 used += 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 if (used <= buf_len) {
5176 MBEDTLS_PUT_UINT64_BE(ssl->in_window_top, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005177 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005178
Gilles Peskine449bd832023-01-11 14:50:10 +01005179 MBEDTLS_PUT_UINT64_BE(ssl->in_window, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005180 p += 8;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005181 }
5182#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5183
5184#if defined(MBEDTLS_SSL_PROTO_DTLS)
5185 used += 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005187 *p++ = ssl->disable_datagram_packing;
5188 }
5189#endif /* MBEDTLS_SSL_PROTO_DTLS */
5190
Jerry Yuae0b2e22021-10-08 15:21:19 +08005191 used += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Gilles Peskine449bd832023-01-11 14:50:10 +01005192 if (used <= buf_len) {
5193 memcpy(p, ssl->cur_out_ctr, MBEDTLS_SSL_SEQUENCE_NUMBER_LEN);
Jerry Yuae0b2e22021-10-08 15:21:19 +08005194 p += MBEDTLS_SSL_SEQUENCE_NUMBER_LEN;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005195 }
5196
5197#if defined(MBEDTLS_SSL_PROTO_DTLS)
5198 used += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01005199 if (used <= buf_len) {
5200 MBEDTLS_PUT_UINT16_BE(ssl->mtu, p, 0);
Joe Subbiani1f6c3ae2021-08-20 11:44:44 +01005201 p += 2;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005202 }
5203#endif /* MBEDTLS_SSL_PROTO_DTLS */
5204
5205#if defined(MBEDTLS_SSL_ALPN)
5206 {
5207 const uint8_t alpn_len = ssl->alpn_chosen
Gilles Peskine449bd832023-01-11 14:50:10 +01005208 ? (uint8_t) strlen(ssl->alpn_chosen)
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005209 : 0;
5210
5211 used += 1 + alpn_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005212 if (used <= buf_len) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005213 *p++ = alpn_len;
5214
Gilles Peskine449bd832023-01-11 14:50:10 +01005215 if (ssl->alpn_chosen != NULL) {
5216 memcpy(p, ssl->alpn_chosen, alpn_len);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005217 p += alpn_len;
5218 }
5219 }
5220 }
5221#endif /* MBEDTLS_SSL_ALPN */
5222
5223 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005224 * Done
5225 */
5226 *olen = used;
5227
Gilles Peskine449bd832023-01-11 14:50:10 +01005228 if (used > buf_len) {
5229 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
5230 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005231
Gilles Peskine449bd832023-01-11 14:50:10 +01005232 MBEDTLS_SSL_DEBUG_BUF(4, "saved context", buf, used);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005233
Gilles Peskine449bd832023-01-11 14:50:10 +01005234 return mbedtls_ssl_session_reset_int(ssl, 0);
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005235}
5236
5237/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005238 * Deserialize context, see mbedtls_ssl_context_save() for format.
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005239 *
5240 * This internal version is wrapped by a public function that cleans up in
5241 * case of error.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005242 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005243MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01005244static int ssl_context_load(mbedtls_ssl_context *ssl,
5245 const unsigned char *buf,
5246 size_t len)
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005247{
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005248 const unsigned char *p = buf;
5249 const unsigned char * const end = buf + len;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005250 size_t session_len;
Janos Follath865b3eb2019-12-16 11:46:15 +00005251 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005252#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek894edde2022-09-29 06:31:14 -04005253 tls_prf_fn prf_func = NULL;
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005254#endif
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005255
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005256 /*
5257 * The context should have been freshly setup or reset.
5258 * Give the user an error in case of obvious misuse.
Manuel Pégourié-Gonnard4ca930f2019-07-26 16:31:53 +02005259 * (Checking session is useful because it won't be NULL if we're
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005260 * renegotiating, or if the user mistakenly loaded a session first.)
5261 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005262 if (ssl->state != MBEDTLS_SSL_HELLO_REQUEST ||
5263 ssl->session != NULL) {
5264 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005265 }
5266
5267 /*
5268 * We can't check that the config matches the initial one, but we can at
5269 * least check it matches the requirements for serializing.
5270 */
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005271 if (
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005272#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard9a96fd72019-07-23 17:11:24 +02005273 ssl->conf->disable_renegotiation != MBEDTLS_SSL_RENEGOTIATION_DISABLED ||
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005274#endif
Dave Rodgmane99b24d2023-09-14 15:45:03 +01005275 ssl->conf->transport != MBEDTLS_SSL_TRANSPORT_DATAGRAM ||
5276 ssl->conf->max_tls_version < MBEDTLS_SSL_VERSION_TLS1_2 ||
5277 ssl->conf->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2
5278 ) {
Gilles Peskine449bd832023-01-11 14:50:10 +01005279 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard0ff76402019-07-11 09:56:30 +02005280 }
5281
Gilles Peskine449bd832023-01-11 14:50:10 +01005282 MBEDTLS_SSL_DEBUG_BUF(4, "context to load", buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005283
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005284 /*
5285 * Check version identifier
5286 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005287 if ((size_t) (end - p) < sizeof(ssl_serialized_context_header)) {
5288 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005289 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005290
5291 if (memcmp(p, ssl_serialized_context_header,
5292 sizeof(ssl_serialized_context_header)) != 0) {
5293 return MBEDTLS_ERR_SSL_VERSION_MISMATCH;
5294 }
5295 p += sizeof(ssl_serialized_context_header);
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005296
5297 /*
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005298 * Session
5299 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005300 if ((size_t) (end - p) < 4) {
5301 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5302 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005303
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005304 session_len = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005305 p += 4;
5306
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005307 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005308 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005309 ssl->session = ssl->session_negotiate;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005310 ssl->session_in = ssl->session;
5311 ssl->session_out = ssl->session;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005312 ssl->session_negotiate = NULL;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005313
Gilles Peskine449bd832023-01-11 14:50:10 +01005314 if ((size_t) (end - p) < session_len) {
5315 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5316 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005317
Gilles Peskine449bd832023-01-11 14:50:10 +01005318 ret = ssl_session_load(ssl->session, 1, p, session_len);
5319 if (ret != 0) {
5320 mbedtls_ssl_session_free(ssl->session);
5321 return ret;
Manuel Pégourié-Gonnard45ac1f02019-07-23 16:52:45 +02005322 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005323
5324 p += session_len;
5325
5326 /*
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005327 * Transform
5328 */
5329
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005330 /* This has been allocated by ssl_handshake_init(), called by
Hanno Becker43aefe22020-02-05 10:44:56 +00005331 * by either mbedtls_ssl_session_reset_int() or mbedtls_ssl_setup(). */
Jerry Yu2e199812022-12-01 18:57:19 +08005332#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005333 ssl->transform = ssl->transform_negotiate;
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005334 ssl->transform_in = ssl->transform;
5335 ssl->transform_out = ssl->transform;
Manuel Pégourié-Gonnard142ba732019-07-23 14:43:30 +02005336 ssl->transform_negotiate = NULL;
Jerry Yu2e199812022-12-01 18:57:19 +08005337#endif
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005338
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005339#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005340 prf_func = ssl_tls12prf_from_cs(ssl->session->ciphersuite);
5341 if (prf_func == NULL) {
5342 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5343 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04005344
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005345 /* Read random bytes and populate structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01005346 if ((size_t) (end - p) < sizeof(ssl->transform->randbytes)) {
5347 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5348 }
Andrzej Kurek2d59dbc2022-10-13 08:34:38 -04005349
Gilles Peskine449bd832023-01-11 14:50:10 +01005350 ret = ssl_tls12_populate_transform(ssl->transform,
5351 ssl->session->ciphersuite,
5352 ssl->session->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005353#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005354 ssl->session->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02005355#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 prf_func,
5357 p, /* currently pointing to randbytes */
5358 MBEDTLS_SSL_VERSION_TLS1_2, /* (D)TLS 1.2 is forced */
5359 ssl->conf->endpoint,
5360 ssl);
5361 if (ret != 0) {
5362 return ret;
5363 }
Jerry Yu840fbb22022-02-17 14:59:29 +08005364#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005365 p += sizeof(ssl->transform->randbytes);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005366
5367#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
5368 /* Read connection IDs and store them */
Gilles Peskine449bd832023-01-11 14:50:10 +01005369 if ((size_t) (end - p) < 1) {
5370 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5371 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005372
5373 ssl->transform->in_cid_len = *p++;
5374
Gilles Peskine449bd832023-01-11 14:50:10 +01005375 if ((size_t) (end - p) < ssl->transform->in_cid_len + 1u) {
5376 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5377 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005378
Gilles Peskine449bd832023-01-11 14:50:10 +01005379 memcpy(ssl->transform->in_cid, p, ssl->transform->in_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005380 p += ssl->transform->in_cid_len;
5381
5382 ssl->transform->out_cid_len = *p++;
5383
Gilles Peskine449bd832023-01-11 14:50:10 +01005384 if ((size_t) (end - p) < ssl->transform->out_cid_len) {
5385 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5386 }
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005387
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 memcpy(ssl->transform->out_cid, p, ssl->transform->out_cid_len);
Manuel Pégourié-Gonnardc2a7b892019-07-15 09:04:11 +02005389 p += ssl->transform->out_cid_len;
5390#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
5391
5392 /*
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005393 * Saved fields from top-level ssl_context structure
5394 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005395 if ((size_t) (end - p) < 4) {
5396 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5397 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005398
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005399 ssl->badmac_seen = MBEDTLS_GET_UINT32_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005400 p += 4;
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005401
5402#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01005403 if ((size_t) (end - p) < 16) {
5404 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5405 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005406
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005407 ssl->in_window_top = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005408 p += 8;
5409
Thomas Daubneyf9f0ba82023-05-23 17:34:33 +01005410 ssl->in_window = MBEDTLS_GET_UINT64_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005411 p += 8;
5412#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
5413
5414#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005415 if ((size_t) (end - p) < 1) {
5416 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5417 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005418
5419 ssl->disable_datagram_packing = *p++;
5420#endif /* MBEDTLS_SSL_PROTO_DTLS */
5421
Gilles Peskine449bd832023-01-11 14:50:10 +01005422 if ((size_t) (end - p) < sizeof(ssl->cur_out_ctr)) {
5423 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5424 }
5425 memcpy(ssl->cur_out_ctr, p, sizeof(ssl->cur_out_ctr));
5426 p += sizeof(ssl->cur_out_ctr);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005427
5428#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005429 if ((size_t) (end - p) < 2) {
5430 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5431 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005432
Dave Rodgmana3d0f612023-11-03 23:34:02 +00005433 ssl->mtu = MBEDTLS_GET_UINT16_BE(p, 0);
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005434 p += 2;
5435#endif /* MBEDTLS_SSL_PROTO_DTLS */
5436
5437#if defined(MBEDTLS_SSL_ALPN)
5438 {
5439 uint8_t alpn_len;
5440 const char **cur;
5441
Gilles Peskine449bd832023-01-11 14:50:10 +01005442 if ((size_t) (end - p) < 1) {
5443 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5444 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005445
5446 alpn_len = *p++;
5447
Gilles Peskine449bd832023-01-11 14:50:10 +01005448 if (alpn_len != 0 && ssl->conf->alpn_list != NULL) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005449 /* alpn_chosen should point to an item in the configured list */
Gilles Peskine449bd832023-01-11 14:50:10 +01005450 for (cur = ssl->conf->alpn_list; *cur != NULL; cur++) {
5451 if (strlen(*cur) == alpn_len &&
Waleed Elmelegy131b2ff2024-03-14 01:39:39 +00005452 memcmp(p, *cur, alpn_len) == 0) {
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005453 ssl->alpn_chosen = *cur;
5454 break;
5455 }
5456 }
5457 }
5458
5459 /* can only happen on conf mismatch */
Gilles Peskine449bd832023-01-11 14:50:10 +01005460 if (alpn_len != 0 && ssl->alpn_chosen == NULL) {
5461 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5462 }
Manuel Pégourié-Gonnardc86c5df2019-07-15 11:23:03 +02005463
5464 p += alpn_len;
5465 }
5466#endif /* MBEDTLS_SSL_ALPN */
5467
5468 /*
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005469 * Forced fields from top-level ssl_context structure
5470 *
5471 * Most of them already set to the correct value by mbedtls_ssl_init() and
5472 * mbedtls_ssl_reset(), so we only need to set the remaining ones.
5473 */
5474 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Glenn Strauss60bfe602022-03-14 19:04:24 -04005475 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005476
Hanno Becker361b10d2019-08-30 10:42:49 +01005477 /* Adjust pointers for header fields of outgoing records to
5478 * the given transform, accounting for explicit IV and CID. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005479 mbedtls_ssl_update_out_pointers(ssl, ssl->transform);
Hanno Becker361b10d2019-08-30 10:42:49 +01005480
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005481#if defined(MBEDTLS_SSL_PROTO_DTLS)
5482 ssl->in_epoch = 1;
5483#endif
5484
5485 /* mbedtls_ssl_reset() leaves the handshake sub-structure allocated,
5486 * which we don't want - otherwise we'd end up freeing the wrong transform
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00005487 * by calling mbedtls_ssl_handshake_wrapup_free_hs_transform()
5488 * inappropriately. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 if (ssl->handshake != NULL) {
5490 mbedtls_ssl_handshake_free(ssl);
5491 mbedtls_free(ssl->handshake);
Manuel Pégourié-Gonnard0eb3eac2019-07-15 11:53:51 +02005492 ssl->handshake = NULL;
5493 }
5494
5495 /*
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005496 * Done - should have consumed entire buffer
5497 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 if (p != end) {
5499 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
5500 }
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005501
Gilles Peskine449bd832023-01-11 14:50:10 +01005502 return 0;
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005503}
5504
5505/*
Manuel Pégourié-Gonnardb9dfc9f2019-07-12 10:50:19 +02005506 * Deserialize context: public wrapper for error cleaning
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005507 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005508int mbedtls_ssl_context_load(mbedtls_ssl_context *context,
5509 const unsigned char *buf,
5510 size_t len)
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005511{
Gilles Peskine449bd832023-01-11 14:50:10 +01005512 int ret = ssl_context_load(context, buf, len);
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005513
Gilles Peskine449bd832023-01-11 14:50:10 +01005514 if (ret != 0) {
5515 mbedtls_ssl_free(context);
5516 }
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005517
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 return ret;
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005519}
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005520#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005521
5522/*
Paul Bakker5121ce52009-01-03 21:22:43 +00005523 * Free an SSL context
5524 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005525void mbedtls_ssl_free(mbedtls_ssl_context *ssl)
Paul Bakker5121ce52009-01-03 21:22:43 +00005526{
Gilles Peskine449bd832023-01-11 14:50:10 +01005527 if (ssl == NULL) {
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005528 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 }
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005530
Gilles Peskine449bd832023-01-11 14:50:10 +01005531 MBEDTLS_SSL_DEBUG_MSG(2, ("=> free"));
Paul Bakker5121ce52009-01-03 21:22:43 +00005532
Gilles Peskine449bd832023-01-11 14:50:10 +01005533 if (ssl->out_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005534#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5535 size_t out_buf_len = ssl->out_buf_len;
5536#else
5537 size_t out_buf_len = MBEDTLS_SSL_OUT_BUFFER_LEN;
5538#endif
5539
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005540 mbedtls_zeroize_and_free(ssl->out_buf, out_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005541 ssl->out_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005542 }
5543
Gilles Peskine449bd832023-01-11 14:50:10 +01005544 if (ssl->in_buf != NULL) {
sander-visserb8aa2072020-05-06 22:05:13 +02005545#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
5546 size_t in_buf_len = ssl->in_buf_len;
5547#else
5548 size_t in_buf_len = MBEDTLS_SSL_IN_BUFFER_LEN;
5549#endif
5550
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005551 mbedtls_zeroize_and_free(ssl->in_buf, in_buf_len);
Andrzej Kurek0afa2a12020-03-03 10:39:58 -05005552 ssl->in_buf = NULL;
Paul Bakker5121ce52009-01-03 21:22:43 +00005553 }
5554
Gilles Peskine449bd832023-01-11 14:50:10 +01005555 if (ssl->transform) {
5556 mbedtls_ssl_transform_free(ssl->transform);
5557 mbedtls_free(ssl->transform);
Paul Bakker48916f92012-09-16 19:57:18 +00005558 }
5559
Gilles Peskine449bd832023-01-11 14:50:10 +01005560 if (ssl->handshake) {
5561 mbedtls_ssl_handshake_free(ssl);
5562 mbedtls_free(ssl->handshake);
Jerry Yu2e199812022-12-01 18:57:19 +08005563
5564#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005565 mbedtls_ssl_transform_free(ssl->transform_negotiate);
5566 mbedtls_free(ssl->transform_negotiate);
Jerry Yu2e199812022-12-01 18:57:19 +08005567#endif
5568
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 mbedtls_ssl_session_free(ssl->session_negotiate);
5570 mbedtls_free(ssl->session_negotiate);
Paul Bakker48916f92012-09-16 19:57:18 +00005571 }
5572
Ronald Cron6f135e12021-12-08 16:57:54 +01005573#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01005574 mbedtls_ssl_transform_free(ssl->transform_application);
5575 mbedtls_free(ssl->transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01005576#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01005577
Gilles Peskine449bd832023-01-11 14:50:10 +01005578 if (ssl->session) {
5579 mbedtls_ssl_session_free(ssl->session);
5580 mbedtls_free(ssl->session);
Paul Bakkerc0463502013-02-14 11:19:38 +01005581 }
5582
Manuel Pégourié-Gonnard55fab2d2015-05-11 16:15:19 +02005583#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005584 if (ssl->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005585 mbedtls_zeroize_and_free(ssl->hostname, strlen(ssl->hostname));
Paul Bakker5121ce52009-01-03 21:22:43 +00005586 }
Paul Bakker0be444a2013-08-27 21:55:01 +02005587#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005588
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005589#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005590 mbedtls_free(ssl->cli_id);
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02005591#endif
5592
Gilles Peskine449bd832023-01-11 14:50:10 +01005593 MBEDTLS_SSL_DEBUG_MSG(2, ("<= free"));
Paul Bakker2da561c2009-02-05 18:00:28 +00005594
Paul Bakker86f04f42013-02-14 11:20:09 +01005595 /* Actually clear after last debug message */
Gilles Peskine449bd832023-01-11 14:50:10 +01005596 mbedtls_platform_zeroize(ssl, sizeof(mbedtls_ssl_context));
Paul Bakker5121ce52009-01-03 21:22:43 +00005597}
5598
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005599/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005600 * Initialize mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005601 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005602void mbedtls_ssl_config_init(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005603{
Gilles Peskine449bd832023-01-11 14:50:10 +01005604 memset(conf, 0, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005605}
5606
Gilles Peskineae270bf2021-06-02 00:05:29 +02005607/* The selection should be the same as mbedtls_x509_crt_profile_default in
5608 * x509_crt.c, plus Montgomery curves for ECDHE. Here, the order matters:
Gilles Peskineb1940a72021-06-02 15:18:12 +02005609 * curves with a lower resource usage come first.
Gilles Peskineae270bf2021-06-02 00:05:29 +02005610 * See the documentation of mbedtls_ssl_conf_curves() for what we promise
Gilles Peskineb1940a72021-06-02 15:18:12 +02005611 * about this list.
5612 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005613static const uint16_t ssl_preset_default_groups[] = {
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005614#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Brett Warrene0edc842021-08-17 09:53:13 +01005615 MBEDTLS_SSL_IANA_TLS_GROUP_X25519,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005616#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005617#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005618 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005619#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005620#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005621 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005622#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01005623#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Brett Warrene0edc842021-08-17 09:53:13 +01005624 MBEDTLS_SSL_IANA_TLS_GROUP_X448,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005625#endif
Elena Uziunaite24e24f22024-07-04 17:53:40 +01005626#if defined(PSA_WANT_ECC_SECP_R1_521)
Brett Warrene0edc842021-08-17 09:53:13 +01005627 MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005628#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005629#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005630 MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1,
Gilles Peskineae270bf2021-06-02 00:05:29 +02005631#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005632#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005633 MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005634#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01005635#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Brett Warrene0edc842021-08-17 09:53:13 +01005636 MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1,
Gilles Peskineb1940a72021-06-02 15:18:12 +02005637#endif
Przemek Stekiel316c19e2023-05-31 15:25:11 +02005638#if defined(PSA_WANT_ALG_FFDH)
Przemek Stekiel383f4712022-12-12 14:48:57 +01005639 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048,
5640 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072,
5641 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096,
5642 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144,
5643 MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192,
5644#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005645 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Gilles Peskineae270bf2021-06-02 00:05:29 +02005646};
Gilles Peskineae270bf2021-06-02 00:05:29 +02005647
Alexey Tsvetkov2ca34372022-06-07 10:21:05 +03005648static const int ssl_preset_suiteb_ciphersuites[] = {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005649 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
5650 MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,
5651 0
5652};
5653
Ronald Crone68ab4f2022-10-05 12:46:29 +02005654#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005655
Jerry Yu909df7b2022-01-22 11:56:27 +08005656/* NOTICE:
Jerry Yu0b994b82022-01-25 17:22:12 +08005657 * For ssl_preset_*_sig_algs and ssl_tls12_preset_*_sig_algs, the following
Jerry Yu370e1462022-01-25 10:36:53 +08005658 * rules SHOULD be upheld.
5659 * - No duplicate entries.
5660 * - But if there is a good reason, do not change the order of the algorithms.
Jerry Yu09a99fc2022-07-28 14:22:17 +08005661 * - ssl_tls12_preset* is for TLS 1.2 use only.
Jerry Yu370e1462022-01-25 10:36:53 +08005662 * - ssl_preset_* is for TLS 1.3 only or hybrid TLS 1.3/1.2 handshakes.
Jerry Yu1a8b4812022-01-20 17:56:50 +08005663 */
Chien Wong4e9683e2023-12-28 17:07:43 +08005664static const uint16_t ssl_preset_default_sig_algs[] = {
Jerry Yu1a8b4812022-01-20 17:56:50 +08005665
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005666#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005667 defined(PSA_WANT_ALG_SHA_256) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005668 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yued5e9f42022-01-26 11:21:34 +08005669 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005670 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5671#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005672
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005673#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005674 defined(PSA_WANT_ALG_SHA_384) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005675 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu909df7b2022-01-22 11:56:27 +08005676 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005677 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5678#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005679
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005680#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Gabor Mezeic15ef932024-06-13 12:53:54 +02005681 defined(PSA_WANT_ALG_SHA_512) && \
Valerio Setticf29c5d2023-09-01 09:03:41 +02005682 defined(PSA_WANT_ECC_SECP_R1_521)
Jerry Yued5e9f42022-01-26 11:21:34 +08005683 MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005684 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512)
5685#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005686
Gabor Mezeic15ef932024-06-13 12:53:54 +02005687#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005688 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005689#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005690
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005691#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005692 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005693#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005694
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005695#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005696 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005697#endif
Jerry Yu9bb3ee42022-06-23 10:16:33 +08005698
Gabor Mezeic15ef932024-06-13 12:53:54 +02005699#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_512)
Jerry Yu693a47a2022-06-23 14:02:28 +08005700 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512,
Gabor Mezeic15ef932024-06-13 12:53:54 +02005701#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_512 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005702
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005703#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_384)
Jerry Yu693a47a2022-06-23 14:02:28 +08005704 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384,
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005705#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_384 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005706
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005707#if defined(MBEDTLS_RSA_C) && defined(PSA_WANT_ALG_SHA_256)
Jerry Yu693a47a2022-06-23 14:02:28 +08005708 MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256,
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005709#endif /* MBEDTLS_RSA_C && PSA_WANT_ALG_SHA_256 */
Jerry Yu693a47a2022-06-23 14:02:28 +08005710
Gabor Mezei15b95a62022-05-09 16:37:58 +02005711 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005712};
5713
5714/* NOTICE: see above */
5715#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5716static uint16_t ssl_tls12_preset_default_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005717
Gabor Mezeic15ef932024-06-13 12:53:54 +02005718#if defined(PSA_WANT_ALG_SHA_512)
Valerio Settie9646ec2023-08-02 20:02:28 +02005719#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005720 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA512),
Jerry Yu713013f2022-01-17 18:16:35 +08005721#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005722#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5723 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512,
Yanray Wang1136fad2023-11-22 16:54:31 +08005724#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005725#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005726 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA512),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005727#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02005728#endif /* PSA_WANT_ALG_SHA_512 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005729
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005730#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005731#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005733#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005734#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5735 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384,
Yanray Wang1136fad2023-11-22 16:54:31 +08005736#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005737#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005738 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA384),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005739#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005740#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005741
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005742#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005743#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005744 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu11f0a9c2022-01-12 18:43:08 +08005745#endif
Jerry Yu09a99fc2022-07-28 14:22:17 +08005746#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
5747 MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256,
Yanray Wang1136fad2023-11-22 16:54:31 +08005748#endif
Gabor Mezeic1051b62022-05-10 13:13:58 +02005749#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005750 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_RSA, MBEDTLS_SSL_HASH_SHA256),
Gabor Mezeic1051b62022-05-10 13:13:58 +02005751#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005752#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005753
Gabor Mezei15b95a62022-05-09 16:37:58 +02005754 MBEDTLS_TLS_SIG_NONE
Jerry Yu909df7b2022-01-22 11:56:27 +08005755};
5756#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005757
Jerry Yu909df7b2022-01-22 11:56:27 +08005758/* NOTICE: see above */
Chien Wong4e9683e2023-12-28 17:07:43 +08005759static const uint16_t ssl_preset_suiteb_sig_algs[] = {
Jerry Yu909df7b2022-01-22 11:56:27 +08005760
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005761#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005762 defined(PSA_WANT_ALG_SHA_256) && \
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005763 defined(PSA_WANT_ECC_SECP_R1_256)
Jerry Yu909df7b2022-01-22 11:56:27 +08005764 MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005765 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256)
5766#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005767
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005768#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED) && \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005769 defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005770 defined(PSA_WANT_ECC_SECP_R1_384)
Jerry Yu53037892022-01-25 11:02:06 +08005771 MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384,
Manuel Pégourié-Gonnard275afe12023-09-18 11:19:20 +02005772 // == MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384)
5773#endif
Jerry Yu909df7b2022-01-22 11:56:27 +08005774
Gabor Mezei15b95a62022-05-09 16:37:58 +02005775 MBEDTLS_TLS_SIG_NONE
Jerry Yu713013f2022-01-17 18:16:35 +08005776};
Jerry Yu6106fdc2022-01-12 16:36:14 +08005777
Jerry Yu909df7b2022-01-22 11:56:27 +08005778/* NOTICE: see above */
5779#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
5780static uint16_t ssl_tls12_preset_suiteb_sig_algs[] = {
Yanray Wang1136fad2023-11-22 16:54:31 +08005781
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005782#if defined(PSA_WANT_ALG_SHA_256)
Valerio Settie9646ec2023-08-02 20:02:28 +02005783#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005784 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA256),
Jerry Yu713013f2022-01-17 18:16:35 +08005785#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01005786#endif /* PSA_WANT_ALG_SHA_256 */
Yanray Wang69ceb392023-11-22 16:32:39 +08005787
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005788#if defined(PSA_WANT_ALG_SHA_384)
Valerio Settie9646ec2023-08-02 20:02:28 +02005789#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005790 MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(MBEDTLS_SSL_SIG_ECDSA, MBEDTLS_SSL_HASH_SHA384),
Jerry Yu18c833e2022-01-25 10:55:47 +08005791#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01005792#endif /* PSA_WANT_ALG_SHA_384 */
Yanray Wang1136fad2023-11-22 16:54:31 +08005793
Gabor Mezei15b95a62022-05-09 16:37:58 +02005794 MBEDTLS_TLS_SIG_NONE
Hanno Becker9c6aa7b2021-08-10 13:50:43 +01005795};
Jerry Yu909df7b2022-01-22 11:56:27 +08005796#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
5797
Ronald Crone68ab4f2022-10-05 12:46:29 +02005798#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005799
Chien Wong4e9683e2023-12-28 17:07:43 +08005800static const uint16_t ssl_preset_suiteb_groups[] = {
Elena Uziunaite417d05f2024-07-04 17:46:30 +01005801#if defined(PSA_WANT_ECC_SECP_R1_256)
Brett Warrene0edc842021-08-17 09:53:13 +01005802 MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005803#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01005804#if defined(PSA_WANT_ECC_SECP_R1_384)
Brett Warrene0edc842021-08-17 09:53:13 +01005805 MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1,
Jaeden Amerod4311042019-06-03 08:27:16 +01005806#endif
Brett Warrene0edc842021-08-17 09:53:13 +01005807 MBEDTLS_SSL_IANA_TLS_GROUP_NONE
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005808};
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005809
Ronald Crone68ab4f2022-10-05 12:46:29 +02005810#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005811/* Function for checking `ssl_preset_*_sig_algs` and `ssl_tls12_preset_*_sig_algs`
Jerry Yu370e1462022-01-25 10:36:53 +08005812 * to make sure there are no duplicated signature algorithm entries. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02005813MBEDTLS_CHECK_RETURN_CRITICAL
Chien Wong4e9683e2023-12-28 17:07:43 +08005814static int ssl_check_no_sig_alg_duplication(const uint16_t *sig_algs)
Jerry Yu1a8b4812022-01-20 17:56:50 +08005815{
5816 size_t i, j;
5817 int ret = 0;
Jerry Yu909df7b2022-01-22 11:56:27 +08005818
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 for (i = 0; sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
5820 for (j = 0; j < i; j++) {
5821 if (sig_algs[i] != sig_algs[j]) {
Jerry Yuf377d642022-01-25 10:43:59 +08005822 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01005823 }
5824 mbedtls_printf(" entry(%04x,%" MBEDTLS_PRINTF_SIZET
5825 ") is duplicated at %" MBEDTLS_PRINTF_SIZET "\n",
5826 sig_algs[i], j, i);
Jerry Yuf377d642022-01-25 10:43:59 +08005827 ret = -1;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005828 }
5829 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005830 return ret;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005831}
5832
Ronald Crone68ab4f2022-10-05 12:46:29 +02005833#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005834
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005835/*
Tillmann Karras588ad502015-09-25 04:27:22 +02005836 * Load default in mbedtls_ssl_config
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005837 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005838int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5839 int endpoint, int transport, int preset)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005840{
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005841#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Janos Follath865b3eb2019-12-16 11:46:15 +00005842 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard8b431fb2015-05-11 12:54:52 +02005843#endif
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005844
Ronald Crone68ab4f2022-10-05 12:46:29 +02005845#if defined(MBEDTLS_DEBUG_C) && defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 if (ssl_check_no_sig_alg_duplication(ssl_preset_suiteb_sig_algs)) {
5847 mbedtls_printf("ssl_preset_suiteb_sig_algs has duplicated entries\n");
5848 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005849 }
5850
Gilles Peskine449bd832023-01-11 14:50:10 +01005851 if (ssl_check_no_sig_alg_duplication(ssl_preset_default_sig_algs)) {
5852 mbedtls_printf("ssl_preset_default_sig_algs has duplicated entries\n");
5853 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu1a8b4812022-01-20 17:56:50 +08005854 }
Jerry Yu909df7b2022-01-22 11:56:27 +08005855
5856#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005857 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_suiteb_sig_algs)) {
5858 mbedtls_printf("ssl_tls12_preset_suiteb_sig_algs has duplicated entries\n");
5859 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005860 }
5861
Gilles Peskine449bd832023-01-11 14:50:10 +01005862 if (ssl_check_no_sig_alg_duplication(ssl_tls12_preset_default_sig_algs)) {
5863 mbedtls_printf("ssl_tls12_preset_default_sig_algs has duplicated entries\n");
5864 return MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu909df7b2022-01-22 11:56:27 +08005865 }
5866#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Ronald Crone68ab4f2022-10-05 12:46:29 +02005867#endif /* MBEDTLS_DEBUG_C && MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1a8b4812022-01-20 17:56:50 +08005868
Manuel Pégourié-Gonnard0de074f2015-05-14 12:58:01 +02005869 /* Use the functions here so that they are covered in tests,
5870 * but otherwise access member directly for efficiency */
Gilles Peskine449bd832023-01-11 14:50:10 +01005871 mbedtls_ssl_conf_endpoint(conf, endpoint);
5872 mbedtls_ssl_conf_transport(conf, transport);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005873
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005874 /*
5875 * Things that are common to all presets
5876 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005877#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005878 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02005879 conf->authmode = MBEDTLS_SSL_VERIFY_REQUIRED;
5880#if defined(MBEDTLS_SSL_SESSION_TICKETS)
5881 conf->session_tickets = MBEDTLS_SSL_SESSION_TICKETS_ENABLED;
5882#endif
5883 }
5884#endif
5885
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005886#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
5887 conf->encrypt_then_mac = MBEDTLS_SSL_ETM_ENABLED;
5888#endif
5889
5890#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
5891 conf->extended_ms = MBEDTLS_SSL_EXTENDED_MS_ENABLED;
5892#endif
5893
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02005894#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005895 conf->f_cookie_write = ssl_cookie_write_dummy;
5896 conf->f_cookie_check = ssl_cookie_check_dummy;
5897#endif
5898
5899#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
5900 conf->anti_replay = MBEDTLS_SSL_ANTI_REPLAY_ENABLED;
5901#endif
5902
Janos Follath088ce432017-04-10 12:42:31 +01005903#if defined(MBEDTLS_SSL_SRV_C)
5904 conf->cert_req_ca_list = MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED;
TRodziewicz3946f792021-06-14 12:11:18 +02005905 conf->respect_cli_pref = MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER;
Janos Follath088ce432017-04-10 12:42:31 +01005906#endif
5907
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005908#if defined(MBEDTLS_SSL_PROTO_DTLS)
5909 conf->hs_timeout_min = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN;
5910 conf->hs_timeout_max = MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX;
5911#endif
5912
5913#if defined(MBEDTLS_SSL_RENEGOTIATION)
5914 conf->renego_max_records = MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005915 memset(conf->renego_period, 0x00, 2);
5916 memset(conf->renego_period + 2, 0xFF, 6);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005917#endif
5918
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005919#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01005920 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Hanno Beckere2defad2021-07-24 05:59:17 +01005921 const unsigned char dhm_p[] =
5922 MBEDTLS_DHM_RFC3526_MODP_2048_P_BIN;
5923 const unsigned char dhm_g[] =
5924 MBEDTLS_DHM_RFC3526_MODP_2048_G_BIN;
Hanno Becker00d0a682017-10-04 13:14:29 +01005925
Gilles Peskine449bd832023-01-11 14:50:10 +01005926 if ((ret = mbedtls_ssl_conf_dh_param_bin(conf,
5927 dhm_p, sizeof(dhm_p),
5928 dhm_g, sizeof(dhm_g))) != 0) {
5929 return ret;
Hanno Beckere2defad2021-07-24 05:59:17 +01005930 }
5931 }
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02005932#endif
5933
Ronald Cron6f135e12021-12-08 16:57:54 +01005934#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005935
5936#if defined(MBEDTLS_SSL_EARLY_DATA)
Yanray Wangd5ed36f2023-11-07 11:40:43 +08005937 mbedtls_ssl_conf_early_data(conf, MBEDTLS_SSL_EARLY_DATA_DISABLED);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005938#if defined(MBEDTLS_SSL_SRV_C)
Yanray Wang07517612023-11-07 11:47:36 +08005939 mbedtls_ssl_conf_max_early_data_size(conf, MBEDTLS_SSL_MAX_EARLY_DATA_SIZE);
Jerry Yu6ee56aa2022-12-06 17:47:22 +08005940#endif
5941#endif /* MBEDTLS_SSL_EARLY_DATA */
5942
Jerry Yud0766ec2022-09-22 10:46:57 +08005943#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005944 mbedtls_ssl_conf_new_session_tickets(
Gilles Peskine449bd832023-01-11 14:50:10 +01005945 conf, MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08005946#endif
Hanno Becker71f1ed62021-07-24 06:01:47 +01005947 /*
5948 * Allow all TLS 1.3 key exchange modes by default.
5949 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00005950 conf->tls13_kex_modes = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL;
Ronald Cron6f135e12021-12-08 16:57:54 +01005951#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01005952
Gilles Peskine449bd832023-01-11 14:50:10 +01005953 if (transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005954#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
XiaokangQian4d3a6042022-04-21 13:46:17 +00005955 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian060d8672022-04-21 09:24:56 +00005956 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005957#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005958 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian060d8672022-04-21 09:24:56 +00005959#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01005960 } else {
XiaokangQian4d3a6042022-04-21 13:46:17 +00005961#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron097ba142023-03-08 16:18:00 +01005962 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5963 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005964#elif defined(MBEDTLS_SSL_PROTO_TLS1_3)
5965 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5966 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
5967#elif defined(MBEDTLS_SSL_PROTO_TLS1_2)
5968 conf->min_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5969 conf->max_tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
5970#else
Gilles Peskine449bd832023-01-11 14:50:10 +01005971 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian4d3a6042022-04-21 13:46:17 +00005972#endif
5973 }
Glenn Strauss2dfcea22022-03-14 17:26:42 -04005974
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005975 /*
5976 * Preset-specific defaults
5977 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005978 switch (preset) {
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005979 /*
5980 * NSA Suite B
5981 */
5982 case MBEDTLS_SSL_PRESET_SUITEB:
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005983
Hanno Beckerd60b6c62021-04-29 12:04:11 +01005984 conf->ciphersuite_list = ssl_preset_suiteb_ciphersuites;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005985
5986#if defined(MBEDTLS_X509_CRT_PARSE_C)
5987 conf->cert_profile = &mbedtls_x509_crt_profile_suiteb;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005988#endif
5989
Ronald Crone68ab4f2022-10-05 12:46:29 +02005990#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08005991#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01005992 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08005993 conf->sig_algs = ssl_tls12_preset_suiteb_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08005995#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005996 conf->sig_algs = ssl_preset_suiteb_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02005997#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005998
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02005999#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006000 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006001#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006002 conf->group_list = ssl_preset_suiteb_groups;
Manuel Pégourié-Gonnardc98204e2015-08-11 04:21:01 +02006003 break;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006004
6005 /*
6006 * Default
6007 */
6008 default:
Ronald Cronf6606552022-03-15 11:23:25 +01006009
Hanno Beckerd60b6c62021-04-29 12:04:11 +01006010 conf->ciphersuite_list = mbedtls_ssl_list_ciphersuites();
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006011
6012#if defined(MBEDTLS_X509_CRT_PARSE_C)
6013 conf->cert_profile = &mbedtls_x509_crt_profile_default;
6014#endif
6015
Ronald Crone68ab4f2022-10-05 12:46:29 +02006016#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu909df7b2022-01-22 11:56:27 +08006017#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006018 if (mbedtls_ssl_conf_is_tls12_only(conf)) {
Jerry Yu909df7b2022-01-22 11:56:27 +08006019 conf->sig_algs = ssl_tls12_preset_default_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01006020 } else
Jerry Yu909df7b2022-01-22 11:56:27 +08006021#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006022 conf->sig_algs = ssl_preset_default_sig_algs;
Ronald Crone68ab4f2022-10-05 12:46:29 +02006023#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006024
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02006025#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Brett Warrene0edc842021-08-17 09:53:13 +01006026 conf->curve_list = NULL;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006027#endif
Brett Warrene0edc842021-08-17 09:53:13 +01006028 conf->group_list = ssl_preset_default_groups;
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02006029
6030#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
6031 conf->dhm_min_bitlen = 1024;
6032#endif
6033 }
6034
Gilles Peskine449bd832023-01-11 14:50:10 +01006035 return 0;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006036}
6037
6038/*
6039 * Free mbedtls_ssl_config
6040 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006041void mbedtls_ssl_config_free(mbedtls_ssl_config *conf)
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006042{
Troy-Butlerda73abc2024-04-02 13:37:31 -04006043 if (conf == NULL) {
6044 return;
6045 }
6046
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006047#if defined(MBEDTLS_DHM_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006048 mbedtls_mpi_free(&conf->dhm_P);
6049 mbedtls_mpi_free(&conf->dhm_G);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006050#endif
6051
Ronald Cron73fe8df2022-10-05 14:31:43 +02006052#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Neil Armstrong501c9322022-05-03 09:35:09 +02006053#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006054 if (!mbedtls_svc_key_id_is_null(conf->psk_opaque)) {
Neil Armstrong501c9322022-05-03 09:35:09 +02006055 conf->psk_opaque = MBEDTLS_SVC_KEY_ID_INIT;
6056 }
Neil Armstrong8ecd6682022-05-05 11:40:35 +02006057#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 if (conf->psk != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006059 mbedtls_zeroize_and_free(conf->psk, conf->psk_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006060 conf->psk = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006061 conf->psk_len = 0;
junyeonLEE316b1622017-12-20 16:29:30 +09006062 }
6063
Gilles Peskine449bd832023-01-11 14:50:10 +01006064 if (conf->psk_identity != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006065 mbedtls_zeroize_and_free(conf->psk_identity, conf->psk_identity_len);
Azim Khan27e8a122018-03-21 14:24:11 +00006066 conf->psk_identity = NULL;
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006067 conf->psk_identity_len = 0;
6068 }
Ronald Cron73fe8df2022-10-05 14:31:43 +02006069#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006070
6071#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 ssl_key_cert_free(conf->key_cert);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006073#endif
6074
Gilles Peskine449bd832023-01-11 14:50:10 +01006075 mbedtls_platform_zeroize(conf, sizeof(mbedtls_ssl_config));
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02006076}
6077
Manuel Pégourié-Gonnard5674a972015-10-19 15:14:03 +02006078#if defined(MBEDTLS_PK_C) && \
Valerio Settie9646ec2023-08-02 20:02:28 +02006079 (defined(MBEDTLS_RSA_C) || defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED))
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006080/*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006081 * Convert between MBEDTLS_PK_XXX and SSL_SIG_XXX
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006082 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006083unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk)
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006084{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006085#if defined(MBEDTLS_RSA_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006086 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_RSA)) {
6087 return MBEDTLS_SSL_SIG_RSA;
6088 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006089#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006090#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01006091 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECDSA)) {
6092 return MBEDTLS_SSL_SIG_ECDSA;
6093 }
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006094#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006095 return MBEDTLS_SSL_SIG_ANON;
Manuel Pégourié-Gonnard0d420492013-08-21 16:14:26 +02006096}
6097
Gilles Peskine449bd832023-01-11 14:50:10 +01006098unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type)
Hanno Becker7e5437a2017-04-28 17:15:26 +01006099{
Gilles Peskine449bd832023-01-11 14:50:10 +01006100 switch (type) {
Hanno Becker7e5437a2017-04-28 17:15:26 +01006101 case MBEDTLS_PK_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006102 return MBEDTLS_SSL_SIG_RSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006103 case MBEDTLS_PK_ECDSA:
6104 case MBEDTLS_PK_ECKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 return MBEDTLS_SSL_SIG_ECDSA;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006106 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006107 return MBEDTLS_SSL_SIG_ANON;
Hanno Becker7e5437a2017-04-28 17:15:26 +01006108 }
6109}
6110
Gilles Peskine449bd832023-01-11 14:50:10 +01006111mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006112{
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 switch (sig) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006114#if defined(MBEDTLS_RSA_C)
6115 case MBEDTLS_SSL_SIG_RSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 return MBEDTLS_PK_RSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006117#endif
Valerio Settie9646ec2023-08-02 20:02:28 +02006118#if defined(MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006119 case MBEDTLS_SSL_SIG_ECDSA:
Gilles Peskine449bd832023-01-11 14:50:10 +01006120 return MBEDTLS_PK_ECDSA;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006121#endif
6122 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006123 return MBEDTLS_PK_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006124 }
6125}
Valerio Settie9646ec2023-08-02 20:02:28 +02006126#endif /* MBEDTLS_PK_C &&
6127 ( MBEDTLS_RSA_C || MBEDTLS_KEY_EXCHANGE_ECDSA_CERT_REQ_ANY_ALLOWED_ENABLED ) */
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006128
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006129/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006130 * Convert from MBEDTLS_SSL_HASH_XXX to MBEDTLS_MD_XXX
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02006131 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006132mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash)
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006133{
Gilles Peskine449bd832023-01-11 14:50:10 +01006134 switch (hash) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01006135#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006136 case MBEDTLS_SSL_HASH_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006137 return MBEDTLS_MD_MD5;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006138#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006139#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006140 case MBEDTLS_SSL_HASH_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006141 return MBEDTLS_MD_SHA1;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006142#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01006143#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006144 case MBEDTLS_SSL_HASH_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006145 return MBEDTLS_MD_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006146#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006147#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006148 case MBEDTLS_SSL_HASH_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006149 return MBEDTLS_MD_SHA256;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006150#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006151#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006152 case MBEDTLS_SSL_HASH_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006153 return MBEDTLS_MD_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006154#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02006155#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006156 case MBEDTLS_SSL_HASH_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006157 return MBEDTLS_MD_SHA512;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006158#endif
6159 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006160 return MBEDTLS_MD_NONE;
Manuel Pégourié-Gonnarda20c58c2013-08-22 13:52:48 +02006161 }
6162}
6163
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006164/*
6165 * Convert from MBEDTLS_MD_XXX to MBEDTLS_SSL_HASH_XXX
6166 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006167unsigned char mbedtls_ssl_hash_from_md_alg(int md)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006168{
Gilles Peskine449bd832023-01-11 14:50:10 +01006169 switch (md) {
Elena Uziunaiteb66a9912024-05-10 14:25:58 +01006170#if defined(PSA_WANT_ALG_MD5)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006171 case MBEDTLS_MD_MD5:
Gilles Peskine449bd832023-01-11 14:50:10 +01006172 return MBEDTLS_SSL_HASH_MD5;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006173#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01006174#if defined(MBEDTLS_MD_CAN_SHA1)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006175 case MBEDTLS_MD_SHA1:
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 return MBEDTLS_SSL_HASH_SHA1;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006177#endif
Elena Uziunaitefcc9afa2024-05-23 14:43:22 +01006178#if defined(PSA_WANT_ALG_SHA_224)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006179 case MBEDTLS_MD_SHA224:
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 return MBEDTLS_SSL_HASH_SHA224;
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02006181#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006182#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006183 case MBEDTLS_MD_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 return MBEDTLS_SSL_HASH_SHA256;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006185#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006186#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006187 case MBEDTLS_MD_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01006188 return MBEDTLS_SSL_HASH_SHA384;
Mateusz Starzyk3352a532021-04-06 14:28:22 +02006189#endif
Gabor Mezeic15ef932024-06-13 12:53:54 +02006190#if defined(PSA_WANT_ALG_SHA_512)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006191 case MBEDTLS_MD_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 return MBEDTLS_SSL_HASH_SHA512;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006193#endif
6194 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 return MBEDTLS_SSL_HASH_NONE;
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006196 }
6197}
6198
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006199/*
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02006200 * Check if a curve proposed by the peer is in our list.
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02006201 * Return 0 if we're willing to use it, -1 otherwise.
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006202 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006203int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id)
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006204{
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006206
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 if (group_list == NULL) {
6208 return -1;
Brett Warrene0edc842021-08-17 09:53:13 +01006209 }
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006210
Gilles Peskine449bd832023-01-11 14:50:10 +01006211 for (; *group_list != 0; group_list++) {
6212 if (*group_list == tls_id) {
6213 return 0;
6214 }
6215 }
6216
6217 return -1;
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01006218}
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006219
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01006220#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006221/*
6222 * Same as mbedtls_ssl_check_curve_tls_id() but with a mbedtls_ecp_group_id.
6223 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006224int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id)
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006225{
Gilles Peskine449bd832023-01-11 14:50:10 +01006226 uint16_t tls_id = mbedtls_ssl_get_tls_id_from_ecp_group_id(grp_id);
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006227
Gilles Peskine449bd832023-01-11 14:50:10 +01006228 if (tls_id == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006229 return -1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07006231
Gilles Peskine449bd832023-01-11 14:50:10 +01006232 return mbedtls_ssl_check_curve_tls_id(ssl, tls_id);
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01006233}
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01006234#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Valerio Setti67419f02023-01-04 16:12:42 +01006235
Valerio Setti18c9fed2022-12-30 17:44:24 +01006236static const struct {
6237 uint16_t tls_id;
6238 mbedtls_ecp_group_id ecp_group_id;
6239 psa_ecc_family_t psa_family;
6240 uint16_t bits;
Valerio Setti18c9fed2022-12-30 17:44:24 +01006241} tls_id_match_table[] =
6242{
Elena Uziunaite24e24f22024-07-04 17:53:40 +01006243#if defined(PSA_WANT_ECC_SECP_R1_521)
Valerio Settiacd32c02023-06-29 18:06:29 +02006244 { 25, MBEDTLS_ECP_DP_SECP521R1, PSA_ECC_FAMILY_SECP_R1, 521 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006245#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01006246#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Valerio Settiacd32c02023-06-29 18:06:29 +02006247 { 28, MBEDTLS_ECP_DP_BP512R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 512 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006248#endif
Elena Uziunaite6b4cd482024-07-04 17:50:11 +01006249#if defined(PSA_WANT_ECC_SECP_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02006250 { 24, MBEDTLS_ECP_DP_SECP384R1, PSA_ECC_FAMILY_SECP_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006251#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01006252#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Valerio Settiacd32c02023-06-29 18:06:29 +02006253 { 27, MBEDTLS_ECP_DP_BP384R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 384 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006254#endif
Elena Uziunaite417d05f2024-07-04 17:46:30 +01006255#if defined(PSA_WANT_ECC_SECP_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02006256 { 23, MBEDTLS_ECP_DP_SECP256R1, PSA_ECC_FAMILY_SECP_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006257#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01006258#if defined(PSA_WANT_ECC_SECP_K1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02006259 { 22, MBEDTLS_ECP_DP_SECP256K1, PSA_ECC_FAMILY_SECP_K1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006260#endif
Elena Uziunaiteb8d10872024-07-05 10:51:40 +01006261#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Valerio Settiacd32c02023-06-29 18:06:29 +02006262 { 26, MBEDTLS_ECP_DP_BP256R1, PSA_ECC_FAMILY_BRAINPOOL_P_R1, 256 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006263#endif
Elena Uziunaiteeaa0cf02024-07-04 17:41:25 +01006264#if defined(PSA_WANT_ECC_SECP_R1_224)
Valerio Settiacd32c02023-06-29 18:06:29 +02006265 { 21, MBEDTLS_ECP_DP_SECP224R1, PSA_ECC_FAMILY_SECP_R1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006266#endif
Valerio Settidb6b4db2023-09-01 09:20:51 +02006267#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settiacd32c02023-06-29 18:06:29 +02006268 { 20, MBEDTLS_ECP_DP_SECP224K1, PSA_ECC_FAMILY_SECP_K1, 224 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006269#endif
Elena Uziunaitea3632862024-07-04 13:52:43 +01006270#if defined(PSA_WANT_ECC_SECP_R1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02006271 { 19, MBEDTLS_ECP_DP_SECP192R1, PSA_ECC_FAMILY_SECP_R1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006272#endif
Elena Uziunaite9e85c9f2024-07-04 18:37:34 +01006273#if defined(PSA_WANT_ECC_SECP_K1_192)
Valerio Settiacd32c02023-06-29 18:06:29 +02006274 { 18, MBEDTLS_ECP_DP_SECP192K1, PSA_ECC_FAMILY_SECP_K1, 192 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006275#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01006276#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Valerio Settiacd32c02023-06-29 18:06:29 +02006277 { 29, MBEDTLS_ECP_DP_CURVE25519, PSA_ECC_FAMILY_MONTGOMERY, 255 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006278#endif
Elena Uziunaite0b5d48e2024-07-05 11:48:23 +01006279#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Valerio Settiacd32c02023-06-29 18:06:29 +02006280 { 30, MBEDTLS_ECP_DP_CURVE448, PSA_ECC_FAMILY_MONTGOMERY, 448 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006281#endif
Valerio Settiacd32c02023-06-29 18:06:29 +02006282 { 0, MBEDTLS_ECP_DP_NONE, 0, 0 },
Valerio Setti18c9fed2022-12-30 17:44:24 +01006283};
6284
Gilles Peskine449bd832023-01-11 14:50:10 +01006285int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
Przemek Stekielda4fba62023-06-02 14:52:28 +02006286 psa_key_type_t *type,
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 size_t *bits)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006288{
Gilles Peskine449bd832023-01-11 14:50:10 +01006289 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6290 if (tls_id_match_table[i].tls_id == tls_id) {
Przemek Stekielda4fba62023-06-02 14:52:28 +02006291 if (type != NULL) {
6292 *type = PSA_KEY_TYPE_ECC_KEY_PAIR(tls_id_match_table[i].psa_family);
Gilles Peskine449bd832023-01-11 14:50:10 +01006293 }
6294 if (bits != NULL) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006295 *bits = tls_id_match_table[i].bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01006296 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006297 return PSA_SUCCESS;
6298 }
6299 }
6300
6301 return PSA_ERROR_NOT_SUPPORTED;
6302}
6303
Gilles Peskine449bd832023-01-11 14:50:10 +01006304mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006305{
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 for (int i = 0; tls_id_match_table[i].tls_id != 0; i++) {
6307 if (tls_id_match_table[i].tls_id == tls_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006308 return tls_id_match_table[i].ecp_group_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006309 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006310 }
6311
6312 return MBEDTLS_ECP_DP_NONE;
6313}
6314
Gilles Peskine449bd832023-01-11 14:50:10 +01006315uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006316{
Gilles Peskine449bd832023-01-11 14:50:10 +01006317 for (int i = 0; tls_id_match_table[i].ecp_group_id != MBEDTLS_ECP_DP_NONE;
6318 i++) {
6319 if (tls_id_match_table[i].ecp_group_id == grp_id) {
Valerio Setti18c9fed2022-12-30 17:44:24 +01006320 return tls_id_match_table[i].tls_id;
Gilles Peskine449bd832023-01-11 14:50:10 +01006321 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006322 }
6323
6324 return 0;
6325}
6326
Valerio Setti67419f02023-01-04 16:12:42 +01006327#if defined(MBEDTLS_DEBUG_C)
Valerio Settiacd32c02023-06-29 18:06:29 +02006328static const struct {
6329 uint16_t tls_id;
6330 const char *name;
6331} tls_id_curve_name_table[] =
6332{
Valerio Setti54e23792023-07-07 10:49:27 +02006333 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1, "secp521r1" },
6334 { MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1, "brainpoolP512r1" },
6335 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1, "secp384r1" },
6336 { MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1, "brainpoolP384r1" },
6337 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1, "secp256r1" },
6338 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1, "secp256k1" },
6339 { MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1, "brainpoolP256r1" },
6340 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1, "secp224r1" },
6341 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1, "secp224k1" },
6342 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1, "secp192r1" },
6343 { MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1, "secp192k1" },
6344 { MBEDTLS_SSL_IANA_TLS_GROUP_X25519, "x25519" },
6345 { MBEDTLS_SSL_IANA_TLS_GROUP_X448, "x448" },
Valerio Settiacd32c02023-06-29 18:06:29 +02006346 { 0, NULL },
6347};
6348
Gilles Peskine449bd832023-01-11 14:50:10 +01006349const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id)
Valerio Setti18c9fed2022-12-30 17:44:24 +01006350{
Valerio Settiacd32c02023-06-29 18:06:29 +02006351 for (int i = 0; tls_id_curve_name_table[i].tls_id != 0; i++) {
6352 if (tls_id_curve_name_table[i].tls_id == tls_id) {
6353 return tls_id_curve_name_table[i].name;
Gilles Peskine449bd832023-01-11 14:50:10 +01006354 }
Valerio Setti18c9fed2022-12-30 17:44:24 +01006355 }
6356
6357 return NULL;
6358}
Valerio Setti67419f02023-01-04 16:12:42 +01006359#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01006360
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006361#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006362int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
6363 const mbedtls_ssl_ciphersuite_t *ciphersuite,
6364 int cert_endpoint,
6365 uint32_t *flags)
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006366{
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006367 int ret = 0;
Dave Rodgmanc37ad442023-11-03 23:36:06 +00006368 unsigned int usage = 0;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006369 const char *ext_oid;
6370 size_t ext_len;
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006371
Gilles Peskine449bd832023-01-11 14:50:10 +01006372 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006373 /* Server part of the key exchange */
Gilles Peskine449bd832023-01-11 14:50:10 +01006374 switch (ciphersuite->key_exchange) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006375 case MBEDTLS_KEY_EXCHANGE_RSA:
6376 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006377 usage = MBEDTLS_X509_KU_KEY_ENCIPHERMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006378 break;
6379
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006380 case MBEDTLS_KEY_EXCHANGE_DHE_RSA:
6381 case MBEDTLS_KEY_EXCHANGE_ECDHE_RSA:
6382 case MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA:
6383 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006384 break;
6385
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006386 case MBEDTLS_KEY_EXCHANGE_ECDH_RSA:
6387 case MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA:
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006388 usage = MBEDTLS_X509_KU_KEY_AGREEMENT;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006389 break;
6390
6391 /* Don't use default: we want warnings when adding new values */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006392 case MBEDTLS_KEY_EXCHANGE_NONE:
6393 case MBEDTLS_KEY_EXCHANGE_PSK:
6394 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
6395 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02006396 case MBEDTLS_KEY_EXCHANGE_ECJPAKE:
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006397 usage = 0;
6398 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006399 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006400 /* Client auth: we only implement rsa_sign and mbedtls_ecdsa_sign for now */
6401 usage = MBEDTLS_X509_KU_DIGITAL_SIGNATURE;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006402 }
6403
Gilles Peskine449bd832023-01-11 14:50:10 +01006404 if (mbedtls_x509_crt_check_key_usage(cert, usage) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006405 *flags |= MBEDTLS_X509_BADCERT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006406 ret = -1;
6407 }
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006408
Gilles Peskine449bd832023-01-11 14:50:10 +01006409 if (cert_endpoint == MBEDTLS_SSL_IS_SERVER) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006410 ext_oid = MBEDTLS_OID_SERVER_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006411 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH);
6412 } else {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006413 ext_oid = MBEDTLS_OID_CLIENT_AUTH;
Gilles Peskine449bd832023-01-11 14:50:10 +01006414 ext_len = MBEDTLS_OID_SIZE(MBEDTLS_OID_CLIENT_AUTH);
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006415 }
6416
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 if (mbedtls_x509_crt_check_extended_key_usage(cert, ext_oid, ext_len) != 0) {
Manuel Pégourié-Gonnarde6028c92015-04-20 12:19:02 +01006418 *flags |= MBEDTLS_X509_BADCERT_EXT_KEY_USAGE;
Manuel Pégourié-Gonnarde6efa6f2015-04-20 11:01:48 +01006419 ret = -1;
6420 }
Manuel Pégourié-Gonnard0408fd12014-04-11 11:06:22 +02006421
Gilles Peskine449bd832023-01-11 14:50:10 +01006422 return ret;
Manuel Pégourié-Gonnard7f2a07d2014-04-09 09:50:57 +02006423}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02006424#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard3a306b92014-04-29 15:11:17 +02006425
Jerry Yu148165c2021-09-24 23:20:59 +08006426#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01006427int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6428 const mbedtls_md_type_t md,
6429 unsigned char *dst,
6430 size_t dst_len,
6431 size_t *olen)
Jerry Yu148165c2021-09-24 23:20:59 +08006432{
Ronald Cronf6893e12022-01-07 22:09:01 +01006433 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
6434 psa_hash_operation_t *hash_operation_to_clone;
6435 psa_hash_operation_t hash_operation = psa_hash_operation_init();
6436
Jerry Yu148165c2021-09-24 23:20:59 +08006437 *olen = 0;
Ronald Cronf6893e12022-01-07 22:09:01 +01006438
Gilles Peskine449bd832023-01-11 14:50:10 +01006439 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006440#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006441 case MBEDTLS_MD_SHA384:
6442 hash_operation_to_clone = &ssl->handshake->fin_sha384_psa;
6443 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006444#endif
6445
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006446#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006447 case MBEDTLS_MD_SHA256:
6448 hash_operation_to_clone = &ssl->handshake->fin_sha256_psa;
6449 break;
Ronald Cronf6893e12022-01-07 22:09:01 +01006450#endif
6451
Gilles Peskine449bd832023-01-11 14:50:10 +01006452 default:
6453 goto exit;
6454 }
6455
6456 status = psa_hash_clone(hash_operation_to_clone, &hash_operation);
6457 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006458 goto exit;
6459 }
6460
Gilles Peskine449bd832023-01-11 14:50:10 +01006461 status = psa_hash_finish(&hash_operation, dst, dst_len, olen);
6462 if (status != PSA_SUCCESS) {
Ronald Cronf6893e12022-01-07 22:09:01 +01006463 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006464 }
Ronald Cronf6893e12022-01-07 22:09:01 +01006465
6466exit:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006467#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006468 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04006469 (void) ssl;
6470#endif
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05006471 return PSA_TO_MBEDTLS_ERR(status);
Jerry Yu148165c2021-09-24 23:20:59 +08006472}
6473#else /* MBEDTLS_USE_PSA_CRYPTO */
6474
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006475#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006476MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006477static int ssl_get_handshake_transcript_sha384(mbedtls_ssl_context *ssl,
6478 unsigned char *dst,
6479 size_t dst_len,
6480 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006481{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006482 int ret;
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006483 mbedtls_md_context_t sha384;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006484
Gilles Peskine449bd832023-01-11 14:50:10 +01006485 if (dst_len < 48) {
6486 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6487 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006488
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006489 mbedtls_md_init(&sha384);
6490 ret = mbedtls_md_setup(&sha384, mbedtls_md_info_from_type(MBEDTLS_MD_SHA384), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006491 if (ret != 0) {
6492 goto exit;
6493 }
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006494 ret = mbedtls_md_clone(&sha384, &ssl->handshake->fin_sha384);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006495 if (ret != 0) {
6496 goto exit;
6497 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006498
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006499 if ((ret = mbedtls_md_finish(&sha384, dst)) != 0) {
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006500 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006501 goto exit;
6502 }
6503
6504 *olen = 48;
6505
6506exit:
6507
Manuel Pégourié-Gonnard02d55d52023-02-24 13:21:16 +01006508 mbedtls_md_free(&sha384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006509 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006510}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006511#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006512
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006513#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006514MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006515static int ssl_get_handshake_transcript_sha256(mbedtls_ssl_context *ssl,
6516 unsigned char *dst,
6517 size_t dst_len,
6518 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006519{
Jerry Yu24c0ec32021-09-09 14:21:07 +08006520 int ret;
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006521 mbedtls_md_context_t sha256;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006522
Gilles Peskine449bd832023-01-11 14:50:10 +01006523 if (dst_len < 32) {
6524 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6525 }
Jerry Yu24c0ec32021-09-09 14:21:07 +08006526
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006527 mbedtls_md_init(&sha256);
6528 ret = mbedtls_md_setup(&sha256, mbedtls_md_info_from_type(MBEDTLS_MD_SHA256), 0);
6529 if (ret != 0) {
6530 goto exit;
6531 }
6532 ret = mbedtls_md_clone(&sha256, &ssl->handshake->fin_sha256);
6533 if (ret != 0) {
6534 goto exit;
6535 }
Jerry Yuc5aef882021-12-23 20:15:02 +08006536
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006537 if ((ret = mbedtls_md_finish(&sha256, dst)) != 0) {
6538 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yu24c0ec32021-09-09 14:21:07 +08006539 goto exit;
6540 }
6541
6542 *olen = 32;
6543
6544exit:
6545
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01006546 mbedtls_md_free(&sha256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 return ret;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006548}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006549#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006550
Gilles Peskine449bd832023-01-11 14:50:10 +01006551int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
6552 const mbedtls_md_type_t md,
6553 unsigned char *dst,
6554 size_t dst_len,
6555 size_t *olen)
Jerry Yu24c0ec32021-09-09 14:21:07 +08006556{
Gilles Peskine449bd832023-01-11 14:50:10 +01006557 switch (md) {
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006558
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006559#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006560 case MBEDTLS_MD_SHA384:
6561 return ssl_get_handshake_transcript_sha384(ssl, dst, dst_len, olen);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006562#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006563
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006564#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006565 case MBEDTLS_MD_SHA256:
6566 return ssl_get_handshake_transcript_sha256(ssl, dst, dst_len, olen);
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006567#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006568
Gilles Peskine449bd832023-01-11 14:50:10 +01006569 default:
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006570#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006571 !defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01006572 (void) ssl;
6573 (void) dst;
6574 (void) dst_len;
6575 (void) olen;
Andrzej Kurek409248a2022-10-24 10:33:21 -04006576#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006577 break;
Jerry Yuc1ddeef2021-10-08 15:14:45 +08006578 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006579 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu24c0ec32021-09-09 14:21:07 +08006580}
XiaokangQian647719a2021-12-07 09:16:29 +00006581
Jerry Yu148165c2021-09-24 23:20:59 +08006582#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu24c0ec32021-09-09 14:21:07 +08006583
Ronald Crone68ab4f2022-10-05 12:46:29 +02006584#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei078e8032022-04-27 21:17:56 +02006585/* mbedtls_ssl_parse_sig_alg_ext()
6586 *
6587 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
6588 * value (TLS 1.3 RFC8446):
6589 * enum {
6590 * ....
6591 * ecdsa_secp256r1_sha256( 0x0403 ),
6592 * ecdsa_secp384r1_sha384( 0x0503 ),
6593 * ecdsa_secp521r1_sha512( 0x0603 ),
6594 * ....
6595 * } SignatureScheme;
6596 *
6597 * struct {
6598 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
6599 * } SignatureSchemeList;
6600 *
6601 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
6602 * value (TLS 1.2 RFC5246):
6603 * enum {
6604 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
6605 * sha512(6), (255)
6606 * } HashAlgorithm;
6607 *
6608 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
6609 * SignatureAlgorithm;
6610 *
6611 * struct {
6612 * HashAlgorithm hash;
6613 * SignatureAlgorithm signature;
6614 * } SignatureAndHashAlgorithm;
6615 *
6616 * SignatureAndHashAlgorithm
6617 * supported_signature_algorithms<2..2^16-2>;
6618 *
6619 * The TLS 1.3 signature algorithm extension was defined to be a compatible
6620 * generalization of the TLS 1.2 signature algorithm extension.
6621 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
6622 * `SignatureScheme` field of TLS 1.3
6623 *
6624 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006625int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
6626 const unsigned char *buf,
6627 const unsigned char *end)
Gabor Mezei078e8032022-04-27 21:17:56 +02006628{
6629 const unsigned char *p = buf;
6630 size_t supported_sig_algs_len = 0;
6631 const unsigned char *supported_sig_algs_end;
6632 uint16_t sig_alg;
6633 uint32_t common_idx = 0;
6634
Gilles Peskine449bd832023-01-11 14:50:10 +01006635 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
6636 supported_sig_algs_len = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006637 p += 2;
6638
Gilles Peskine449bd832023-01-11 14:50:10 +01006639 memset(ssl->handshake->received_sig_algs, 0,
6640 sizeof(ssl->handshake->received_sig_algs));
Gabor Mezei078e8032022-04-27 21:17:56 +02006641
Gilles Peskine449bd832023-01-11 14:50:10 +01006642 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, supported_sig_algs_len);
Gabor Mezei078e8032022-04-27 21:17:56 +02006643 supported_sig_algs_end = p + supported_sig_algs_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01006644 while (p < supported_sig_algs_end) {
6645 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, supported_sig_algs_end, 2);
6646 sig_alg = MBEDTLS_GET_UINT16_BE(p, 0);
Gabor Mezei078e8032022-04-27 21:17:56 +02006647 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01006648 MBEDTLS_SSL_DEBUG_MSG(4, ("received signature algorithm: 0x%x %s",
6649 sig_alg,
6650 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Jerry Yu2fe6c632022-06-29 10:02:38 +08006651#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01006652 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
6653 (!(mbedtls_ssl_sig_alg_is_supported(ssl, sig_alg) &&
6654 mbedtls_ssl_sig_alg_is_offered(ssl, sig_alg)))) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006655 continue;
Jerry Yu2fe6c632022-06-29 10:02:38 +08006656 }
6657#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Gabor Mezei078e8032022-04-27 21:17:56 +02006658
Gilles Peskine449bd832023-01-11 14:50:10 +01006659 MBEDTLS_SSL_DEBUG_MSG(4, ("valid signature algorithm: %s",
6660 mbedtls_ssl_sig_alg_to_str(sig_alg)));
Gabor Mezei078e8032022-04-27 21:17:56 +02006661
Gilles Peskine449bd832023-01-11 14:50:10 +01006662 if (common_idx + 1 < MBEDTLS_RECEIVED_SIG_ALGS_SIZE) {
Gabor Mezei078e8032022-04-27 21:17:56 +02006663 ssl->handshake->received_sig_algs[common_idx] = sig_alg;
6664 common_idx += 1;
6665 }
6666 }
6667 /* Check that we consumed all the message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006668 if (p != end) {
6669 MBEDTLS_SSL_DEBUG_MSG(1,
6670 ("Signature algorithms extension length misaligned"));
6671 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
6672 MBEDTLS_ERR_SSL_DECODE_ERROR);
6673 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Gabor Mezei078e8032022-04-27 21:17:56 +02006674 }
6675
Gilles Peskine449bd832023-01-11 14:50:10 +01006676 if (common_idx == 0) {
6677 MBEDTLS_SSL_DEBUG_MSG(3, ("no signature algorithm in common"));
6678 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
6679 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
6680 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gabor Mezei078e8032022-04-27 21:17:56 +02006681 }
6682
Gabor Mezei15b95a62022-05-09 16:37:58 +02006683 ssl->handshake->received_sig_algs[common_idx] = MBEDTLS_TLS_SIG_NONE;
Gilles Peskine449bd832023-01-11 14:50:10 +01006684 return 0;
Gabor Mezei078e8032022-04-27 21:17:56 +02006685}
6686
Ronald Crone68ab4f2022-10-05 12:46:29 +02006687#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei078e8032022-04-27 21:17:56 +02006688
Jerry Yudc7bd172022-02-17 13:44:15 +08006689#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
6690
6691#if defined(MBEDTLS_USE_PSA_CRYPTO)
6692
Gilles Peskine449bd832023-01-11 14:50:10 +01006693static psa_status_t setup_psa_key_derivation(psa_key_derivation_operation_t *derivation,
6694 mbedtls_svc_key_id_t key,
6695 psa_algorithm_t alg,
6696 const unsigned char *raw_psk, size_t raw_psk_length,
6697 const unsigned char *seed, size_t seed_length,
6698 const unsigned char *label, size_t label_length,
6699 const unsigned char *other_secret,
6700 size_t other_secret_length,
6701 size_t capacity)
Jerry Yudc7bd172022-02-17 13:44:15 +08006702{
6703 psa_status_t status;
6704
Gilles Peskine449bd832023-01-11 14:50:10 +01006705 status = psa_key_derivation_setup(derivation, alg);
6706 if (status != PSA_SUCCESS) {
6707 return status;
6708 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006709
Gilles Peskine449bd832023-01-11 14:50:10 +01006710 if (PSA_ALG_IS_TLS12_PRF(alg) || PSA_ALG_IS_TLS12_PSK_TO_MS(alg)) {
6711 status = psa_key_derivation_input_bytes(derivation,
6712 PSA_KEY_DERIVATION_INPUT_SEED,
6713 seed, seed_length);
6714 if (status != PSA_SUCCESS) {
6715 return status;
Przemek Stekiel1f027032022-04-05 17:12:11 +02006716 }
6717
Gilles Peskine449bd832023-01-11 14:50:10 +01006718 if (other_secret != NULL) {
6719 status = psa_key_derivation_input_bytes(derivation,
6720 PSA_KEY_DERIVATION_INPUT_OTHER_SECRET,
6721 other_secret, other_secret_length);
6722 if (status != PSA_SUCCESS) {
6723 return status;
6724 }
6725 }
6726
6727 if (mbedtls_svc_key_id_is_null(key)) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006728 status = psa_key_derivation_input_bytes(
6729 derivation, PSA_KEY_DERIVATION_INPUT_SECRET,
Gilles Peskine449bd832023-01-11 14:50:10 +01006730 raw_psk, raw_psk_length);
6731 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006732 status = psa_key_derivation_input_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01006733 derivation, PSA_KEY_DERIVATION_INPUT_SECRET, key);
Jerry Yudc7bd172022-02-17 13:44:15 +08006734 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006735 if (status != PSA_SUCCESS) {
6736 return status;
6737 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006738
Gilles Peskine449bd832023-01-11 14:50:10 +01006739 status = psa_key_derivation_input_bytes(derivation,
6740 PSA_KEY_DERIVATION_INPUT_LABEL,
6741 label, label_length);
6742 if (status != PSA_SUCCESS) {
6743 return status;
6744 }
6745 } else {
6746 return PSA_ERROR_NOT_SUPPORTED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006747 }
6748
Gilles Peskine449bd832023-01-11 14:50:10 +01006749 status = psa_key_derivation_set_capacity(derivation, capacity);
6750 if (status != PSA_SUCCESS) {
6751 return status;
6752 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006753
Gilles Peskine449bd832023-01-11 14:50:10 +01006754 return PSA_SUCCESS;
Jerry Yudc7bd172022-02-17 13:44:15 +08006755}
6756
Andrzej Kurek57d10632022-10-24 10:32:01 -04006757#if defined(PSA_WANT_ALG_SHA_384) || \
6758 defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006759MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006760static int tls_prf_generic(mbedtls_md_type_t md_type,
6761 const unsigned char *secret, size_t slen,
6762 const char *label,
6763 const unsigned char *random, size_t rlen,
6764 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006765{
6766 psa_status_t status;
6767 psa_algorithm_t alg;
6768 mbedtls_svc_key_id_t master_key = MBEDTLS_SVC_KEY_ID_INIT;
6769 psa_key_derivation_operation_t derivation =
6770 PSA_KEY_DERIVATION_OPERATION_INIT;
6771
Gilles Peskine449bd832023-01-11 14:50:10 +01006772 if (md_type == MBEDTLS_MD_SHA384) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006773 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01006774 } else {
Jerry Yudc7bd172022-02-17 13:44:15 +08006775 alg = PSA_ALG_TLS12_PRF(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01006776 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006777
6778 /* Normally a "secret" should be long enough to be impossible to
6779 * find by brute force, and in particular should not be empty. But
6780 * this PRF is also used to derive an IV, in particular in EAP-TLS,
6781 * and for this use case it makes sense to have a 0-length "secret".
6782 * Since the key API doesn't allow importing a key of length 0,
6783 * keep master_key=0, which setup_psa_key_derivation() understands
6784 * to mean a 0-length "secret" input. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006785 if (slen != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006786 psa_key_attributes_t key_attributes = psa_key_attributes_init();
Gilles Peskine449bd832023-01-11 14:50:10 +01006787 psa_set_key_usage_flags(&key_attributes, PSA_KEY_USAGE_DERIVE);
6788 psa_set_key_algorithm(&key_attributes, alg);
6789 psa_set_key_type(&key_attributes, PSA_KEY_TYPE_DERIVE);
Jerry Yudc7bd172022-02-17 13:44:15 +08006790
Gilles Peskine449bd832023-01-11 14:50:10 +01006791 status = psa_import_key(&key_attributes, secret, slen, &master_key);
6792 if (status != PSA_SUCCESS) {
6793 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6794 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006795 }
6796
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 status = setup_psa_key_derivation(&derivation,
6798 master_key, alg,
6799 NULL, 0,
6800 random, rlen,
6801 (unsigned char const *) label,
6802 (size_t) strlen(label),
6803 NULL, 0,
6804 dlen);
6805 if (status != PSA_SUCCESS) {
6806 psa_key_derivation_abort(&derivation);
6807 psa_destroy_key(master_key);
6808 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006809 }
6810
Gilles Peskine449bd832023-01-11 14:50:10 +01006811 status = psa_key_derivation_output_bytes(&derivation, dstbuf, dlen);
6812 if (status != PSA_SUCCESS) {
6813 psa_key_derivation_abort(&derivation);
6814 psa_destroy_key(master_key);
6815 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006816 }
6817
Gilles Peskine449bd832023-01-11 14:50:10 +01006818 status = psa_key_derivation_abort(&derivation);
6819 if (status != PSA_SUCCESS) {
6820 psa_destroy_key(master_key);
6821 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yudc7bd172022-02-17 13:44:15 +08006822 }
6823
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 if (!mbedtls_svc_key_id_is_null(master_key)) {
6825 status = psa_destroy_key(master_key);
6826 }
6827 if (status != PSA_SUCCESS) {
6828 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
6829 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006830
Gilles Peskine449bd832023-01-11 14:50:10 +01006831 return 0;
Jerry Yudc7bd172022-02-17 13:44:15 +08006832}
Andrzej Kurek57d10632022-10-24 10:32:01 -04006833#endif /* PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 */
Jerry Yudc7bd172022-02-17 13:44:15 +08006834#else /* MBEDTLS_USE_PSA_CRYPTO */
6835
Andrzej Kurek57d10632022-10-24 10:32:01 -04006836#if defined(MBEDTLS_MD_C) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006837 (defined(PSA_WANT_ALG_SHA_256) || \
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006838 defined(PSA_WANT_ALG_SHA_384))
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006839MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006840static int tls_prf_generic(mbedtls_md_type_t md_type,
6841 const unsigned char *secret, size_t slen,
6842 const char *label,
6843 const unsigned char *random, size_t rlen,
6844 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006845{
6846 size_t nb;
6847 size_t i, j, k, md_len;
6848 unsigned char *tmp;
6849 size_t tmp_len = 0;
6850 unsigned char h_i[MBEDTLS_MD_MAX_SIZE];
6851 const mbedtls_md_info_t *md_info;
6852 mbedtls_md_context_t md_ctx;
6853 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
6854
Gilles Peskine449bd832023-01-11 14:50:10 +01006855 mbedtls_md_init(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006856
Gilles Peskine449bd832023-01-11 14:50:10 +01006857 if ((md_info = mbedtls_md_info_from_type(md_type)) == NULL) {
6858 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
6859 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006860
Gilles Peskine449bd832023-01-11 14:50:10 +01006861 md_len = mbedtls_md_get_size(md_info);
Jerry Yudc7bd172022-02-17 13:44:15 +08006862
Gilles Peskine449bd832023-01-11 14:50:10 +01006863 tmp_len = md_len + strlen(label) + rlen;
6864 tmp = mbedtls_calloc(1, tmp_len);
6865 if (tmp == NULL) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006866 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
6867 goto exit;
6868 }
6869
Gilles Peskine449bd832023-01-11 14:50:10 +01006870 nb = strlen(label);
6871 memcpy(tmp + md_len, label, nb);
6872 memcpy(tmp + md_len + nb, random, rlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006873 nb += rlen;
6874
6875 /*
6876 * Compute P_<hash>(secret, label + random)[0..dlen]
6877 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006878 if ((ret = mbedtls_md_setup(&md_ctx, md_info, 1)) != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006879 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006880 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006881
Gilles Peskine449bd832023-01-11 14:50:10 +01006882 ret = mbedtls_md_hmac_starts(&md_ctx, secret, slen);
6883 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006884 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006885 }
6886 ret = mbedtls_md_hmac_update(&md_ctx, tmp + md_len, nb);
6887 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006888 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006889 }
6890 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6891 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006892 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006893 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006894
Gilles Peskine449bd832023-01-11 14:50:10 +01006895 for (i = 0; i < dlen; i += md_len) {
6896 ret = mbedtls_md_hmac_reset(&md_ctx);
6897 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006898 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006899 }
6900 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len + nb);
6901 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006902 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006903 }
6904 ret = mbedtls_md_hmac_finish(&md_ctx, h_i);
6905 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006906 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006907 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006908
Gilles Peskine449bd832023-01-11 14:50:10 +01006909 ret = mbedtls_md_hmac_reset(&md_ctx);
6910 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006911 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006912 }
6913 ret = mbedtls_md_hmac_update(&md_ctx, tmp, md_len);
6914 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006915 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006916 }
6917 ret = mbedtls_md_hmac_finish(&md_ctx, tmp);
6918 if (ret != 0) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006919 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006920 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006921
Gilles Peskine449bd832023-01-11 14:50:10 +01006922 k = (i + md_len > dlen) ? dlen % md_len : md_len;
Jerry Yudc7bd172022-02-17 13:44:15 +08006923
Gilles Peskine449bd832023-01-11 14:50:10 +01006924 for (j = 0; j < k; j++) {
Jerry Yudc7bd172022-02-17 13:44:15 +08006925 dstbuf[i + j] = h_i[j];
Gilles Peskine449bd832023-01-11 14:50:10 +01006926 }
Jerry Yudc7bd172022-02-17 13:44:15 +08006927 }
6928
6929exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006930 mbedtls_md_free(&md_ctx);
Jerry Yudc7bd172022-02-17 13:44:15 +08006931
Gilles Peskine449bd832023-01-11 14:50:10 +01006932 if (tmp != NULL) {
6933 mbedtls_platform_zeroize(tmp, tmp_len);
6934 }
Dave Rodgman29b9b2b2022-11-01 16:08:14 +00006935
Gilles Peskine449bd832023-01-11 14:50:10 +01006936 mbedtls_platform_zeroize(h_i, sizeof(h_i));
Jerry Yudc7bd172022-02-17 13:44:15 +08006937
Gilles Peskine449bd832023-01-11 14:50:10 +01006938 mbedtls_free(tmp);
Jerry Yudc7bd172022-02-17 13:44:15 +08006939
Gilles Peskine449bd832023-01-11 14:50:10 +01006940 return ret;
Jerry Yudc7bd172022-02-17 13:44:15 +08006941}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006942#endif /* MBEDTLS_MD_C && ( PSA_WANT_ALG_SHA_256 || PSA_WANT_ALG_SHA_384 ) */
Jerry Yudc7bd172022-02-17 13:44:15 +08006943#endif /* MBEDTLS_USE_PSA_CRYPTO */
6944
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006945#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006946MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006947static int tls_prf_sha256(const unsigned char *secret, size_t slen,
6948 const char *label,
6949 const unsigned char *random, size_t rlen,
6950 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006951{
Gilles Peskine449bd832023-01-11 14:50:10 +01006952 return tls_prf_generic(MBEDTLS_MD_SHA256, secret, slen,
6953 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006954}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006955#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006956
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006957#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006958MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006959static int tls_prf_sha384(const unsigned char *secret, size_t slen,
6960 const char *label,
6961 const unsigned char *random, size_t rlen,
6962 unsigned char *dstbuf, size_t dlen)
Jerry Yudc7bd172022-02-17 13:44:15 +08006963{
Gilles Peskine449bd832023-01-11 14:50:10 +01006964 return tls_prf_generic(MBEDTLS_MD_SHA384, secret, slen,
6965 label, random, rlen, dstbuf, dlen);
Jerry Yudc7bd172022-02-17 13:44:15 +08006966}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006967#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yudc7bd172022-02-17 13:44:15 +08006968
Jerry Yuf009d862022-02-17 14:01:37 +08006969/*
6970 * Set appropriate PRF function and other SSL / TLS1.2 functions
6971 *
6972 * Inputs:
Jerry Yuf009d862022-02-17 14:01:37 +08006973 * - hash associated with the ciphersuite (only used by TLS 1.2)
6974 *
6975 * Outputs:
6976 * - the tls_prf, calc_verify and calc_finished members of handshake structure
6977 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02006978MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01006979static int ssl_set_handshake_prfs(mbedtls_ssl_handshake_params *handshake,
6980 mbedtls_md_type_t hash)
Jerry Yuf009d862022-02-17 14:01:37 +08006981{
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01006982#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01006983 if (hash == MBEDTLS_MD_SHA384) {
Jerry Yuf009d862022-02-17 14:01:37 +08006984 handshake->tls_prf = tls_prf_sha384;
6985 handshake->calc_verify = ssl_calc_verify_tls_sha384;
6986 handshake->calc_finished = ssl_calc_finished_tls_sha384;
Gilles Peskine449bd832023-01-11 14:50:10 +01006987 } else
Jerry Yuf009d862022-02-17 14:01:37 +08006988#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01006989#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yuf009d862022-02-17 14:01:37 +08006990 {
Ronald Cron81591aa2022-03-07 09:05:51 +01006991 (void) hash;
Jerry Yuf009d862022-02-17 14:01:37 +08006992 handshake->tls_prf = tls_prf_sha256;
6993 handshake->calc_verify = ssl_calc_verify_tls_sha256;
6994 handshake->calc_finished = ssl_calc_finished_tls_sha256;
6995 }
Ronald Cron81591aa2022-03-07 09:05:51 +01006996#else
Jerry Yuf009d862022-02-17 14:01:37 +08006997 {
Jerry Yuf009d862022-02-17 14:01:37 +08006998 (void) handshake;
Ronald Cron81591aa2022-03-07 09:05:51 +01006999 (void) hash;
Gilles Peskine449bd832023-01-11 14:50:10 +01007000 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuf009d862022-02-17 14:01:37 +08007001 }
Ronald Cron81591aa2022-03-07 09:05:51 +01007002#endif
Jerry Yuf009d862022-02-17 14:01:37 +08007003
Gilles Peskine449bd832023-01-11 14:50:10 +01007004 return 0;
Jerry Yuf009d862022-02-17 14:01:37 +08007005}
Jerry Yud6ab2352022-02-17 14:03:43 +08007006
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007007/*
7008 * Compute master secret if needed
7009 *
7010 * Parameters:
7011 * [in/out] handshake
7012 * [in] resume, premaster, extended_ms, calc_verify, tls_prf
7013 * (PSA-PSK) ciphersuite_info, psk_opaque
7014 * [out] premaster (cleared)
7015 * [out] master
7016 * [in] ssl: optionally used for debugging, EMS and PSA-PSK
7017 * debug: conf->f_dbg, conf->p_dbg
7018 * EMS: passed to calc_verify (debug + session_negotiate)
Ronald Crona25cf582022-03-07 11:10:36 +01007019 * PSA-PSA: conf
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007020 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007021MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007022static int ssl_compute_master(mbedtls_ssl_handshake_params *handshake,
7023 unsigned char *master,
7024 const mbedtls_ssl_context *ssl)
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007025{
7026 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7027
7028 /* cf. RFC 5246, Section 8.1:
7029 * "The master secret is always exactly 48 bytes in length." */
7030 size_t const master_secret_len = 48;
7031
7032#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
7033 unsigned char session_hash[48];
7034#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
7035
7036 /* The label for the KDF used for key expansion.
7037 * This is either "master secret" or "extended master secret"
7038 * depending on whether the Extended Master Secret extension
7039 * is used. */
7040 char const *lbl = "master secret";
7041
Przemek Stekielae4ed302022-04-05 17:15:55 +02007042 /* The seed for the KDF used for key expansion.
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007043 * - If the Extended Master Secret extension is not used,
7044 * this is ClientHello.Random + ServerHello.Random
7045 * (see Sect. 8.1 in RFC 5246).
7046 * - If the Extended Master Secret extension is used,
7047 * this is the transcript of the handshake so far.
7048 * (see Sect. 4 in RFC 7627). */
Przemek Stekielae4ed302022-04-05 17:15:55 +02007049 unsigned char const *seed = handshake->randbytes;
7050 size_t seed_len = 64;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007051
7052#if !defined(MBEDTLS_DEBUG_C) && \
7053 !defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
7054 !(defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007055 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED))
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007056 ssl = NULL; /* make sure we don't use it except for those cases */
7057 (void) ssl;
7058#endif
7059
Gilles Peskine449bd832023-01-11 14:50:10 +01007060 if (handshake->resume != 0) {
7061 MBEDTLS_SSL_DEBUG_MSG(3, ("no premaster (session resumed)"));
7062 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007063 }
7064
7065#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine449bd832023-01-11 14:50:10 +01007066 if (handshake->extended_ms == MBEDTLS_SSL_EXTENDED_MS_ENABLED) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007067 lbl = "extended master secret";
Przemek Stekielae4ed302022-04-05 17:15:55 +02007068 seed = session_hash;
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01007069 ret = handshake->calc_verify(ssl, session_hash, &seed_len);
7070 if (ret != 0) {
7071 MBEDTLS_SSL_DEBUG_RET(1, "calc_verify", ret);
7072 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007073
Gilles Peskine449bd832023-01-11 14:50:10 +01007074 MBEDTLS_SSL_DEBUG_BUF(3, "session hash for extended master secret",
7075 session_hash, seed_len);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007076 }
Przemek Stekiel169bf0b2022-04-29 07:53:29 +02007077#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007078
Przemek Stekiel99114f32022-04-22 11:20:09 +02007079#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Przemek Stekiel8a4b7fd2022-04-28 09:22:22 +02007080 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007081 if (mbedtls_ssl_ciphersuite_uses_psk(handshake->ciphersuite_info) == 1) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007082 /* Perform PSK-to-MS expansion in a single step. */
7083 psa_status_t status;
7084 psa_algorithm_t alg;
7085 mbedtls_svc_key_id_t psk;
7086 psa_key_derivation_operation_t derivation =
7087 PSA_KEY_DERIVATION_OPERATION_INIT;
Dave Rodgman2eab4622023-10-05 13:30:37 +01007088 mbedtls_md_type_t hash_alg = (mbedtls_md_type_t) handshake->ciphersuite_info->mac;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007089
Gilles Peskine449bd832023-01-11 14:50:10 +01007090 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PSK-to-MS expansion"));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007091
Gilles Peskine449bd832023-01-11 14:50:10 +01007092 psk = mbedtls_ssl_get_opaque_psk(ssl);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007093
Gilles Peskine449bd832023-01-11 14:50:10 +01007094 if (hash_alg == MBEDTLS_MD_SHA384) {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007095 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_384);
Gilles Peskine449bd832023-01-11 14:50:10 +01007096 } else {
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007097 alg = PSA_ALG_TLS12_PSK_TO_MS(PSA_ALG_SHA_256);
Gilles Peskine449bd832023-01-11 14:50:10 +01007098 }
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007099
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007100 size_t other_secret_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007101 unsigned char *other_secret = NULL;
Przemek Stekielc2033402022-04-05 17:19:41 +02007102
Gilles Peskine449bd832023-01-11 14:50:10 +01007103 switch (handshake->ciphersuite_info->key_exchange) {
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007104 /* Provide other secret.
Przemek Stekiel51a1f362022-04-13 08:57:06 +02007105 * Other secret is stored in premaster, where first 2 bytes hold the
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007106 * length of the other key.
Przemek Stekielc2033402022-04-05 17:19:41 +02007107 */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007108 case MBEDTLS_KEY_EXCHANGE_RSA_PSK:
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007109 /* For RSA-PSK other key length is always 48 bytes. */
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007110 other_secret_len = 48;
7111 other_secret = handshake->premaster + 2;
7112 break;
7113 case MBEDTLS_KEY_EXCHANGE_ECDHE_PSK:
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007114 case MBEDTLS_KEY_EXCHANGE_DHE_PSK:
Przemek Stekiel19b80f82022-04-14 08:29:31 +02007115 other_secret_len = MBEDTLS_GET_UINT16_BE(handshake->premaster, 0);
7116 other_secret = handshake->premaster + 2;
7117 break;
7118 default:
7119 break;
Przemek Stekielc2033402022-04-05 17:19:41 +02007120 }
7121
Gilles Peskine449bd832023-01-11 14:50:10 +01007122 status = setup_psa_key_derivation(&derivation, psk, alg,
7123 ssl->conf->psk, ssl->conf->psk_len,
7124 seed, seed_len,
7125 (unsigned char const *) lbl,
7126 (size_t) strlen(lbl),
7127 other_secret, other_secret_len,
7128 master_secret_len);
7129 if (status != PSA_SUCCESS) {
7130 psa_key_derivation_abort(&derivation);
7131 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007132 }
7133
Gilles Peskine449bd832023-01-11 14:50:10 +01007134 status = psa_key_derivation_output_bytes(&derivation,
7135 master,
7136 master_secret_len);
7137 if (status != PSA_SUCCESS) {
7138 psa_key_derivation_abort(&derivation);
7139 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007140 }
7141
Gilles Peskine449bd832023-01-11 14:50:10 +01007142 status = psa_key_derivation_abort(&derivation);
7143 if (status != PSA_SUCCESS) {
7144 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7145 }
7146 } else
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007147#endif
7148 {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007149#if defined(MBEDTLS_USE_PSA_CRYPTO) && \
Gilles Peskine449bd832023-01-11 14:50:10 +01007150 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
7151 if (handshake->ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE) {
Neil Armstrongca7d5062022-05-31 14:43:23 +02007152 psa_status_t status;
7153 psa_algorithm_t alg = PSA_ALG_TLS12_ECJPAKE_TO_PMS;
7154 psa_key_derivation_operation_t derivation =
7155 PSA_KEY_DERIVATION_OPERATION_INIT;
7156
Gilles Peskine449bd832023-01-11 14:50:10 +01007157 MBEDTLS_SSL_DEBUG_MSG(2, ("perform PSA-based PMS KDF for ECJPAKE"));
Neil Armstrongca7d5062022-05-31 14:43:23 +02007158
7159 handshake->pmslen = PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE;
7160
Gilles Peskine449bd832023-01-11 14:50:10 +01007161 status = psa_key_derivation_setup(&derivation, alg);
7162 if (status != PSA_SUCCESS) {
7163 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007164 }
7165
Gilles Peskine449bd832023-01-11 14:50:10 +01007166 status = psa_key_derivation_set_capacity(&derivation,
7167 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
7168 if (status != PSA_SUCCESS) {
7169 psa_key_derivation_abort(&derivation);
7170 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007171 }
7172
Gilles Peskine449bd832023-01-11 14:50:10 +01007173 status = psa_pake_get_implicit_key(&handshake->psa_pake_ctx,
7174 &derivation);
7175 if (status != PSA_SUCCESS) {
7176 psa_key_derivation_abort(&derivation);
7177 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007178 }
7179
Gilles Peskine449bd832023-01-11 14:50:10 +01007180 status = psa_key_derivation_output_bytes(&derivation,
7181 handshake->premaster,
7182 handshake->pmslen);
7183 if (status != PSA_SUCCESS) {
7184 psa_key_derivation_abort(&derivation);
7185 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
7186 }
7187
7188 status = psa_key_derivation_abort(&derivation);
7189 if (status != PSA_SUCCESS) {
7190 return MBEDTLS_ERR_SSL_HW_ACCEL_FAILED;
Neil Armstrongca7d5062022-05-31 14:43:23 +02007191 }
7192 }
7193#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007194 ret = handshake->tls_prf(handshake->premaster, handshake->pmslen,
7195 lbl, seed, seed_len,
7196 master,
7197 master_secret_len);
7198 if (ret != 0) {
7199 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
7200 return ret;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007201 }
7202
Gilles Peskine449bd832023-01-11 14:50:10 +01007203 MBEDTLS_SSL_DEBUG_BUF(3, "premaster secret",
7204 handshake->premaster,
7205 handshake->pmslen);
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007206
Gilles Peskine449bd832023-01-11 14:50:10 +01007207 mbedtls_platform_zeroize(handshake->premaster,
7208 sizeof(handshake->premaster));
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007209 }
7210
Gilles Peskine449bd832023-01-11 14:50:10 +01007211 return 0;
Jerry Yu2a7b5ac2022-02-17 14:07:00 +08007212}
7213
Gilles Peskine449bd832023-01-11 14:50:10 +01007214int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl)
Jerry Yud62f87e2022-02-17 14:09:02 +08007215{
7216 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7217 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
7218 ssl->handshake->ciphersuite_info;
7219
Gilles Peskine449bd832023-01-11 14:50:10 +01007220 MBEDTLS_SSL_DEBUG_MSG(2, ("=> derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007221
7222 /* Set PRF, calc_verify and calc_finished function pointers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007223 ret = ssl_set_handshake_prfs(ssl->handshake,
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01007224 (mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01007225 if (ret != 0) {
7226 MBEDTLS_SSL_DEBUG_RET(1, "ssl_set_handshake_prfs", ret);
7227 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007228 }
7229
7230 /* Compute master secret if needed */
Gilles Peskine449bd832023-01-11 14:50:10 +01007231 ret = ssl_compute_master(ssl->handshake,
7232 ssl->session_negotiate->master,
7233 ssl);
7234 if (ret != 0) {
7235 MBEDTLS_SSL_DEBUG_RET(1, "ssl_compute_master", ret);
7236 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007237 }
7238
7239 /* Swap the client and server random values:
7240 * - MS derivation wanted client+server (RFC 5246 8.1)
7241 * - key derivation wants server+client (RFC 5246 6.3) */
7242 {
7243 unsigned char tmp[64];
Gilles Peskine449bd832023-01-11 14:50:10 +01007244 memcpy(tmp, ssl->handshake->randbytes, 64);
7245 memcpy(ssl->handshake->randbytes, tmp + 32, 32);
7246 memcpy(ssl->handshake->randbytes + 32, tmp, 32);
7247 mbedtls_platform_zeroize(tmp, sizeof(tmp));
Jerry Yud62f87e2022-02-17 14:09:02 +08007248 }
7249
7250 /* Populate transform structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01007251 ret = ssl_tls12_populate_transform(ssl->transform_negotiate,
7252 ssl->session_negotiate->ciphersuite,
7253 ssl->session_negotiate->master,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007254#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01007255 ssl->session_negotiate->encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02007256#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01007257 ssl->handshake->tls_prf,
7258 ssl->handshake->randbytes,
7259 ssl->tls_version,
7260 ssl->conf->endpoint,
7261 ssl);
7262 if (ret != 0) {
7263 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls12_populate_transform", ret);
7264 return ret;
Jerry Yud62f87e2022-02-17 14:09:02 +08007265 }
7266
7267 /* We no longer need Server/ClientHello.random values */
Gilles Peskine449bd832023-01-11 14:50:10 +01007268 mbedtls_platform_zeroize(ssl->handshake->randbytes,
7269 sizeof(ssl->handshake->randbytes));
Jerry Yud62f87e2022-02-17 14:09:02 +08007270
Gilles Peskine449bd832023-01-11 14:50:10 +01007271 MBEDTLS_SSL_DEBUG_MSG(2, ("<= derive keys"));
Jerry Yud62f87e2022-02-17 14:09:02 +08007272
Gilles Peskine449bd832023-01-11 14:50:10 +01007273 return 0;
Jerry Yud62f87e2022-02-17 14:09:02 +08007274}
Jerry Yu8392e0d2022-02-17 14:10:24 +08007275
Gilles Peskine449bd832023-01-11 14:50:10 +01007276int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007277{
Gilles Peskine449bd832023-01-11 14:50:10 +01007278 switch (md) {
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007279#if defined(PSA_WANT_ALG_SHA_384)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007280 case MBEDTLS_SSL_HASH_SHA384:
7281 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha384;
7282 break;
7283#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007284#if defined(PSA_WANT_ALG_SHA_256)
Ronald Cron4dcbca92022-03-07 10:21:40 +01007285 case MBEDTLS_SSL_HASH_SHA256:
7286 ssl->handshake->calc_verify = ssl_calc_verify_tls_sha256;
7287 break;
7288#endif
7289 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007290 return -1;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007291 }
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007292#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007293 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurekeabeb302022-10-17 07:52:51 -04007294 (void) ssl;
7295#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007296 return 0;
Ronald Cron4dcbca92022-03-07 10:21:40 +01007297}
7298
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007299#if defined(MBEDTLS_USE_PSA_CRYPTO)
7300static int ssl_calc_verify_tls_psa(const mbedtls_ssl_context *ssl,
7301 const psa_hash_operation_t *hs_op,
7302 size_t buffer_size,
7303 unsigned char *hash,
7304 size_t *hlen)
7305{
7306 psa_status_t status;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007307 psa_hash_operation_t cloned_op = psa_hash_operation_init();
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007308
7309#if !defined(MBEDTLS_DEBUG_C)
7310 (void) ssl;
7311#endif
7312 MBEDTLS_SSL_DEBUG_MSG(2, ("=> PSA calc verify"));
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007313 status = psa_hash_clone(hs_op, &cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007314 if (status != PSA_SUCCESS) {
7315 goto exit;
7316 }
7317
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007318 status = psa_hash_finish(&cloned_op, hash, buffer_size, hlen);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007319 if (status != PSA_SUCCESS) {
7320 goto exit;
7321 }
7322
7323 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated verify result", hash, *hlen);
7324 MBEDTLS_SSL_DEBUG_MSG(2, ("<= PSA calc verify"));
7325
7326exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007327 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007328 return mbedtls_md_error_from_psa(status);
7329}
7330#else
7331static int ssl_calc_verify_tls_legacy(const mbedtls_ssl_context *ssl,
7332 const mbedtls_md_context_t *hs_ctx,
7333 unsigned char *hash,
7334 size_t *hlen)
7335{
7336 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007337 mbedtls_md_context_t cloned_ctx;
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007338
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007339 mbedtls_md_init(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007340
7341#if !defined(MBEDTLS_DEBUG_C)
7342 (void) ssl;
7343#endif
7344 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc verify"));
7345
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007346 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007347 if (ret != 0) {
7348 goto exit;
7349 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007350 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007351 if (ret != 0) {
7352 goto exit;
7353 }
7354
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007355 ret = mbedtls_md_finish(&cloned_ctx, hash);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007356 if (ret != 0) {
7357 goto exit;
7358 }
7359
7360 *hlen = mbedtls_md_get_size(mbedtls_md_info_from_ctx(hs_ctx));
7361
7362 MBEDTLS_SSL_DEBUG_BUF(3, "calculated verify result", hash, *hlen);
7363 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc verify"));
7364
7365exit:
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02007366 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007367 return ret;
7368}
7369#endif /* MBEDTLS_USE_PSA_CRYPTO */
7370
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007371#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007372int ssl_calc_verify_tls_sha256(const mbedtls_ssl_context *ssl,
7373 unsigned char *hash,
7374 size_t *hlen)
Jerry Yu8392e0d2022-02-17 14:10:24 +08007375{
7376#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007377 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha256_psa, 32,
7378 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007379#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007380 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha256,
7381 hash, hlen);
Jerry Yu8392e0d2022-02-17 14:10:24 +08007382#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007383}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01007384#endif /* PSA_WANT_ALG_SHA_256 */
Jerry Yu8392e0d2022-02-17 14:10:24 +08007385
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007386#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01007387int ssl_calc_verify_tls_sha384(const mbedtls_ssl_context *ssl,
7388 unsigned char *hash,
7389 size_t *hlen)
Jerry Yuc1cb3842022-02-17 14:13:48 +08007390{
7391#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007392 return ssl_calc_verify_tls_psa(ssl, &ssl->handshake->fin_sha384_psa, 48,
7393 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007394#else
Manuel Pégourié-Gonnard74970662023-06-24 09:43:26 +02007395 return ssl_calc_verify_tls_legacy(ssl, &ssl->handshake->fin_sha384,
7396 hash, hlen);
Jerry Yuc1cb3842022-02-17 14:13:48 +08007397#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007398}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01007399#endif /* PSA_WANT_ALG_SHA_384 */
Jerry Yuc1cb3842022-02-17 14:13:48 +08007400
Neil Armstrong80f6f322022-05-03 17:56:38 +02007401#if !defined(MBEDTLS_USE_PSA_CRYPTO) && \
7402 defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007403int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex)
Jerry Yuce3dca42022-02-17 14:16:37 +08007404{
7405 unsigned char *p = ssl->handshake->premaster;
Gilles Peskine449bd832023-01-11 14:50:10 +01007406 unsigned char *end = p + sizeof(ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007407 const unsigned char *psk = NULL;
7408 size_t psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007409 int psk_ret = mbedtls_ssl_get_psk(ssl, &psk, &psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007410
Gilles Peskine449bd832023-01-11 14:50:10 +01007411 if (psk_ret == MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007412 /*
7413 * This should never happen because the existence of a PSK is always
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007414 * checked before calling this function.
7415 *
7416 * The exception is opaque DHE-PSK. For DHE-PSK fill premaster with
Przemek Stekiel8abcee92022-04-28 09:16:28 +02007417 * the shared secret without PSK.
Jerry Yuce3dca42022-02-17 14:16:37 +08007418 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007419 if (key_ex != MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
7420 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7421 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekielb293aaa2022-04-19 12:22:38 +02007422 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007423 }
7424
7425 /*
7426 * PMS = struct {
7427 * opaque other_secret<0..2^16-1>;
7428 * opaque psk<0..2^16-1>;
7429 * };
7430 * with "other_secret" depending on the particular key exchange
7431 */
7432#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007433 if (key_ex == MBEDTLS_KEY_EXCHANGE_PSK) {
7434 if (end - p < 2) {
7435 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7436 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007437
Gilles Peskine449bd832023-01-11 14:50:10 +01007438 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007439 p += 2;
7440
Gilles Peskine449bd832023-01-11 14:50:10 +01007441 if (end < p || (size_t) (end - p) < psk_len) {
7442 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7443 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007444
Gilles Peskine449bd832023-01-11 14:50:10 +01007445 memset(p, 0, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007446 p += psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007447 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007448#endif /* MBEDTLS_KEY_EXCHANGE_PSK_ENABLED */
7449#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 if (key_ex == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007451 /*
7452 * other_secret already set by the ClientKeyExchange message,
7453 * and is 48 bytes long
7454 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007455 if (end - p < 2) {
7456 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7457 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007458
7459 *p++ = 0;
7460 *p++ = 48;
7461 p += 48;
Gilles Peskine449bd832023-01-11 14:50:10 +01007462 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007463#endif /* MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED */
7464#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007465 if (key_ex == MBEDTLS_KEY_EXCHANGE_DHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007466 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7467 size_t len;
7468
7469 /* Write length only when we know the actual value */
Gilles Peskine449bd832023-01-11 14:50:10 +01007470 if ((ret = mbedtls_dhm_calc_secret(&ssl->handshake->dhm_ctx,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007471 p + 2, (size_t) (end - (p + 2)), &len,
Gilles Peskine449bd832023-01-11 14:50:10 +01007472 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7473 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_dhm_calc_secret", ret);
7474 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007475 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007476 MBEDTLS_PUT_UINT16_BE(len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007477 p += 2 + len;
7478
Gilles Peskine449bd832023-01-11 14:50:10 +01007479 MBEDTLS_SSL_DEBUG_MPI(3, "DHM: K ", &ssl->handshake->dhm_ctx.K);
7480 } else
Jerry Yuce3dca42022-02-17 14:16:37 +08007481#endif /* MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED */
Neil Armstrong80f6f322022-05-03 17:56:38 +02007482#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 if (key_ex == MBEDTLS_KEY_EXCHANGE_ECDHE_PSK) {
Jerry Yuce3dca42022-02-17 14:16:37 +08007484 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7485 size_t zlen;
7486
Gilles Peskine449bd832023-01-11 14:50:10 +01007487 if ((ret = mbedtls_ecdh_calc_secret(&ssl->handshake->ecdh_ctx, &zlen,
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007488 p + 2, (size_t) (end - (p + 2)),
Gilles Peskine449bd832023-01-11 14:50:10 +01007489 ssl->conf->f_rng, ssl->conf->p_rng)) != 0) {
7490 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ecdh_calc_secret", ret);
7491 return ret;
Jerry Yuce3dca42022-02-17 14:16:37 +08007492 }
7493
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 MBEDTLS_PUT_UINT16_BE(zlen, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007495 p += 2 + zlen;
7496
Gilles Peskine449bd832023-01-11 14:50:10 +01007497 MBEDTLS_SSL_DEBUG_ECDH(3, &ssl->handshake->ecdh_ctx,
7498 MBEDTLS_DEBUG_ECDH_Z);
7499 } else
Neil Armstrong80f6f322022-05-03 17:56:38 +02007500#endif /* MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED */
Jerry Yuce3dca42022-02-17 14:16:37 +08007501 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007502 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7503 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yuce3dca42022-02-17 14:16:37 +08007504 }
7505
7506 /* opaque psk<0..2^16-1>; */
Gilles Peskine449bd832023-01-11 14:50:10 +01007507 if (end - p < 2) {
7508 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7509 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007510
Gilles Peskine449bd832023-01-11 14:50:10 +01007511 MBEDTLS_PUT_UINT16_BE(psk_len, p, 0);
Jerry Yuce3dca42022-02-17 14:16:37 +08007512 p += 2;
7513
Gilles Peskine449bd832023-01-11 14:50:10 +01007514 if (end < p || (size_t) (end - p) < psk_len) {
7515 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
7516 }
Jerry Yuce3dca42022-02-17 14:16:37 +08007517
Gilles Peskine449bd832023-01-11 14:50:10 +01007518 memcpy(p, psk, psk_len);
Jerry Yuce3dca42022-02-17 14:16:37 +08007519 p += psk_len;
7520
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007521 ssl->handshake->pmslen = (size_t) (p - ssl->handshake->premaster);
Jerry Yuce3dca42022-02-17 14:16:37 +08007522
Gilles Peskine449bd832023-01-11 14:50:10 +01007523 return 0;
Jerry Yuce3dca42022-02-17 14:16:37 +08007524}
Neil Armstrong80f6f322022-05-03 17:56:38 +02007525#endif /* !MBEDTLS_USE_PSA_CRYPTO && MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yuc2c673d2022-02-17 14:20:39 +08007526
7527#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007528MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007529static int ssl_write_hello_request(mbedtls_ssl_context *ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007530
7531#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007532int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl)
Jerry Yuc2c673d2022-02-17 14:20:39 +08007533{
7534 /* If renegotiation is not enforced, retransmit until we would reach max
7535 * timeout if we were using the usual handshake doubling scheme */
Gilles Peskine449bd832023-01-11 14:50:10 +01007536 if (ssl->conf->renego_max_records < 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007537 uint32_t ratio = ssl->conf->hs_timeout_max / ssl->conf->hs_timeout_min + 1;
7538 unsigned char doublings = 1;
7539
Gilles Peskine449bd832023-01-11 14:50:10 +01007540 while (ratio != 0) {
Jerry Yuc2c673d2022-02-17 14:20:39 +08007541 ++doublings;
7542 ratio >>= 1;
7543 }
7544
Gilles Peskine449bd832023-01-11 14:50:10 +01007545 if (++ssl->renego_records_seen > doublings) {
7546 MBEDTLS_SSL_DEBUG_MSG(2, ("no longer retransmitting hello request"));
7547 return 0;
Jerry Yuc2c673d2022-02-17 14:20:39 +08007548 }
7549 }
7550
Gilles Peskine449bd832023-01-11 14:50:10 +01007551 return ssl_write_hello_request(ssl);
Jerry Yuc2c673d2022-02-17 14:20:39 +08007552}
7553#endif
7554#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_RENEGOTIATION */
Jerry Yud9526692022-02-17 14:23:47 +08007555
Jerry Yud9526692022-02-17 14:23:47 +08007556/*
7557 * Handshake functions
7558 */
7559#if !defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
7560/* No certificate support -> dummy functions */
Gilles Peskine449bd832023-01-11 14:50:10 +01007561int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007562{
7563 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7564 ssl->handshake->ciphersuite_info;
7565
Gilles Peskine449bd832023-01-11 14:50:10 +01007566 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007567
Gilles Peskine449bd832023-01-11 14:50:10 +01007568 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7569 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007570 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007571 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007572 }
7573
Gilles Peskine449bd832023-01-11 14:50:10 +01007574 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7575 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007576}
7577
Gilles Peskine449bd832023-01-11 14:50:10 +01007578int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007579{
7580 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7581 ssl->handshake->ciphersuite_info;
7582
Gilles Peskine449bd832023-01-11 14:50:10 +01007583 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007584
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7586 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007587 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007588 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007589 }
7590
Gilles Peskine449bd832023-01-11 14:50:10 +01007591 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
7592 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007593}
7594
7595#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
7596/* Some certificate support -> implement write and parse */
7597
Gilles Peskine449bd832023-01-11 14:50:10 +01007598int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007599{
7600 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
7601 size_t i, n;
7602 const mbedtls_x509_crt *crt;
7603 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7604 ssl->handshake->ciphersuite_info;
7605
Gilles Peskine449bd832023-01-11 14:50:10 +01007606 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007607
Gilles Peskine449bd832023-01-11 14:50:10 +01007608 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7609 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007610 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007611 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007612 }
7613
7614#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007615 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7616 if (ssl->handshake->client_auth == 0) {
7617 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007618 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007620 }
7621 }
7622#endif /* MBEDTLS_SSL_CLI_C */
7623#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007624 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7625 if (mbedtls_ssl_own_cert(ssl) == NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007626 /* Should never happen because we shouldn't have picked the
7627 * ciphersuite if we don't have a certificate. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007629 }
7630 }
7631#endif
7632
Gilles Peskine449bd832023-01-11 14:50:10 +01007633 MBEDTLS_SSL_DEBUG_CRT(3, "own certificate", mbedtls_ssl_own_cert(ssl));
Jerry Yud9526692022-02-17 14:23:47 +08007634
7635 /*
7636 * 0 . 0 handshake type
7637 * 1 . 3 handshake length
7638 * 4 . 6 length of all certs
7639 * 7 . 9 length of cert. 1
7640 * 10 . n-1 peer certificate
7641 * n . n+2 length of cert. 2
7642 * n+3 . ... upper level cert, etc.
7643 */
7644 i = 7;
Gilles Peskine449bd832023-01-11 14:50:10 +01007645 crt = mbedtls_ssl_own_cert(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007646
Gilles Peskine449bd832023-01-11 14:50:10 +01007647 while (crt != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007648 n = crt->raw.len;
Gilles Peskine449bd832023-01-11 14:50:10 +01007649 if (n > MBEDTLS_SSL_OUT_CONTENT_LEN - 3 - i) {
7650 MBEDTLS_SSL_DEBUG_MSG(1, ("certificate too large, %" MBEDTLS_PRINTF_SIZET
7651 " > %" MBEDTLS_PRINTF_SIZET,
7652 i + 3 + n, (size_t) MBEDTLS_SSL_OUT_CONTENT_LEN));
7653 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Jerry Yud9526692022-02-17 14:23:47 +08007654 }
7655
Gilles Peskine449bd832023-01-11 14:50:10 +01007656 ssl->out_msg[i] = MBEDTLS_BYTE_2(n);
7657 ssl->out_msg[i + 1] = MBEDTLS_BYTE_1(n);
7658 ssl->out_msg[i + 2] = MBEDTLS_BYTE_0(n);
Jerry Yud9526692022-02-17 14:23:47 +08007659
Gilles Peskine449bd832023-01-11 14:50:10 +01007660 i += 3; memcpy(ssl->out_msg + i, crt->raw.p, n);
Jerry Yud9526692022-02-17 14:23:47 +08007661 i += n; crt = crt->next;
7662 }
7663
Gilles Peskine449bd832023-01-11 14:50:10 +01007664 ssl->out_msg[4] = MBEDTLS_BYTE_2(i - 7);
7665 ssl->out_msg[5] = MBEDTLS_BYTE_1(i - 7);
7666 ssl->out_msg[6] = MBEDTLS_BYTE_0(i - 7);
Jerry Yud9526692022-02-17 14:23:47 +08007667
7668 ssl->out_msglen = i;
7669 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
7670 ssl->out_msg[0] = MBEDTLS_SSL_HS_CERTIFICATE;
7671
7672 ssl->state++;
7673
Gilles Peskine449bd832023-01-11 14:50:10 +01007674 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
7675 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
7676 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007677 }
7678
Gilles Peskine449bd832023-01-11 14:50:10 +01007679 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08007680
Gilles Peskine449bd832023-01-11 14:50:10 +01007681 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007682}
7683
7684#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
7685
7686#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007687MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007688static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7689 unsigned char *crt_buf,
7690 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007691{
7692 mbedtls_x509_crt const * const peer_crt = ssl->session->peer_cert;
7693
Gilles Peskine449bd832023-01-11 14:50:10 +01007694 if (peer_crt == NULL) {
7695 return -1;
7696 }
Jerry Yud9526692022-02-17 14:23:47 +08007697
Gilles Peskine449bd832023-01-11 14:50:10 +01007698 if (peer_crt->raw.len != crt_buf_len) {
7699 return -1;
7700 }
Jerry Yud9526692022-02-17 14:23:47 +08007701
Gilles Peskine449bd832023-01-11 14:50:10 +01007702 return memcmp(peer_crt->raw.p, crt_buf, peer_crt->raw.len);
Jerry Yud9526692022-02-17 14:23:47 +08007703}
7704#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007705MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007706static int ssl_check_peer_crt_unchanged(mbedtls_ssl_context *ssl,
7707 unsigned char *crt_buf,
7708 size_t crt_buf_len)
Jerry Yud9526692022-02-17 14:23:47 +08007709{
7710 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7711 unsigned char const * const peer_cert_digest =
7712 ssl->session->peer_cert_digest;
7713 mbedtls_md_type_t const peer_cert_digest_type =
7714 ssl->session->peer_cert_digest_type;
7715 mbedtls_md_info_t const * const digest_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01007716 mbedtls_md_info_from_type(peer_cert_digest_type);
Jerry Yud9526692022-02-17 14:23:47 +08007717 unsigned char tmp_digest[MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN];
7718 size_t digest_len;
7719
Gilles Peskine449bd832023-01-11 14:50:10 +01007720 if (peer_cert_digest == NULL || digest_info == NULL) {
7721 return -1;
7722 }
Jerry Yud9526692022-02-17 14:23:47 +08007723
Gilles Peskine449bd832023-01-11 14:50:10 +01007724 digest_len = mbedtls_md_get_size(digest_info);
7725 if (digest_len > MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN) {
7726 return -1;
7727 }
Jerry Yud9526692022-02-17 14:23:47 +08007728
Gilles Peskine449bd832023-01-11 14:50:10 +01007729 ret = mbedtls_md(digest_info, crt_buf, crt_buf_len, tmp_digest);
7730 if (ret != 0) {
7731 return -1;
7732 }
Jerry Yud9526692022-02-17 14:23:47 +08007733
Gilles Peskine449bd832023-01-11 14:50:10 +01007734 return memcmp(tmp_digest, peer_cert_digest, digest_len);
Jerry Yud9526692022-02-17 14:23:47 +08007735}
7736#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
7737#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7738
7739/*
7740 * Once the certificate message is read, parse it into a cert chain and
7741 * perform basic checks, but leave actual verification to the caller
7742 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007743MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007744static int ssl_parse_certificate_chain(mbedtls_ssl_context *ssl,
7745 mbedtls_x509_crt *chain)
Jerry Yud9526692022-02-17 14:23:47 +08007746{
7747 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
7748#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007749 int crt_cnt = 0;
Jerry Yud9526692022-02-17 14:23:47 +08007750#endif
7751 size_t i, n;
7752 uint8_t alert;
7753
Gilles Peskine449bd832023-01-11 14:50:10 +01007754 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
7755 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7756 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7757 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7758 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007759 }
7760
Gilles Peskine449bd832023-01-11 14:50:10 +01007761 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_CERTIFICATE) {
7762 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7763 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
7764 return MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
Jerry Yud9526692022-02-17 14:23:47 +08007765 }
7766
Gilles Peskine449bd832023-01-11 14:50:10 +01007767 if (ssl->in_hslen < mbedtls_ssl_hs_hdr_len(ssl) + 3 + 3) {
7768 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7769 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7770 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7771 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007772 }
7773
Gilles Peskine449bd832023-01-11 14:50:10 +01007774 i = mbedtls_ssl_hs_hdr_len(ssl);
Jerry Yud9526692022-02-17 14:23:47 +08007775
7776 /*
7777 * Same message structure as in mbedtls_ssl_write_certificate()
7778 */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007779 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007780
Gilles Peskine449bd832023-01-11 14:50:10 +01007781 if (ssl->in_msg[i] != 0 ||
7782 ssl->in_hslen != n + 3 + mbedtls_ssl_hs_hdr_len(ssl)) {
7783 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7784 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7785 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7786 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007787 }
7788
7789 /* Make &ssl->in_msg[i] point to the beginning of the CRT chain. */
7790 i += 3;
7791
7792 /* Iterate through and parse the CRTs in the provided chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007793 while (i < ssl->in_hslen) {
Jerry Yud9526692022-02-17 14:23:47 +08007794 /* Check that there's room for the next CRT's length fields. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007795 if (i + 3 > ssl->in_hslen) {
7796 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7797 mbedtls_ssl_send_alert_message(ssl,
7798 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7799 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7800 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007801 }
7802 /* In theory, the CRT can be up to 2**24 Bytes, but we don't support
7803 * anything beyond 2**16 ~ 64K. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007804 if (ssl->in_msg[i] != 0) {
7805 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7806 mbedtls_ssl_send_alert_message(ssl,
7807 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7808 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT);
7809 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007810 }
7811
7812 /* Read length of the next CRT in the chain. */
Dave Rodgmana3d0f612023-11-03 23:34:02 +00007813 n = MBEDTLS_GET_UINT16_BE(ssl->in_msg, i + 1);
Jerry Yud9526692022-02-17 14:23:47 +08007814 i += 3;
7815
Gilles Peskine449bd832023-01-11 14:50:10 +01007816 if (n < 128 || i + n > ssl->in_hslen) {
7817 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate message"));
7818 mbedtls_ssl_send_alert_message(ssl,
7819 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7820 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
7821 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08007822 }
7823
7824 /* Check if we're handling the first CRT in the chain. */
7825#if defined(MBEDTLS_SSL_RENEGOTIATION) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007826 if (crt_cnt++ == 0 &&
Jerry Yud9526692022-02-17 14:23:47 +08007827 ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007828 ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08007829 /* During client-side renegotiation, check that the server's
7830 * end-CRTs hasn't changed compared to the initial handshake,
7831 * mitigating the triple handshake attack. On success, reuse
7832 * the original end-CRT instead of parsing it again. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007833 MBEDTLS_SSL_DEBUG_MSG(3, ("Check that peer CRT hasn't changed during renegotiation"));
7834 if (ssl_check_peer_crt_unchanged(ssl,
7835 &ssl->in_msg[i],
7836 n) != 0) {
7837 MBEDTLS_SSL_DEBUG_MSG(1, ("new server cert during renegotiation"));
7838 mbedtls_ssl_send_alert_message(ssl,
7839 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
7840 MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED);
7841 return MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Jerry Yud9526692022-02-17 14:23:47 +08007842 }
7843
7844 /* Now we can safely free the original chain. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007845 ssl_clear_peer_cert(ssl->session);
Jerry Yud9526692022-02-17 14:23:47 +08007846 }
7847#endif /* MBEDTLS_SSL_RENEGOTIATION && MBEDTLS_SSL_CLI_C */
7848
7849 /* Parse the next certificate in the chain. */
7850#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007851 ret = mbedtls_x509_crt_parse_der(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007852#else
7853 /* If we don't need to store the CRT chain permanently, parse
7854 * it in-place from the input buffer instead of making a copy. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007855 ret = mbedtls_x509_crt_parse_der_nocopy(chain, ssl->in_msg + i, n);
Jerry Yud9526692022-02-17 14:23:47 +08007856#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Gilles Peskine449bd832023-01-11 14:50:10 +01007857 switch (ret) {
Jerry Yud9526692022-02-17 14:23:47 +08007858 case 0: /*ok*/
7859 case MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG + MBEDTLS_ERR_OID_NOT_FOUND:
7860 /* Ignore certificate with an unknown algorithm: maybe a
7861 prior certificate was already trusted. */
7862 break;
7863
7864 case MBEDTLS_ERR_X509_ALLOC_FAILED:
7865 alert = MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR;
7866 goto crt_parse_der_failed;
7867
7868 case MBEDTLS_ERR_X509_UNKNOWN_VERSION:
7869 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
7870 goto crt_parse_der_failed;
7871
7872 default:
7873 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01007874crt_parse_der_failed:
7875 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL, alert);
7876 MBEDTLS_SSL_DEBUG_RET(1, " mbedtls_x509_crt_parse_der", ret);
7877 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08007878 }
7879
7880 i += n;
7881 }
7882
Gilles Peskine449bd832023-01-11 14:50:10 +01007883 MBEDTLS_SSL_DEBUG_CRT(3, "peer certificate", chain);
7884 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007885}
7886
7887#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007888MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007889static int ssl_srv_check_client_no_crt_notification(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08007890{
Gilles Peskine449bd832023-01-11 14:50:10 +01007891 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
7892 return -1;
7893 }
Jerry Yud9526692022-02-17 14:23:47 +08007894
Gilles Peskine449bd832023-01-11 14:50:10 +01007895 if (ssl->in_hslen == 3 + mbedtls_ssl_hs_hdr_len(ssl) &&
Jerry Yud9526692022-02-17 14:23:47 +08007896 ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE &&
7897 ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01007898 memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl), "\0\0\0", 3) == 0) {
7899 MBEDTLS_SSL_DEBUG_MSG(1, ("peer has no certificate"));
7900 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08007901 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007902 return -1;
Jerry Yud9526692022-02-17 14:23:47 +08007903}
7904#endif /* MBEDTLS_SSL_SRV_C */
7905
7906/* Check if a certificate message is expected.
7907 * Return either
7908 * - SSL_CERTIFICATE_EXPECTED, or
7909 * - SSL_CERTIFICATE_SKIP
7910 * indicating whether a Certificate message is expected or not.
7911 */
7912#define SSL_CERTIFICATE_EXPECTED 0
7913#define SSL_CERTIFICATE_SKIP 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007914MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007915static int ssl_parse_certificate_coordinate(mbedtls_ssl_context *ssl,
7916 int authmode)
Jerry Yud9526692022-02-17 14:23:47 +08007917{
7918 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7919 ssl->handshake->ciphersuite_info;
7920
Gilles Peskine449bd832023-01-11 14:50:10 +01007921 if (!mbedtls_ssl_ciphersuite_uses_srv_cert(ciphersuite_info)) {
7922 return SSL_CERTIFICATE_SKIP;
7923 }
Jerry Yud9526692022-02-17 14:23:47 +08007924
7925#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
7927 if (ciphersuite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_RSA_PSK) {
7928 return SSL_CERTIFICATE_SKIP;
7929 }
Jerry Yud9526692022-02-17 14:23:47 +08007930
Gilles Peskine449bd832023-01-11 14:50:10 +01007931 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Jerry Yud9526692022-02-17 14:23:47 +08007932 ssl->session_negotiate->verify_result =
7933 MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01007934 return SSL_CERTIFICATE_SKIP;
Jerry Yud9526692022-02-17 14:23:47 +08007935 }
7936 }
7937#else
7938 ((void) authmode);
7939#endif /* MBEDTLS_SSL_SRV_C */
7940
Gilles Peskine449bd832023-01-11 14:50:10 +01007941 return SSL_CERTIFICATE_EXPECTED;
Jerry Yud9526692022-02-17 14:23:47 +08007942}
7943
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02007944MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01007945static int ssl_parse_certificate_verify(mbedtls_ssl_context *ssl,
7946 int authmode,
7947 mbedtls_x509_crt *chain,
7948 void *rs_ctx)
Jerry Yud9526692022-02-17 14:23:47 +08007949{
7950 int ret = 0;
7951 const mbedtls_ssl_ciphersuite_t *ciphersuite_info =
7952 ssl->handshake->ciphersuite_info;
7953 int have_ca_chain = 0;
7954
7955 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
7956 void *p_vrfy;
7957
Gilles Peskine449bd832023-01-11 14:50:10 +01007958 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
7959 return 0;
7960 }
Jerry Yud9526692022-02-17 14:23:47 +08007961
Gilles Peskine449bd832023-01-11 14:50:10 +01007962 if (ssl->f_vrfy != NULL) {
7963 MBEDTLS_SSL_DEBUG_MSG(3, ("Use context-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007964 f_vrfy = ssl->f_vrfy;
7965 p_vrfy = ssl->p_vrfy;
Gilles Peskine449bd832023-01-11 14:50:10 +01007966 } else {
7967 MBEDTLS_SSL_DEBUG_MSG(3, ("Use configuration-specific verification callback"));
Jerry Yud9526692022-02-17 14:23:47 +08007968 f_vrfy = ssl->conf->f_vrfy;
7969 p_vrfy = ssl->conf->p_vrfy;
7970 }
7971
7972 /*
7973 * Main check: verify certificate
7974 */
7975#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Gilles Peskine449bd832023-01-11 14:50:10 +01007976 if (ssl->conf->f_ca_cb != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007977 ((void) rs_ctx);
7978 have_ca_chain = 1;
7979
Gilles Peskine449bd832023-01-11 14:50:10 +01007980 MBEDTLS_SSL_DEBUG_MSG(3, ("use CA callback for X.509 CRT verification"));
Jerry Yud9526692022-02-17 14:23:47 +08007981 ret = mbedtls_x509_crt_verify_with_ca_cb(
7982 chain,
7983 ssl->conf->f_ca_cb,
7984 ssl->conf->p_ca_cb,
7985 ssl->conf->cert_profile,
7986 ssl->hostname,
7987 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01007988 f_vrfy, p_vrfy);
7989 } else
Jerry Yud9526692022-02-17 14:23:47 +08007990#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
7991 {
7992 mbedtls_x509_crt *ca_chain;
7993 mbedtls_x509_crl *ca_crl;
7994
7995#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01007996 if (ssl->handshake->sni_ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08007997 ca_chain = ssl->handshake->sni_ca_chain;
7998 ca_crl = ssl->handshake->sni_ca_crl;
Gilles Peskine449bd832023-01-11 14:50:10 +01007999 } else
Jerry Yud9526692022-02-17 14:23:47 +08008000#endif
8001 {
8002 ca_chain = ssl->conf->ca_chain;
8003 ca_crl = ssl->conf->ca_crl;
8004 }
8005
Gilles Peskine449bd832023-01-11 14:50:10 +01008006 if (ca_chain != NULL) {
Jerry Yud9526692022-02-17 14:23:47 +08008007 have_ca_chain = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01008008 }
Jerry Yud9526692022-02-17 14:23:47 +08008009
8010 ret = mbedtls_x509_crt_verify_restartable(
8011 chain,
8012 ca_chain, ca_crl,
8013 ssl->conf->cert_profile,
8014 ssl->hostname,
8015 &ssl->session_negotiate->verify_result,
Gilles Peskine449bd832023-01-11 14:50:10 +01008016 f_vrfy, p_vrfy, rs_ctx);
Jerry Yud9526692022-02-17 14:23:47 +08008017 }
8018
Gilles Peskine449bd832023-01-11 14:50:10 +01008019 if (ret != 0) {
8020 MBEDTLS_SSL_DEBUG_RET(1, "x509_verify_cert", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008021 }
8022
8023#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008024 if (ret == MBEDTLS_ERR_ECP_IN_PROGRESS) {
8025 return MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS;
8026 }
Jerry Yud9526692022-02-17 14:23:47 +08008027#endif
8028
8029 /*
8030 * Secondary checks: always done, but change 'ret' only if it was 0
8031 */
8032
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01008033#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Jerry Yud9526692022-02-17 14:23:47 +08008034 {
8035 const mbedtls_pk_context *pk = &chain->pk;
8036
Manuel Pégourié-Gonnard66b0d612022-06-17 10:49:29 +02008037 /* If certificate uses an EC key, make sure the curve is OK.
8038 * This is a public key, so it can't be opaque, so can_do() is a good
8039 * enough check to ensure pk_ec() is safe to use here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008040 if (mbedtls_pk_can_do(pk, MBEDTLS_PK_ECKEY)) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008041 /* and in the unlikely case the above assumption no longer holds
8042 * we are making sure that pk_ec() here does not return a NULL
8043 */
Valerio Settif9362b72023-11-29 08:42:27 +01008044 mbedtls_ecp_group_id grp_id = mbedtls_pk_get_ec_group_id(pk);
Valerio Settid0405092023-05-24 13:16:40 +02008045 if (grp_id == MBEDTLS_ECP_DP_NONE) {
8046 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid group ID"));
Gilles Peskine449bd832023-01-11 14:50:10 +01008047 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008048 }
Valerio Setti97207782023-05-18 18:59:06 +02008049 if (mbedtls_ssl_check_curve(ssl, grp_id) != 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008050 ssl->session_negotiate->verify_result |=
8051 MBEDTLS_X509_BADCERT_BAD_KEY;
8052
Gilles Peskine449bd832023-01-11 14:50:10 +01008053 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (EC key curve)"));
8054 if (ret == 0) {
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008055 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008056 }
Leonid Rozenboim19e59732022-08-08 16:52:38 -07008057 }
Jerry Yud9526692022-02-17 14:23:47 +08008058 }
8059 }
Elena Uziunaite8dde3b32024-07-05 12:10:21 +01008060#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Jerry Yud9526692022-02-17 14:23:47 +08008061
Gilles Peskine449bd832023-01-11 14:50:10 +01008062 if (mbedtls_ssl_check_cert_usage(chain,
8063 ciphersuite_info,
8064 !ssl->conf->endpoint,
8065 &ssl->session_negotiate->verify_result) != 0) {
8066 MBEDTLS_SSL_DEBUG_MSG(1, ("bad certificate (usage extensions)"));
8067 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008068 ret = MBEDTLS_ERR_SSL_BAD_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008069 }
Jerry Yud9526692022-02-17 14:23:47 +08008070 }
8071
8072 /* mbedtls_x509_crt_verify_with_profile is supposed to report a
8073 * verification failure through MBEDTLS_ERR_X509_CERT_VERIFY_FAILED,
8074 * with details encoded in the verification flags. All other kinds
8075 * of error codes, including those from the user provided f_vrfy
8076 * functions, are treated as fatal and lead to a failure of
8077 * ssl_parse_certificate even if verification was optional. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008078 if (authmode == MBEDTLS_SSL_VERIFY_OPTIONAL &&
8079 (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED ||
8080 ret == MBEDTLS_ERR_SSL_BAD_CERTIFICATE)) {
Jerry Yud9526692022-02-17 14:23:47 +08008081 ret = 0;
8082 }
8083
Gilles Peskine449bd832023-01-11 14:50:10 +01008084 if (have_ca_chain == 0 && authmode == MBEDTLS_SSL_VERIFY_REQUIRED) {
8085 MBEDTLS_SSL_DEBUG_MSG(1, ("got no CA chain"));
Jerry Yud9526692022-02-17 14:23:47 +08008086 ret = MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED;
8087 }
8088
Gilles Peskine449bd832023-01-11 14:50:10 +01008089 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008090 uint8_t alert;
8091
8092 /* The certificate may have been rejected for several reasons.
8093 Pick one and send the corresponding alert. Which alert to send
8094 may be a subject of debate in some cases. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008095 if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_OTHER) {
Jerry Yud9526692022-02-17 14:23:47 +08008096 alert = MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008097 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_CN_MISMATCH) {
Jerry Yud9526692022-02-17 14:23:47 +08008098 alert = MBEDTLS_SSL_ALERT_MSG_BAD_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008099 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008100 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008101 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXT_KEY_USAGE) {
Jerry Yud9526692022-02-17 14:23:47 +08008102 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008103 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NS_CERT_TYPE) {
Jerry Yud9526692022-02-17 14:23:47 +08008104 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008105 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_PK) {
Jerry Yud9526692022-02-17 14:23:47 +08008106 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008107 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_BAD_KEY) {
Jerry Yud9526692022-02-17 14:23:47 +08008108 alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT;
Gilles Peskine449bd832023-01-11 14:50:10 +01008109 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_EXPIRED) {
Jerry Yud9526692022-02-17 14:23:47 +08008110 alert = MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008111 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_REVOKED) {
Jerry Yud9526692022-02-17 14:23:47 +08008112 alert = MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008113 } else if (ssl->session_negotiate->verify_result & MBEDTLS_X509_BADCERT_NOT_TRUSTED) {
Jerry Yud9526692022-02-17 14:23:47 +08008114 alert = MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA;
Gilles Peskine449bd832023-01-11 14:50:10 +01008115 } else {
Jerry Yud9526692022-02-17 14:23:47 +08008116 alert = MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN;
Gilles Peskine449bd832023-01-11 14:50:10 +01008117 }
8118 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8119 alert);
Jerry Yud9526692022-02-17 14:23:47 +08008120 }
8121
8122#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008123 if (ssl->session_negotiate->verify_result != 0) {
8124 MBEDTLS_SSL_DEBUG_MSG(3, ("! Certificate verification flags %08x",
8125 (unsigned int) ssl->session_negotiate->verify_result));
8126 } else {
8127 MBEDTLS_SSL_DEBUG_MSG(3, ("Certificate verification flags clear"));
Jerry Yud9526692022-02-17 14:23:47 +08008128 }
8129#endif /* MBEDTLS_DEBUG_C */
8130
Gilles Peskine449bd832023-01-11 14:50:10 +01008131 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008132}
8133
8134#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008135MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008136static int ssl_remember_peer_crt_digest(mbedtls_ssl_context *ssl,
8137 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008138{
8139 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8140 /* Remember digest of the peer's end-CRT. */
8141 ssl->session_negotiate->peer_cert_digest =
Gilles Peskine449bd832023-01-11 14:50:10 +01008142 mbedtls_calloc(1, MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN);
8143 if (ssl->session_negotiate->peer_cert_digest == NULL) {
8144 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%d bytes) failed",
8145 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN));
8146 mbedtls_ssl_send_alert_message(ssl,
8147 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8148 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008149
Gilles Peskine449bd832023-01-11 14:50:10 +01008150 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yud9526692022-02-17 14:23:47 +08008151 }
8152
Gilles Peskine449bd832023-01-11 14:50:10 +01008153 ret = mbedtls_md(mbedtls_md_info_from_type(
8154 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE),
8155 start, len,
8156 ssl->session_negotiate->peer_cert_digest);
Jerry Yud9526692022-02-17 14:23:47 +08008157
8158 ssl->session_negotiate->peer_cert_digest_type =
8159 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE;
8160 ssl->session_negotiate->peer_cert_digest_len =
8161 MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN;
8162
Gilles Peskine449bd832023-01-11 14:50:10 +01008163 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008164}
8165
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008166MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008167static int ssl_remember_peer_pubkey(mbedtls_ssl_context *ssl,
8168 unsigned char *start, size_t len)
Jerry Yud9526692022-02-17 14:23:47 +08008169{
8170 unsigned char *end = start + len;
8171 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8172
8173 /* Make a copy of the peer's raw public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008174 mbedtls_pk_init(&ssl->handshake->peer_pubkey);
8175 ret = mbedtls_pk_parse_subpubkey(&start, end,
8176 &ssl->handshake->peer_pubkey);
8177 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008178 /* We should have parsed the public key before. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008179 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yud9526692022-02-17 14:23:47 +08008180 }
8181
Gilles Peskine449bd832023-01-11 14:50:10 +01008182 return 0;
Jerry Yud9526692022-02-17 14:23:47 +08008183}
8184#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8185
Gilles Peskine449bd832023-01-11 14:50:10 +01008186int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl)
Jerry Yud9526692022-02-17 14:23:47 +08008187{
8188 int ret = 0;
8189 int crt_expected;
8190#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
8191 const int authmode = ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET
8192 ? ssl->handshake->sni_authmode
8193 : ssl->conf->authmode;
8194#else
8195 const int authmode = ssl->conf->authmode;
8196#endif
8197 void *rs_ctx = NULL;
8198 mbedtls_x509_crt *chain = NULL;
8199
Gilles Peskine449bd832023-01-11 14:50:10 +01008200 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008201
Gilles Peskine449bd832023-01-11 14:50:10 +01008202 crt_expected = ssl_parse_certificate_coordinate(ssl, authmode);
8203 if (crt_expected == SSL_CERTIFICATE_SKIP) {
8204 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008205 goto exit;
8206 }
8207
8208#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008209 if (ssl->handshake->ecrs_enabled &&
8210 ssl->handshake->ecrs_state == ssl_ecrs_crt_verify) {
Jerry Yud9526692022-02-17 14:23:47 +08008211 chain = ssl->handshake->ecrs_peer_cert;
8212 ssl->handshake->ecrs_peer_cert = NULL;
8213 goto crt_verify;
8214 }
8215#endif
8216
Gilles Peskine449bd832023-01-11 14:50:10 +01008217 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008218 /* mbedtls_ssl_read_record may have sent an alert already. We
8219 let it decide whether to alert. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008220 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yud9526692022-02-17 14:23:47 +08008221 goto exit;
8222 }
8223
8224#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008225 if (ssl_srv_check_client_no_crt_notification(ssl) == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008226 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_MISSING;
8227
Gilles Peskine449bd832023-01-11 14:50:10 +01008228 if (authmode != MBEDTLS_SSL_VERIFY_OPTIONAL) {
Jerry Yud9526692022-02-17 14:23:47 +08008229 ret = MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE;
Gilles Peskine449bd832023-01-11 14:50:10 +01008230 }
Jerry Yud9526692022-02-17 14:23:47 +08008231
8232 goto exit;
8233 }
8234#endif /* MBEDTLS_SSL_SRV_C */
8235
8236 /* Clear existing peer CRT structure in case we tried to
8237 * reuse a session but it failed, and allocate a new one. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008238 ssl_clear_peer_cert(ssl->session_negotiate);
Jerry Yud9526692022-02-17 14:23:47 +08008239
Gilles Peskine449bd832023-01-11 14:50:10 +01008240 chain = mbedtls_calloc(1, sizeof(mbedtls_x509_crt));
8241 if (chain == NULL) {
8242 MBEDTLS_SSL_DEBUG_MSG(1, ("alloc(%" MBEDTLS_PRINTF_SIZET " bytes) failed",
8243 sizeof(mbedtls_x509_crt)));
8244 mbedtls_ssl_send_alert_message(ssl,
8245 MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8246 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
Jerry Yud9526692022-02-17 14:23:47 +08008247
8248 ret = MBEDTLS_ERR_SSL_ALLOC_FAILED;
8249 goto exit;
8250 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008251 mbedtls_x509_crt_init(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008252
Gilles Peskine449bd832023-01-11 14:50:10 +01008253 ret = ssl_parse_certificate_chain(ssl, chain);
8254 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008255 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008256 }
Jerry Yud9526692022-02-17 14:23:47 +08008257
8258#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008259 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008260 ssl->handshake->ecrs_state = ssl_ecrs_crt_verify;
Gilles Peskine449bd832023-01-11 14:50:10 +01008261 }
Jerry Yud9526692022-02-17 14:23:47 +08008262
8263crt_verify:
Gilles Peskine449bd832023-01-11 14:50:10 +01008264 if (ssl->handshake->ecrs_enabled) {
Jerry Yud9526692022-02-17 14:23:47 +08008265 rs_ctx = &ssl->handshake->ecrs_ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01008266 }
Jerry Yud9526692022-02-17 14:23:47 +08008267#endif
8268
Gilles Peskine449bd832023-01-11 14:50:10 +01008269 ret = ssl_parse_certificate_verify(ssl, authmode,
8270 chain, rs_ctx);
8271 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008272 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008273 }
Jerry Yud9526692022-02-17 14:23:47 +08008274
8275#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
8276 {
8277 unsigned char *crt_start, *pk_start;
8278 size_t crt_len, pk_len;
8279
8280 /* We parse the CRT chain without copying, so
8281 * these pointers point into the input buffer,
8282 * and are hence still valid after freeing the
8283 * CRT chain. */
8284
8285 crt_start = chain->raw.p;
8286 crt_len = chain->raw.len;
8287
8288 pk_start = chain->pk_raw.p;
8289 pk_len = chain->pk_raw.len;
8290
8291 /* Free the CRT structures before computing
8292 * digest and copying the peer's public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008293 mbedtls_x509_crt_free(chain);
8294 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008295 chain = NULL;
8296
Gilles Peskine449bd832023-01-11 14:50:10 +01008297 ret = ssl_remember_peer_crt_digest(ssl, crt_start, crt_len);
8298 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008299 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008300 }
Jerry Yud9526692022-02-17 14:23:47 +08008301
Gilles Peskine449bd832023-01-11 14:50:10 +01008302 ret = ssl_remember_peer_pubkey(ssl, pk_start, pk_len);
8303 if (ret != 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008304 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008305 }
Jerry Yud9526692022-02-17 14:23:47 +08008306 }
8307#else /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8308 /* Pass ownership to session structure. */
8309 ssl->session_negotiate->peer_cert = chain;
8310 chain = NULL;
8311#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
8312
Gilles Peskine449bd832023-01-11 14:50:10 +01008313 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse certificate"));
Jerry Yud9526692022-02-17 14:23:47 +08008314
8315exit:
8316
Gilles Peskine449bd832023-01-11 14:50:10 +01008317 if (ret == 0) {
Jerry Yud9526692022-02-17 14:23:47 +08008318 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008319 }
Jerry Yud9526692022-02-17 14:23:47 +08008320
8321#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01008322 if (ret == MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) {
Jerry Yud9526692022-02-17 14:23:47 +08008323 ssl->handshake->ecrs_peer_cert = chain;
8324 chain = NULL;
8325 }
8326#endif
8327
Gilles Peskine449bd832023-01-11 14:50:10 +01008328 if (chain != NULL) {
8329 mbedtls_x509_crt_free(chain);
8330 mbedtls_free(chain);
Jerry Yud9526692022-02-17 14:23:47 +08008331 }
8332
Gilles Peskine449bd832023-01-11 14:50:10 +01008333 return ret;
Jerry Yud9526692022-02-17 14:23:47 +08008334}
8335#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
8336
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008337static int ssl_calc_finished_tls_generic(mbedtls_ssl_context *ssl, void *ctx,
8338 unsigned char *padbuf, size_t hlen,
8339 unsigned char *buf, int from)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008340{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008341 unsigned int len = 12;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008342 const char *sender;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008343#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008344 psa_status_t status;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008345 psa_hash_operation_t *hs_op = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008346 psa_hash_operation_t cloned_op = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008347 size_t hash_size;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008348#else
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008349 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008350 mbedtls_md_context_t *hs_ctx = ctx;
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008351 mbedtls_md_context_t cloned_ctx;
8352 mbedtls_md_init(&cloned_ctx);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008353#endif
8354
8355 mbedtls_ssl_session *session = ssl->session_negotiate;
Gilles Peskine449bd832023-01-11 14:50:10 +01008356 if (!session) {
Jerry Yu615bd6f2022-02-17 14:25:15 +08008357 session = ssl->session;
Gilles Peskine449bd832023-01-11 14:50:10 +01008358 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008359
Gilles Peskine449bd832023-01-11 14:50:10 +01008360 sender = (from == MBEDTLS_SSL_IS_CLIENT)
Jerry Yu615bd6f2022-02-17 14:25:15 +08008361 ? "client finished"
8362 : "server finished";
8363
8364#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008365 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc PSA finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008366
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008367 status = psa_hash_clone(hs_op, &cloned_op);
Gilles Peskine449bd832023-01-11 14:50:10 +01008368 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008369 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008370 }
8371
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008372 status = psa_hash_finish(&cloned_op, padbuf, hlen, &hash_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01008373 if (status != PSA_SUCCESS) {
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008374 goto exit;
Jerry Yu615bd6f2022-02-17 14:25:15 +08008375 }
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008376 MBEDTLS_SSL_DEBUG_BUF(3, "PSA calculated padbuf", padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008377#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008378 MBEDTLS_SSL_DEBUG_MSG(2, ("=> calc finished tls"));
Jerry Yu615bd6f2022-02-17 14:25:15 +08008379
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008380 ret = mbedtls_md_setup(&cloned_ctx, mbedtls_md_info_from_ctx(hs_ctx), 0);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008381 if (ret != 0) {
8382 goto exit;
8383 }
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008384 ret = mbedtls_md_clone(&cloned_ctx, hs_ctx);
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +01008385 if (ret != 0) {
8386 goto exit;
8387 }
Jerry Yu615bd6f2022-02-17 14:25:15 +08008388
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008389 ret = mbedtls_md_finish(&cloned_ctx, padbuf);
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008390 if (ret != 0) {
8391 goto exit;
8392 }
8393#endif /* MBEDTLS_USE_PSA_CRYPTO */
8394
8395 MBEDTLS_SSL_DEBUG_BUF(4, "finished output", padbuf, hlen);
8396
Jerry Yu615bd6f2022-02-17 14:25:15 +08008397 /*
8398 * TLSv1.2:
8399 * hash = PRF( master, finished_label,
8400 * Hash( handshake ) )[0.11]
8401 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008402 ssl->handshake->tls_prf(session->master, 48, sender,
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008403 padbuf, hlen, buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008404
Gilles Peskine449bd832023-01-11 14:50:10 +01008405 MBEDTLS_SSL_DEBUG_BUF(3, "calc finished result", buf, len);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008406
Paul Elliottecb95be2023-08-11 16:41:04 +01008407 mbedtls_platform_zeroize(padbuf, hlen);
Jerry Yu615bd6f2022-02-17 14:25:15 +08008408
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008409 MBEDTLS_SSL_DEBUG_MSG(2, ("<= calc finished"));
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008410
8411exit:
8412#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008413 psa_hash_abort(&cloned_op);
Manuel Pégourié-Gonnard3761e9e2023-03-28 12:54:56 +02008414 return mbedtls_md_error_from_psa(status);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008415#else
Manuel Pégourié-Gonnardaaad2b62023-07-04 11:35:16 +02008416 mbedtls_md_free(&cloned_ctx);
Manuel Pégourié-Gonnarde1a4caa2023-02-06 10:14:25 +01008417 return ret;
8418#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu615bd6f2022-02-17 14:25:15 +08008419}
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008420
Elena Uziunaite0916cd72024-05-23 17:01:07 +01008421#if defined(PSA_WANT_ALG_SHA_256)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008422static int ssl_calc_finished_tls_sha256(
8423 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
8424{
8425 unsigned char padbuf[32];
8426 return ssl_calc_finished_tls_generic(ssl,
8427#if defined(MBEDTLS_USE_PSA_CRYPTO)
8428 &ssl->handshake->fin_sha256_psa,
8429#else
8430 &ssl->handshake->fin_sha256,
8431#endif
8432 padbuf, sizeof(padbuf),
8433 buf, from);
8434}
Elena Uziunaite0916cd72024-05-23 17:01:07 +01008435#endif /* PSA_WANT_ALG_SHA_256*/
Jerry Yu615bd6f2022-02-17 14:25:15 +08008436
Jerry Yub7ba49e2022-02-17 14:25:53 +08008437
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01008438#if defined(PSA_WANT_ALG_SHA_384)
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01008439static int ssl_calc_finished_tls_sha384(
Gilles Peskine449bd832023-01-11 14:50:10 +01008440 mbedtls_ssl_context *ssl, unsigned char *buf, int from)
Jerry Yub7ba49e2022-02-17 14:25:53 +08008441{
Jerry Yub7ba49e2022-02-17 14:25:53 +08008442 unsigned char padbuf[48];
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008443 return ssl_calc_finished_tls_generic(ssl,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008444#if defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008445 &ssl->handshake->fin_sha384_psa,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008446#else
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008447 &ssl->handshake->fin_sha384,
Jerry Yub7ba49e2022-02-17 14:25:53 +08008448#endif
Manuel Pégourié-Gonnardde332782023-06-24 10:13:41 +02008449 padbuf, sizeof(padbuf),
8450 buf, from);
Jerry Yub7ba49e2022-02-17 14:25:53 +08008451}
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01008452#endif /* PSA_WANT_ALG_SHA_384*/
Jerry Yub7ba49e2022-02-17 14:25:53 +08008453
Gilles Peskine449bd832023-01-11 14:50:10 +01008454void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl)
Jerry Yuaef00152022-02-17 14:27:31 +08008455{
Gilles Peskine449bd832023-01-11 14:50:10 +01008456 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008457
8458 /*
8459 * Free our handshake params
8460 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008461 mbedtls_ssl_handshake_free(ssl);
8462 mbedtls_free(ssl->handshake);
Jerry Yuaef00152022-02-17 14:27:31 +08008463 ssl->handshake = NULL;
8464
8465 /*
Shaun Case8b0ecbc2021-12-20 21:14:10 -08008466 * Free the previous transform and switch in the current one
Jerry Yuaef00152022-02-17 14:27:31 +08008467 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008468 if (ssl->transform) {
8469 mbedtls_ssl_transform_free(ssl->transform);
8470 mbedtls_free(ssl->transform);
Jerry Yuaef00152022-02-17 14:27:31 +08008471 }
8472 ssl->transform = ssl->transform_negotiate;
8473 ssl->transform_negotiate = NULL;
8474
Gilles Peskine449bd832023-01-11 14:50:10 +01008475 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup: final free"));
Jerry Yuaef00152022-02-17 14:27:31 +08008476}
8477
Gilles Peskine449bd832023-01-11 14:50:10 +01008478void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu2a9fff52022-02-17 14:28:51 +08008479{
8480 int resume = ssl->handshake->resume;
8481
Gilles Peskine449bd832023-01-11 14:50:10 +01008482 MBEDTLS_SSL_DEBUG_MSG(3, ("=> handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008483
8484#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008485 if (ssl->renego_status == MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008486 ssl->renego_status = MBEDTLS_SSL_RENEGOTIATION_DONE;
8487 ssl->renego_records_seen = 0;
8488 }
8489#endif
8490
8491 /*
8492 * Free the previous session and switch in the current one
8493 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008494 if (ssl->session) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008495#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
8496 /* RFC 7366 3.1: keep the EtM state */
8497 ssl->session_negotiate->encrypt_then_mac =
Gilles Peskine449bd832023-01-11 14:50:10 +01008498 ssl->session->encrypt_then_mac;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008499#endif
8500
Gilles Peskine449bd832023-01-11 14:50:10 +01008501 mbedtls_ssl_session_free(ssl->session);
8502 mbedtls_free(ssl->session);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008503 }
8504 ssl->session = ssl->session_negotiate;
8505 ssl->session_negotiate = NULL;
8506
8507 /*
8508 * Add cache entry
8509 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008510 if (ssl->conf->f_set_cache != NULL &&
Jerry Yu2a9fff52022-02-17 14:28:51 +08008511 ssl->session->id_len != 0 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01008512 resume == 0) {
8513 if (ssl->conf->f_set_cache(ssl->conf->p_cache,
8514 ssl->session->id,
8515 ssl->session->id_len,
8516 ssl->session) != 0) {
8517 MBEDTLS_SSL_DEBUG_MSG(1, ("cache did not store session"));
8518 }
Jerry Yu2a9fff52022-02-17 14:28:51 +08008519 }
8520
8521#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008522 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8523 ssl->handshake->flight != NULL) {
Jerry Yu2a9fff52022-02-17 14:28:51 +08008524 /* Cancel handshake timer */
Gilles Peskine449bd832023-01-11 14:50:10 +01008525 mbedtls_ssl_set_timer(ssl, 0);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008526
8527 /* Keep last flight around in case we need to resend it:
8528 * we need the handshake and transform structures for that */
Gilles Peskine449bd832023-01-11 14:50:10 +01008529 MBEDTLS_SSL_DEBUG_MSG(3, ("skip freeing handshake and transform"));
8530 } else
Jerry Yu2a9fff52022-02-17 14:28:51 +08008531#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008532 mbedtls_ssl_handshake_wrapup_free_hs_transform(ssl);
Jerry Yu2a9fff52022-02-17 14:28:51 +08008533
Jerry Yu5ed73ff2022-10-27 13:08:42 +08008534 ssl->state = MBEDTLS_SSL_HANDSHAKE_OVER;
Jerry Yu2a9fff52022-02-17 14:28:51 +08008535
Gilles Peskine449bd832023-01-11 14:50:10 +01008536 MBEDTLS_SSL_DEBUG_MSG(3, ("<= handshake wrapup"));
Jerry Yu2a9fff52022-02-17 14:28:51 +08008537}
8538
Gilles Peskine449bd832023-01-11 14:50:10 +01008539int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl)
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008540{
Dave Rodgmanc37ad442023-11-03 23:36:06 +00008541 int ret;
8542 unsigned int hash_len;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008543
Gilles Peskine449bd832023-01-11 14:50:10 +01008544 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008545
Gilles Peskine449bd832023-01-11 14:50:10 +01008546 mbedtls_ssl_update_out_pointers(ssl, ssl->transform_negotiate);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008547
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008548 ret = ssl->handshake->calc_finished(ssl, ssl->out_msg + 4, ssl->conf->endpoint);
8549 if (ret != 0) {
8550 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8551 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008552
8553 /*
8554 * RFC 5246 7.4.9 (Page 63) says 12 is the default length and ciphersuites
8555 * may define some other value. Currently (early 2016), no defined
8556 * ciphersuite does this (and this is unlikely to change as activity has
8557 * moved to TLS 1.3 now) so we can keep the hardcoded 12 here.
8558 */
8559 hash_len = 12;
8560
8561#if defined(MBEDTLS_SSL_RENEGOTIATION)
8562 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008563 memcpy(ssl->own_verify_data, ssl->out_msg + 4, hash_len);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008564#endif
8565
8566 ssl->out_msglen = 4 + hash_len;
8567 ssl->out_msgtype = MBEDTLS_SSL_MSG_HANDSHAKE;
8568 ssl->out_msg[0] = MBEDTLS_SSL_HS_FINISHED;
8569
8570 /*
8571 * In case of session resuming, invert the client and server
8572 * ChangeCipherSpec messages order.
8573 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008574 if (ssl->handshake->resume != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008575#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008576 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008577 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008578 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008579#endif
8580#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008581 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008582 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008583 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008584#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008585 } else {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008586 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008587 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008588
8589 /*
8590 * Switch to our negotiated transform and session parameters for outbound
8591 * data.
8592 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008593 MBEDTLS_SSL_DEBUG_MSG(3, ("switching to new transform spec for outbound data"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008594
8595#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008596 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008597 unsigned char i;
8598
8599 /* Remember current epoch settings for resending */
8600 ssl->handshake->alt_transform_out = ssl->transform_out;
Gilles Peskine449bd832023-01-11 14:50:10 +01008601 memcpy(ssl->handshake->alt_out_ctr, ssl->cur_out_ctr,
8602 sizeof(ssl->handshake->alt_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008603
8604 /* Set sequence_number to zero */
Gilles Peskine449bd832023-01-11 14:50:10 +01008605 memset(&ssl->cur_out_ctr[2], 0, sizeof(ssl->cur_out_ctr) - 2);
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008606
8607
8608 /* Increment epoch */
Gilles Peskine449bd832023-01-11 14:50:10 +01008609 for (i = 2; i > 0; i--) {
8610 if (++ssl->cur_out_ctr[i - 1] != 0) {
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008611 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01008612 }
8613 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008614
8615 /* The loop goes to its end iff the counter is wrapping */
Gilles Peskine449bd832023-01-11 14:50:10 +01008616 if (i == 0) {
8617 MBEDTLS_SSL_DEBUG_MSG(1, ("DTLS epoch would wrap"));
8618 return MBEDTLS_ERR_SSL_COUNTER_WRAPPING;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008619 }
Gilles Peskine449bd832023-01-11 14:50:10 +01008620 } else
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008621#endif /* MBEDTLS_SSL_PROTO_DTLS */
Gilles Peskine449bd832023-01-11 14:50:10 +01008622 memset(ssl->cur_out_ctr, 0, sizeof(ssl->cur_out_ctr));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008623
8624 ssl->transform_out = ssl->transform_negotiate;
8625 ssl->session_out = ssl->session_negotiate;
8626
8627#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008628 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8629 mbedtls_ssl_send_flight_completed(ssl);
8630 }
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008631#endif
8632
Gilles Peskine449bd832023-01-11 14:50:10 +01008633 if ((ret = mbedtls_ssl_write_handshake_msg(ssl)) != 0) {
8634 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_write_handshake_msg", ret);
8635 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008636 }
8637
8638#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008639 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM &&
8640 (ret = mbedtls_ssl_flight_transmit(ssl)) != 0) {
8641 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_flight_transmit", ret);
8642 return ret;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008643 }
8644#endif
8645
Gilles Peskine449bd832023-01-11 14:50:10 +01008646 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write finished"));
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008647
Gilles Peskine449bd832023-01-11 14:50:10 +01008648 return 0;
Jerry Yu3c8e47b2022-02-17 14:30:01 +08008649}
8650
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008651#define SSL_MAX_HASH_LEN 12
8652
Gilles Peskine449bd832023-01-11 14:50:10 +01008653int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl)
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008654{
8655 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
8656 unsigned int hash_len = 12;
8657 unsigned char buf[SSL_MAX_HASH_LEN];
8658
Gilles Peskine449bd832023-01-11 14:50:10 +01008659 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008660
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01008661 ret = ssl->handshake->calc_finished(ssl, buf, ssl->conf->endpoint ^ 1);
8662 if (ret != 0) {
8663 MBEDTLS_SSL_DEBUG_RET(1, "calc_finished", ret);
8664 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008665
Gilles Peskine449bd832023-01-11 14:50:10 +01008666 if ((ret = mbedtls_ssl_read_record(ssl, 1)) != 0) {
8667 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_read_record", ret);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008668 goto exit;
8669 }
8670
Gilles Peskine449bd832023-01-11 14:50:10 +01008671 if (ssl->in_msgtype != MBEDTLS_SSL_MSG_HANDSHAKE) {
8672 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8673 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8674 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008675 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8676 goto exit;
8677 }
8678
Gilles Peskine449bd832023-01-11 14:50:10 +01008679 if (ssl->in_msg[0] != MBEDTLS_SSL_HS_FINISHED) {
8680 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8681 MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008682 ret = MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE;
8683 goto exit;
8684 }
8685
Gilles Peskine449bd832023-01-11 14:50:10 +01008686 if (ssl->in_hslen != mbedtls_ssl_hs_hdr_len(ssl) + hash_len) {
8687 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8688 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8689 MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008690 ret = MBEDTLS_ERR_SSL_DECODE_ERROR;
8691 goto exit;
8692 }
8693
Gilles Peskine449bd832023-01-11 14:50:10 +01008694 if (mbedtls_ct_memcmp(ssl->in_msg + mbedtls_ssl_hs_hdr_len(ssl),
8695 buf, hash_len) != 0) {
8696 MBEDTLS_SSL_DEBUG_MSG(1, ("bad finished message"));
8697 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
8698 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008699 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
8700 goto exit;
8701 }
8702
8703#if defined(MBEDTLS_SSL_RENEGOTIATION)
8704 ssl->verify_data_len = hash_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008705 memcpy(ssl->peer_verify_data, buf, hash_len);
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008706#endif
8707
Gilles Peskine449bd832023-01-11 14:50:10 +01008708 if (ssl->handshake->resume != 0) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008709#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008710 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008711 ssl->state = MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC;
Gilles Peskine449bd832023-01-11 14:50:10 +01008712 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008713#endif
8714#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01008715 if (ssl->conf->endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008716 ssl->state = MBEDTLS_SSL_HANDSHAKE_WRAPUP;
Gilles Peskine449bd832023-01-11 14:50:10 +01008717 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008718#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008719 } else {
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008720 ssl->state++;
Gilles Peskine449bd832023-01-11 14:50:10 +01008721 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008722
8723#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008724 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
8725 mbedtls_ssl_recv_flight_completed(ssl);
8726 }
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008727#endif
8728
Gilles Peskine449bd832023-01-11 14:50:10 +01008729 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse finished"));
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008730
8731exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008732 mbedtls_platform_zeroize(buf, hash_len);
8733 return ret;
Jerry Yu0b3d7c12022-02-17 14:30:51 +08008734}
8735
Jerry Yu392112c2022-02-17 14:34:10 +08008736#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
8737/*
8738 * Helper to get TLS 1.2 PRF from ciphersuite
8739 * (Duplicates bits of logic from ssl_set_handshake_prfs().)
8740 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008741static tls_prf_fn ssl_tls12prf_from_cs(int ciphersuite_id)
Jerry Yu392112c2022-02-17 14:34:10 +08008742{
Jerry Yu392112c2022-02-17 14:34:10 +08008743 const mbedtls_ssl_ciphersuite_t * const ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01008744 mbedtls_ssl_ciphersuite_from_id(ciphersuite_id);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01008745#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008746 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA384) {
8747 return tls_prf_sha384;
8748 } else
Jerry Yu392112c2022-02-17 14:34:10 +08008749#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01008750#if defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008751 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008752 if (ciphersuite_info != NULL && ciphersuite_info->mac == MBEDTLS_MD_SHA256) {
8753 return tls_prf_sha256;
8754 }
Andrzej Kurek894edde2022-09-29 06:31:14 -04008755 }
8756#endif
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01008757#if !defined(PSA_WANT_ALG_SHA_384) && \
Elena Uziunaite0916cd72024-05-23 17:01:07 +01008758 !defined(PSA_WANT_ALG_SHA_256)
Andrzej Kurek894edde2022-09-29 06:31:14 -04008759 (void) ciphersuite_info;
8760#endif
Andrzej Kurekeabeb302022-10-17 07:52:51 -04008761
Gilles Peskine449bd832023-01-11 14:50:10 +01008762 return NULL;
Jerry Yu392112c2022-02-17 14:34:10 +08008763}
8764#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Jerry Yue93ffcd2022-02-17 14:37:06 +08008765
Gilles Peskine449bd832023-01-11 14:50:10 +01008766static mbedtls_tls_prf_types tls_prf_get_type(mbedtls_ssl_tls_prf_cb *tls_prf)
Jerry Yue93ffcd2022-02-17 14:37:06 +08008767{
8768 ((void) tls_prf);
Elena Uziunaiteb476d4b2024-05-23 15:33:41 +01008769#if defined(PSA_WANT_ALG_SHA_384)
Gilles Peskine449bd832023-01-11 14:50:10 +01008770 if (tls_prf == tls_prf_sha384) {
8771 return MBEDTLS_SSL_TLS_PRF_SHA384;
8772 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008773#endif
Elena Uziunaite0916cd72024-05-23 17:01:07 +01008774#if defined(PSA_WANT_ALG_SHA_256)
Gilles Peskine449bd832023-01-11 14:50:10 +01008775 if (tls_prf == tls_prf_sha256) {
8776 return MBEDTLS_SSL_TLS_PRF_SHA256;
8777 } else
Jerry Yue93ffcd2022-02-17 14:37:06 +08008778#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01008779 return MBEDTLS_SSL_TLS_PRF_NONE;
Jerry Yue93ffcd2022-02-17 14:37:06 +08008780}
8781
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008782/*
8783 * Populate a transform structure with session keys and all the other
8784 * necessary information.
8785 *
8786 * Parameters:
8787 * - [in/out]: transform: structure to populate
8788 * [in] must be just initialised with mbedtls_ssl_transform_init()
8789 * [out] fully populated, ready for use by mbedtls_ssl_{en,de}crypt_buf()
8790 * - [in] ciphersuite
8791 * - [in] master
8792 * - [in] encrypt_then_mac
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008793 * - [in] tls_prf: pointer to PRF to use for key derivation
8794 * - [in] randbytes: buffer holding ServerHello.random + ClientHello.random
Glenn Strauss07c64162022-03-14 12:34:51 -04008795 * - [in] tls_version: TLS version
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008796 * - [in] endpoint: client or server
8797 * - [in] ssl: used for:
8798 * - ssl->conf->{f,p}_export_keys
8799 * [in] optionally used for:
8800 * - MBEDTLS_DEBUG_C: ssl->conf->{f,p}_dbg
8801 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02008802MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01008803static int ssl_tls12_populate_transform(mbedtls_ssl_transform *transform,
8804 int ciphersuite,
8805 const unsigned char master[48],
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008806#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008807 int encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008808#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008809 ssl_tls_prf_t tls_prf,
8810 const unsigned char randbytes[64],
8811 mbedtls_ssl_protocol_version tls_version,
8812 unsigned endpoint,
8813 const mbedtls_ssl_context *ssl)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008814{
8815 int ret = 0;
8816 unsigned char keyblk[256];
8817 unsigned char *key1;
8818 unsigned char *key2;
8819 unsigned char *mac_enc;
8820 unsigned char *mac_dec;
8821 size_t mac_key_len = 0;
8822 size_t iv_copy_len;
8823 size_t keylen;
8824 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008825 mbedtls_ssl_mode_t ssl_mode;
Neil Armstronge4512952022-03-08 09:08:22 +01008826#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008827 const mbedtls_cipher_info_t *cipher_info;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008828 const mbedtls_md_info_t *md_info;
Neil Armstronge4512952022-03-08 09:08:22 +01008829#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008830
8831#if defined(MBEDTLS_USE_PSA_CRYPTO)
8832 psa_key_type_t key_type;
8833 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
8834 psa_algorithm_t alg;
Neil Armstronge4512952022-03-08 09:08:22 +01008835 psa_algorithm_t mac_alg = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008836 size_t key_bits;
8837 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8838#endif
8839
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008840 /*
8841 * Some data just needs copying into the structure
8842 */
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008843#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008844 transform->encrypt_then_mac = encrypt_then_mac;
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008845#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Glenn Strauss07c64162022-03-14 12:34:51 -04008846 transform->tls_version = tls_version;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008847
8848#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01008849 memcpy(transform->randbytes, randbytes, sizeof(transform->randbytes));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008850#endif
8851
8852#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01008853 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008854 /* At the moment, we keep TLS <= 1.2 and TLS 1.3 transform
8855 * generation separate. This should never happen. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008856 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008857 }
8858#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
8859
8860 /*
8861 * Get various info structures
8862 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008863 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(ciphersuite);
8864 if (ciphersuite_info == NULL) {
8865 MBEDTLS_SSL_DEBUG_MSG(1, ("ciphersuite info for %d not found",
8866 ciphersuite));
8867 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008868 }
8869
Neil Armstrongab555e02022-04-04 11:07:59 +02008870 ssl_mode = mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008871#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01008872 encrypt_then_mac,
Neil Armstrongf2c82f02022-04-05 11:16:53 +02008873#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Gilles Peskine449bd832023-01-11 14:50:10 +01008874 ciphersuite_info);
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008875
Gilles Peskine449bd832023-01-11 14:50:10 +01008876 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008877 transform->taglen =
8878 ciphersuite_info->flags & MBEDTLS_CIPHERSUITE_SHORT_TAG ? 8 : 16;
Gilles Peskine449bd832023-01-11 14:50:10 +01008879 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008880
8881#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008882 if ((status = mbedtls_ssl_cipher_to_psa((mbedtls_cipher_type_t) ciphersuite_info->cipher,
Gilles Peskine449bd832023-01-11 14:50:10 +01008883 transform->taglen,
8884 &alg,
8885 &key_type,
8886 &key_bits)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05008887 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01008888 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_cipher_to_psa", ret);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008889 goto end;
8890 }
8891#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008892 cipher_info = mbedtls_cipher_info_from_type((mbedtls_cipher_type_t) ciphersuite_info->cipher);
Gilles Peskine449bd832023-01-11 14:50:10 +01008893 if (cipher_info == NULL) {
8894 MBEDTLS_SSL_DEBUG_MSG(1, ("cipher info for %u not found",
8895 ciphersuite_info->cipher));
8896 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008897 }
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008898#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008899
Neil Armstronge4512952022-03-08 09:08:22 +01008900#if defined(MBEDTLS_USE_PSA_CRYPTO)
Dave Rodgman2eab4622023-10-05 13:30:37 +01008901 mac_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008902 if (mac_alg == 0) {
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02008903 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md_psa_alg_from_type for %u not found",
Gilles Peskine449bd832023-01-11 14:50:10 +01008904 (unsigned) ciphersuite_info->mac));
8905 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Neil Armstronge4512952022-03-08 09:08:22 +01008906 }
8907#else
Agathiyan Bragadeesh8b52b882023-07-13 13:12:40 +01008908 md_info = mbedtls_md_info_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01008909 if (md_info == NULL) {
8910 MBEDTLS_SSL_DEBUG_MSG(1, ("mbedtls_md info for %u not found",
8911 (unsigned) ciphersuite_info->mac));
8912 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008913 }
Neil Armstronge4512952022-03-08 09:08:22 +01008914#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008915
8916#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
8917 /* Copy own and peer's CID if the use of the CID
8918 * extension has been negotiated. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008919 if (ssl->handshake->cid_in_use == MBEDTLS_SSL_CID_ENABLED) {
8920 MBEDTLS_SSL_DEBUG_MSG(3, ("Copy CIDs into SSL transform"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008921
8922 transform->in_cid_len = ssl->own_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008923 memcpy(transform->in_cid, ssl->own_cid, ssl->own_cid_len);
8924 MBEDTLS_SSL_DEBUG_BUF(3, "Incoming CID", transform->in_cid,
8925 transform->in_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008926
8927 transform->out_cid_len = ssl->handshake->peer_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01008928 memcpy(transform->out_cid, ssl->handshake->peer_cid,
8929 ssl->handshake->peer_cid_len);
8930 MBEDTLS_SSL_DEBUG_BUF(3, "Outgoing CID", transform->out_cid,
8931 transform->out_cid_len);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008932 }
8933#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
8934
8935 /*
8936 * Compute key block using the PRF
8937 */
Gilles Peskine449bd832023-01-11 14:50:10 +01008938 ret = tls_prf(master, 48, "key expansion", randbytes, 64, keyblk, 256);
8939 if (ret != 0) {
8940 MBEDTLS_SSL_DEBUG_RET(1, "prf", ret);
8941 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008942 }
8943
Gilles Peskine449bd832023-01-11 14:50:10 +01008944 MBEDTLS_SSL_DEBUG_MSG(3, ("ciphersuite = %s",
8945 mbedtls_ssl_get_ciphersuite_name(ciphersuite)));
8946 MBEDTLS_SSL_DEBUG_BUF(3, "master secret", master, 48);
8947 MBEDTLS_SSL_DEBUG_BUF(4, "random bytes", randbytes, 64);
8948 MBEDTLS_SSL_DEBUG_BUF(4, "key block", keyblk, 256);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008949
8950 /*
8951 * Determine the appropriate key, IV and MAC length.
8952 */
8953
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008954#if defined(MBEDTLS_USE_PSA_CRYPTO)
8955 keylen = PSA_BITS_TO_BYTES(key_bits);
8956#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008957 keylen = mbedtls_cipher_info_get_key_bitlen(cipher_info) / 8;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008958#endif
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008959
Valerio Settie5707042023-10-11 11:54:42 +02008960#if defined(MBEDTLS_SSL_HAVE_AEAD)
Gilles Peskine449bd832023-01-11 14:50:10 +01008961 if (ssl_mode == MBEDTLS_SSL_MODE_AEAD) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008962 size_t explicit_ivlen;
8963
8964 transform->maclen = 0;
8965 mac_key_len = 0;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008966
8967 /* All modes haves 96-bit IVs, but the length of the static parts vary
8968 * with mode and version:
8969 * - For GCM and CCM in TLS 1.2, there's a static IV of 4 Bytes
8970 * (to be concatenated with a dynamically chosen IV of 8 Bytes)
8971 * - For ChaChaPoly in TLS 1.2, and all modes in TLS 1.3, there's
8972 * a static IV of 12 Bytes (to be XOR'ed with the 8 Byte record
8973 * sequence number).
8974 */
8975 transform->ivlen = 12;
David Horstmann3b2276a2022-10-06 14:49:08 +01008976
8977 int is_chachapoly = 0;
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008978#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01008979 is_chachapoly = (key_type == PSA_KEY_TYPE_CHACHA20);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008980#else
Gilles Peskine449bd832023-01-11 14:50:10 +01008981 is_chachapoly = (mbedtls_cipher_info_get_mode(cipher_info)
8982 == MBEDTLS_MODE_CHACHAPOLY);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02008983#endif /* MBEDTLS_USE_PSA_CRYPTO */
David Horstmann3b2276a2022-10-06 14:49:08 +01008984
Gilles Peskine449bd832023-01-11 14:50:10 +01008985 if (is_chachapoly) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008986 transform->fixed_ivlen = 12;
Gilles Peskine449bd832023-01-11 14:50:10 +01008987 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008988 transform->fixed_ivlen = 4;
Gilles Peskine449bd832023-01-11 14:50:10 +01008989 }
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008990
8991 /* Minimum length of encrypted record */
8992 explicit_ivlen = transform->ivlen - transform->fixed_ivlen;
8993 transform->minlen = explicit_ivlen + transform->taglen;
Gilles Peskine449bd832023-01-11 14:50:10 +01008994 } else
Valerio Settie5707042023-10-11 11:54:42 +02008995#endif /* MBEDTLS_SSL_HAVE_AEAD */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08008996#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01008997 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM ||
Neil Armstrong7fea33e2022-04-01 15:40:25 +02008998 ssl_mode == MBEDTLS_SSL_MODE_CBC ||
Gilles Peskine449bd832023-01-11 14:50:10 +01008999 ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Neil Armstronge4512952022-03-08 09:08:22 +01009000#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009001 size_t block_size = PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009002#else
Dave Rodgman85a88132023-06-24 11:41:50 +01009003 size_t block_size = mbedtls_cipher_info_get_block_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009004#endif /* MBEDTLS_USE_PSA_CRYPTO */
9005
9006#if defined(MBEDTLS_USE_PSA_CRYPTO)
Neil Armstronge4512952022-03-08 09:08:22 +01009007 /* Get MAC length */
9008 mac_key_len = PSA_HASH_LENGTH(mac_alg);
9009#else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009010 /* Initialize HMAC contexts */
Gilles Peskine449bd832023-01-11 14:50:10 +01009011 if ((ret = mbedtls_md_setup(&transform->md_ctx_enc, md_info, 1)) != 0 ||
9012 (ret = mbedtls_md_setup(&transform->md_ctx_dec, md_info, 1)) != 0) {
9013 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009014 goto end;
9015 }
9016
9017 /* Get MAC length */
Gilles Peskine449bd832023-01-11 14:50:10 +01009018 mac_key_len = mbedtls_md_get_size(md_info);
Neil Armstronge4512952022-03-08 09:08:22 +01009019#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009020 transform->maclen = mac_key_len;
9021
9022 /* IV length */
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009023#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009024 transform->ivlen = PSA_CIPHER_IV_LENGTH(key_type, alg);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009025#else
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01009026 transform->ivlen = mbedtls_cipher_info_get_iv_size(cipher_info);
Neil Armstronga0eeb7f2022-04-01 17:36:10 +02009027#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009028
9029 /* Minimum length */
Gilles Peskine449bd832023-01-11 14:50:10 +01009030 if (ssl_mode == MBEDTLS_SSL_MODE_STREAM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009031 transform->minlen = transform->maclen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009032 } else {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009033 /*
9034 * GenericBlockCipher:
9035 * 1. if EtM is in use: one block plus MAC
9036 * otherwise: * first multiple of blocklen greater than maclen
9037 * 2. IV
9038 */
9039#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009040 if (ssl_mode == MBEDTLS_SSL_MODE_CBC_ETM) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009041 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009042 + block_size;
9043 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009044#endif
9045 {
9046 transform->minlen = transform->maclen
Gilles Peskine449bd832023-01-11 14:50:10 +01009047 + block_size
9048 - transform->maclen % block_size;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009049 }
9050
Gilles Peskine449bd832023-01-11 14:50:10 +01009051 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009052 transform->minlen += transform->ivlen;
Gilles Peskine449bd832023-01-11 14:50:10 +01009053 } else {
9054 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009055 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9056 goto end;
9057 }
9058 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009059 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009060#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9061 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009062 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
9063 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009064 }
9065
Gilles Peskine449bd832023-01-11 14:50:10 +01009066 MBEDTLS_SSL_DEBUG_MSG(3, ("keylen: %u, minlen: %u, ivlen: %u, maclen: %u",
9067 (unsigned) keylen,
9068 (unsigned) transform->minlen,
9069 (unsigned) transform->ivlen,
9070 (unsigned) transform->maclen));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009071
9072 /*
9073 * Finally setup the cipher contexts, IVs and MAC secrets.
9074 */
9075#if defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009076 if (endpoint == MBEDTLS_SSL_IS_CLIENT) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009077 key1 = keyblk + mac_key_len * 2;
9078 key2 = keyblk + mac_key_len * 2 + keylen;
9079
9080 mac_enc = keyblk;
9081 mac_dec = keyblk + mac_key_len;
9082
Gilles Peskine449bd832023-01-11 14:50:10 +01009083 iv_copy_len = (transform->fixed_ivlen) ?
9084 transform->fixed_ivlen : transform->ivlen;
9085 memcpy(transform->iv_enc, key2 + keylen, iv_copy_len);
9086 memcpy(transform->iv_dec, key2 + keylen + iv_copy_len,
9087 iv_copy_len);
9088 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009089#endif /* MBEDTLS_SSL_CLI_C */
9090#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009091 if (endpoint == MBEDTLS_SSL_IS_SERVER) {
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009092 key1 = keyblk + mac_key_len * 2 + keylen;
9093 key2 = keyblk + mac_key_len * 2;
9094
9095 mac_enc = keyblk + mac_key_len;
9096 mac_dec = keyblk;
9097
Gilles Peskine449bd832023-01-11 14:50:10 +01009098 iv_copy_len = (transform->fixed_ivlen) ?
9099 transform->fixed_ivlen : transform->ivlen;
9100 memcpy(transform->iv_dec, key1 + keylen, iv_copy_len);
9101 memcpy(transform->iv_enc, key1 + keylen + iv_copy_len,
9102 iv_copy_len);
9103 } else
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009104#endif /* MBEDTLS_SSL_SRV_C */
9105 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009106 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009107 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
9108 goto end;
9109 }
9110
Paul Elliott4fb19552023-10-18 12:15:30 +01009111 if (ssl->f_export_keys != NULL) {
Gilles Peskine449bd832023-01-11 14:50:10 +01009112 ssl->f_export_keys(ssl->p_export_keys,
9113 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET,
9114 master, 48,
9115 randbytes + 32,
9116 randbytes,
9117 tls_prf_get_type(tls_prf));
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009118 }
9119
9120#if defined(MBEDTLS_USE_PSA_CRYPTO)
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009121 transform->psa_alg = alg;
9122
Gilles Peskine449bd832023-01-11 14:50:10 +01009123 if (alg != MBEDTLS_SSL_NULL_CIPHER) {
9124 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_ENCRYPT);
9125 psa_set_key_algorithm(&attributes, alg);
9126 psa_set_key_type(&attributes, key_type);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009127
Gilles Peskine449bd832023-01-11 14:50:10 +01009128 if ((status = psa_import_key(&attributes,
9129 key1,
9130 PSA_BITS_TO_BYTES(key_bits),
9131 &transform->psa_key_enc)) != PSA_SUCCESS) {
9132 MBEDTLS_SSL_DEBUG_RET(3, "psa_import_key", (int) status);
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009133 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009134 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009135 goto end;
9136 }
9137
Gilles Peskine449bd832023-01-11 14:50:10 +01009138 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_DECRYPT);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009139
Gilles Peskine449bd832023-01-11 14:50:10 +01009140 if ((status = psa_import_key(&attributes,
9141 key2,
9142 PSA_BITS_TO_BYTES(key_bits),
9143 &transform->psa_key_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009144 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009145 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_key", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009146 goto end;
9147 }
9148 }
9149#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009150 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_enc,
9151 cipher_info)) != 0) {
9152 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009153 goto end;
9154 }
9155
Gilles Peskine449bd832023-01-11 14:50:10 +01009156 if ((ret = mbedtls_cipher_setup(&transform->cipher_ctx_dec,
9157 cipher_info)) != 0) {
9158 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setup", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009159 goto end;
9160 }
9161
Gilles Peskine449bd832023-01-11 14:50:10 +01009162 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_enc, key1,
9163 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9164 MBEDTLS_ENCRYPT)) != 0) {
9165 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009166 goto end;
9167 }
9168
Gilles Peskine449bd832023-01-11 14:50:10 +01009169 if ((ret = mbedtls_cipher_setkey(&transform->cipher_ctx_dec, key2,
9170 (int) mbedtls_cipher_info_get_key_bitlen(cipher_info),
9171 MBEDTLS_DECRYPT)) != 0) {
9172 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_setkey", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009173 goto end;
9174 }
9175
9176#if defined(MBEDTLS_CIPHER_MODE_CBC)
Gilles Peskine449bd832023-01-11 14:50:10 +01009177 if (mbedtls_cipher_info_get_mode(cipher_info) == MBEDTLS_MODE_CBC) {
9178 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_enc,
9179 MBEDTLS_PADDING_NONE)) != 0) {
9180 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009181 goto end;
9182 }
9183
Gilles Peskine449bd832023-01-11 14:50:10 +01009184 if ((ret = mbedtls_cipher_set_padding_mode(&transform->cipher_ctx_dec,
9185 MBEDTLS_PADDING_NONE)) != 0) {
9186 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_cipher_set_padding_mode", ret);
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009187 goto end;
9188 }
9189 }
9190#endif /* MBEDTLS_CIPHER_MODE_CBC */
9191#endif /* MBEDTLS_USE_PSA_CRYPTO */
9192
Neil Armstrong29c0c042022-03-17 17:47:28 +01009193#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
9194 /* For HMAC-based ciphersuites, initialize the HMAC transforms.
9195 For AEAD-based ciphersuites, there is nothing to do here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01009196 if (mac_key_len != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009197#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009198 transform->psa_mac_alg = PSA_ALG_HMAC(mac_alg);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009199
Gilles Peskine449bd832023-01-11 14:50:10 +01009200 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
9201 psa_set_key_algorithm(&attributes, PSA_ALG_HMAC(mac_alg));
9202 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009203
Gilles Peskine449bd832023-01-11 14:50:10 +01009204 if ((status = psa_import_key(&attributes,
9205 mac_enc, mac_key_len,
9206 &transform->psa_mac_enc)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009207 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009208 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009209 goto end;
9210 }
9211
Gilles Peskine449bd832023-01-11 14:50:10 +01009212 if ((transform->psa_alg == MBEDTLS_SSL_NULL_CIPHER) ||
9213 ((transform->psa_alg == PSA_ALG_CBC_NO_PADDING)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009214#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Gilles Peskine449bd832023-01-11 14:50:10 +01009215 && (transform->encrypt_then_mac == MBEDTLS_SSL_ETM_DISABLED)
Andrzej Kurek8c95ac42022-08-17 16:17:00 -04009216#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01009217 )) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009218 /* mbedtls_ct_hmac() requires the key to be exportable */
Gilles Peskine449bd832023-01-11 14:50:10 +01009219 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_EXPORT |
9220 PSA_KEY_USAGE_VERIFY_HASH);
9221 } else {
9222 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_VERIFY_HASH);
9223 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009224
Gilles Peskine449bd832023-01-11 14:50:10 +01009225 if ((status = psa_import_key(&attributes,
9226 mac_dec, mac_key_len,
9227 &transform->psa_mac_dec)) != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009228 ret = PSA_TO_MBEDTLS_ERR(status);
Gilles Peskine449bd832023-01-11 14:50:10 +01009229 MBEDTLS_SSL_DEBUG_RET(1, "psa_import_mac_key", ret);
Neil Armstrong29c0c042022-03-17 17:47:28 +01009230 goto end;
9231 }
9232#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009233 ret = mbedtls_md_hmac_starts(&transform->md_ctx_enc, mac_enc, mac_key_len);
9234 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009235 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009236 }
9237 ret = mbedtls_md_hmac_starts(&transform->md_ctx_dec, mac_dec, mac_key_len);
9238 if (ret != 0) {
Neil Armstrong29c0c042022-03-17 17:47:28 +01009239 goto end;
Gilles Peskine449bd832023-01-11 14:50:10 +01009240 }
Neil Armstrong29c0c042022-03-17 17:47:28 +01009241#endif /* MBEDTLS_USE_PSA_CRYPTO */
9242 }
9243#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
9244
9245 ((void) mac_dec);
9246 ((void) mac_enc);
9247
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009248end:
Gilles Peskine449bd832023-01-11 14:50:10 +01009249 mbedtls_platform_zeroize(keyblk, sizeof(keyblk));
9250 return ret;
Jerry Yu9bccc4c2022-02-17 14:38:28 +08009251}
9252
Valerio Settia08b1a42022-11-17 15:10:02 +01009253#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
9254 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Setti6b3dab02022-11-17 17:14:54 +01009255int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009256 psa_pake_operation_t *pake_ctx,
9257 const unsigned char *buf,
9258 size_t len, mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009259{
9260 psa_status_t status;
9261 size_t input_offset = 0;
Valerio Setti819de862022-11-17 18:05:19 +01009262 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009263 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9264 * At round two perform a single cycle
9265 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009266 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009267
Gilles Peskine449bd832023-01-11 14:50:10 +01009268 for (; remaining_steps > 0; remaining_steps--) {
9269 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
Valerio Settia08b1a42022-11-17 15:10:02 +01009270 step <= PSA_PAKE_STEP_ZK_PROOF;
Gilles Peskine449bd832023-01-11 14:50:10 +01009271 ++step) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009272 /* Length is stored at the first byte */
9273 size_t length = buf[input_offset];
9274 input_offset += 1;
9275
Gilles Peskine449bd832023-01-11 14:50:10 +01009276 if (input_offset + length > len) {
Valerio Settia08b1a42022-11-17 15:10:02 +01009277 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
9278 }
9279
Gilles Peskine449bd832023-01-11 14:50:10 +01009280 status = psa_pake_input(pake_ctx, step,
9281 buf + input_offset, length);
9282 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009283 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009284 }
9285
9286 input_offset += length;
9287 }
9288 }
9289
Gilles Peskine449bd832023-01-11 14:50:10 +01009290 if (input_offset != len) {
Valerio Setti61ea17d2022-11-18 12:11:00 +01009291 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01009292 }
Valerio Setti30ebe112022-11-17 16:23:34 +01009293
Gilles Peskine449bd832023-01-11 14:50:10 +01009294 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009295}
9296
Valerio Setti6b3dab02022-11-17 17:14:54 +01009297int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01009298 psa_pake_operation_t *pake_ctx,
9299 unsigned char *buf,
9300 size_t len, size_t *olen,
9301 mbedtls_ecjpake_rounds_t round)
Valerio Settia08b1a42022-11-17 15:10:02 +01009302{
9303 psa_status_t status;
9304 size_t output_offset = 0;
9305 size_t output_len;
Valerio Setti819de862022-11-17 18:05:19 +01009306 /*
Valerio Setti6b3dab02022-11-17 17:14:54 +01009307 * At round one repeat the KEY_SHARE, ZK_PUBLIC & ZF_PROOF twice
9308 * At round two perform a single cycle
9309 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009310 unsigned int remaining_steps = (round == MBEDTLS_ECJPAKE_ROUND_ONE) ? 2 : 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009311
Gilles Peskine449bd832023-01-11 14:50:10 +01009312 for (; remaining_steps > 0; remaining_steps--) {
9313 for (psa_pake_step_t step = PSA_PAKE_STEP_KEY_SHARE;
9314 step <= PSA_PAKE_STEP_ZK_PROOF;
9315 ++step) {
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009316 /*
Valerio Settid4a9b1a2022-11-22 11:11:10 +01009317 * For each step, prepend 1 byte with the length of the data as
9318 * given by psa_pake_output().
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009319 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009320 status = psa_pake_output(pake_ctx, step,
9321 buf + output_offset + 1,
9322 len - output_offset - 1,
9323 &output_len);
9324 if (status != PSA_SUCCESS) {
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05009325 return PSA_TO_MBEDTLS_ERR(status);
Valerio Settia08b1a42022-11-17 15:10:02 +01009326 }
9327
Valerio Setti99d88c12022-11-22 16:03:43 +01009328 *(buf + output_offset) = (uint8_t) output_len;
Valerio Setti79f6b6b2022-11-21 14:17:03 +01009329
9330 output_offset += output_len + 1;
Valerio Settia08b1a42022-11-17 15:10:02 +01009331 }
9332 }
9333
9334 *olen = output_offset;
9335
Gilles Peskine449bd832023-01-11 14:50:10 +01009336 return 0;
Valerio Settia08b1a42022-11-17 15:10:02 +01009337}
Valerio Settia08b1a42022-11-17 15:10:02 +01009338#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
9339
Jerry Yuee40f9d2022-02-17 14:55:16 +08009340#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009341int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9342 unsigned char *hash, size_t *hashlen,
9343 unsigned char *data, size_t data_len,
9344 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009345{
9346 psa_status_t status;
9347 psa_hash_operation_t hash_operation = PSA_HASH_OPERATION_INIT;
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02009348 psa_algorithm_t hash_alg = mbedtls_md_psa_alg_from_type(md_alg);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009349
Gilles Peskine449bd832023-01-11 14:50:10 +01009350 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform PSA-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009351
Gilles Peskine449bd832023-01-11 14:50:10 +01009352 if ((status = psa_hash_setup(&hash_operation,
9353 hash_alg)) != PSA_SUCCESS) {
9354 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_setup", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009355 goto exit;
9356 }
9357
Gilles Peskine449bd832023-01-11 14:50:10 +01009358 if ((status = psa_hash_update(&hash_operation, ssl->handshake->randbytes,
9359 64)) != PSA_SUCCESS) {
9360 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009361 goto exit;
9362 }
9363
Gilles Peskine449bd832023-01-11 14:50:10 +01009364 if ((status = psa_hash_update(&hash_operation,
9365 data, data_len)) != PSA_SUCCESS) {
9366 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_update", status);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009367 goto exit;
9368 }
9369
Gilles Peskine449bd832023-01-11 14:50:10 +01009370 if ((status = psa_hash_finish(&hash_operation, hash, PSA_HASH_MAX_SIZE,
9371 hashlen)) != PSA_SUCCESS) {
9372 MBEDTLS_SSL_DEBUG_RET(1, "psa_hash_finish", status);
9373 goto exit;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009374 }
9375
9376exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009377 if (status != PSA_SUCCESS) {
9378 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9379 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9380 switch (status) {
Jerry Yuee40f9d2022-02-17 14:55:16 +08009381 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01009382 return MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009383 case PSA_ERROR_BAD_STATE: /* Intentional fallthrough */
9384 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01009385 return MBEDTLS_ERR_MD_BAD_INPUT_DATA;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009386 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01009387 return MBEDTLS_ERR_MD_ALLOC_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009388 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01009389 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009390 }
9391 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009392 return 0;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009393}
9394
9395#else
9396
Gilles Peskine449bd832023-01-11 14:50:10 +01009397int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
9398 unsigned char *hash, size_t *hashlen,
9399 unsigned char *data, size_t data_len,
9400 mbedtls_md_type_t md_alg)
Jerry Yuee40f9d2022-02-17 14:55:16 +08009401{
9402 int ret = 0;
9403 mbedtls_md_context_t ctx;
Gilles Peskine449bd832023-01-11 14:50:10 +01009404 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(md_alg);
9405 *hashlen = mbedtls_md_get_size(md_info);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009406
Gilles Peskine449bd832023-01-11 14:50:10 +01009407 MBEDTLS_SSL_DEBUG_MSG(3, ("Perform mbedtls-based computation of digest of ServerKeyExchange"));
Jerry Yuee40f9d2022-02-17 14:55:16 +08009408
Gilles Peskine449bd832023-01-11 14:50:10 +01009409 mbedtls_md_init(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009410
9411 /*
9412 * digitally-signed struct {
9413 * opaque client_random[32];
9414 * opaque server_random[32];
9415 * ServerDHParams params;
9416 * };
9417 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009418 if ((ret = mbedtls_md_setup(&ctx, md_info, 0)) != 0) {
9419 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_setup", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009420 goto exit;
9421 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009422 if ((ret = mbedtls_md_starts(&ctx)) != 0) {
9423 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_starts", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009424 goto exit;
9425 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009426 if ((ret = mbedtls_md_update(&ctx, ssl->handshake->randbytes, 64)) != 0) {
9427 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009428 goto exit;
9429 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009430 if ((ret = mbedtls_md_update(&ctx, data, data_len)) != 0) {
9431 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_update", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009432 goto exit;
9433 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009434 if ((ret = mbedtls_md_finish(&ctx, hash)) != 0) {
9435 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_md_finish", ret);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009436 goto exit;
9437 }
9438
9439exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01009440 mbedtls_md_free(&ctx);
Jerry Yuee40f9d2022-02-17 14:55:16 +08009441
Gilles Peskine449bd832023-01-11 14:50:10 +01009442 if (ret != 0) {
9443 mbedtls_ssl_send_alert_message(ssl, MBEDTLS_SSL_ALERT_LEVEL_FATAL,
9444 MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR);
9445 }
Jerry Yuee40f9d2022-02-17 14:55:16 +08009446
Gilles Peskine449bd832023-01-11 14:50:10 +01009447 return ret;
Jerry Yuee40f9d2022-02-17 14:55:16 +08009448}
9449#endif /* MBEDTLS_USE_PSA_CRYPTO */
9450
Jerry Yud9d91da2022-02-17 14:57:06 +08009451#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
9452
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009453/* Find the preferred hash for a given signature algorithm. */
9454unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01009455 mbedtls_ssl_context *ssl,
9456 unsigned int sig_alg)
Jerry Yud9d91da2022-02-17 14:57:06 +08009457{
Gabor Mezei078e8032022-04-27 21:17:56 +02009458 unsigned int i;
Gabor Mezeia3d016c2022-05-10 12:44:09 +02009459 uint16_t *received_sig_algs = ssl->handshake->received_sig_algs;
Gabor Mezei078e8032022-04-27 21:17:56 +02009460
Gilles Peskine449bd832023-01-11 14:50:10 +01009461 if (sig_alg == MBEDTLS_SSL_SIG_ANON) {
9462 return MBEDTLS_SSL_HASH_NONE;
9463 }
Gabor Mezei078e8032022-04-27 21:17:56 +02009464
Gilles Peskine449bd832023-01-11 14:50:10 +01009465 for (i = 0; received_sig_algs[i] != MBEDTLS_TLS_SIG_NONE; i++) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009466 unsigned int hash_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009467 MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(
9468 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009469 unsigned int sig_alg_received =
Gilles Peskine449bd832023-01-11 14:50:10 +01009470 MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(
9471 received_sig_algs[i]);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009472
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009473 mbedtls_md_type_t md_alg =
9474 mbedtls_ssl_md_alg_from_hash((unsigned char) hash_alg_received);
9475 if (md_alg == MBEDTLS_MD_NONE) {
9476 continue;
9477 }
9478
Gilles Peskine449bd832023-01-11 14:50:10 +01009479 if (sig_alg == sig_alg_received) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009480#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009481 if (ssl->handshake->key_cert && ssl->handshake->key_cert->key) {
Neil Armstrong96eceb82022-06-30 18:05:05 +02009482 psa_algorithm_t psa_hash_alg =
Manuel Pégourié-Gonnard47bb3802023-06-05 12:40:32 +02009483 mbedtls_md_psa_alg_from_type(md_alg);
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009484
Gilles Peskine449bd832023-01-11 14:50:10 +01009485 if (sig_alg_received == MBEDTLS_SSL_SIG_ECDSA &&
9486 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9487 PSA_ALG_ECDSA(psa_hash_alg),
9488 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009489 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009490 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009491
Gilles Peskine449bd832023-01-11 14:50:10 +01009492 if (sig_alg_received == MBEDTLS_SSL_SIG_RSA &&
9493 !mbedtls_pk_can_do_ext(ssl->handshake->key_cert->key,
9494 PSA_ALG_RSA_PKCS1V15_SIGN(
9495 psa_hash_alg),
9496 PSA_KEY_USAGE_SIGN_HASH)) {
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009497 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009498 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009499 }
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009500#endif /* MBEDTLS_USE_PSA_CRYPTO */
Neil Armstrong96eceb82022-06-30 18:05:05 +02009501
Gilles Peskine449bd832023-01-11 14:50:10 +01009502 return hash_alg_received;
Neil Armstrong9f1176a2022-06-24 18:19:19 +02009503 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009504 }
Jerry Yud9d91da2022-02-17 14:57:06 +08009505
Gilles Peskine449bd832023-01-11 14:50:10 +01009506 return MBEDTLS_SSL_HASH_NONE;
Jerry Yud9d91da2022-02-17 14:57:06 +08009507}
9508
9509#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
9510
Jerry Yudc7bd172022-02-17 13:44:15 +08009511#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9512
XiaokangQian75d40ef2022-04-20 11:05:24 +00009513int mbedtls_ssl_validate_ciphersuite(
9514 const mbedtls_ssl_context *ssl,
9515 const mbedtls_ssl_ciphersuite_t *suite_info,
9516 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01009517 mbedtls_ssl_protocol_version max_tls_version)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009518{
9519 (void) ssl;
9520
Gilles Peskine449bd832023-01-11 14:50:10 +01009521 if (suite_info == NULL) {
9522 return -1;
9523 }
XiaokangQian75d40ef2022-04-20 11:05:24 +00009524
Gilles Peskine449bd832023-01-11 14:50:10 +01009525 if ((suite_info->min_tls_version > max_tls_version) ||
9526 (suite_info->max_tls_version < min_tls_version)) {
9527 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009528 }
9529
XiaokangQian060d8672022-04-21 09:24:56 +00009530#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_CLI_C)
XiaokangQian75d40ef2022-04-20 11:05:24 +00009531#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009532#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01009533 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9534 ssl->handshake->psa_pake_ctx_is_ok != 1)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009535#else
Gilles Peskine449bd832023-01-11 14:50:10 +01009536 if (suite_info->key_exchange == MBEDTLS_KEY_EXCHANGE_ECJPAKE &&
9537 mbedtls_ecjpake_check(&ssl->handshake->ecjpake_ctx) != 0)
Neil Armstrongca7d5062022-05-31 14:43:23 +02009538#endif /* MBEDTLS_USE_PSA_CRYPTO */
XiaokangQian75d40ef2022-04-20 11:05:24 +00009539 {
Gilles Peskine449bd832023-01-11 14:50:10 +01009540 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009541 }
9542#endif
9543
9544 /* Don't suggest PSK-based ciphersuite if no PSK is available. */
9545#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01009546 if (mbedtls_ssl_ciphersuite_uses_psk(suite_info) &&
9547 mbedtls_ssl_conf_has_static_psk(ssl->conf) == 0) {
9548 return -1;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009549 }
9550#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
9551#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
9552
Gilles Peskine449bd832023-01-11 14:50:10 +01009553 return 0;
XiaokangQian75d40ef2022-04-20 11:05:24 +00009554}
9555
Ronald Crone68ab4f2022-10-05 12:46:29 +02009556#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
XiaokangQianeaf36512022-04-24 09:07:44 +00009557/*
9558 * Function for writing a signature algorithm extension.
9559 *
9560 * The `extension_data` field of signature algorithm contains a `SignatureSchemeList`
9561 * value (TLS 1.3 RFC8446):
9562 * enum {
9563 * ....
9564 * ecdsa_secp256r1_sha256( 0x0403 ),
9565 * ecdsa_secp384r1_sha384( 0x0503 ),
9566 * ecdsa_secp521r1_sha512( 0x0603 ),
9567 * ....
9568 * } SignatureScheme;
9569 *
9570 * struct {
9571 * SignatureScheme supported_signature_algorithms<2..2^16-2>;
9572 * } SignatureSchemeList;
9573 *
9574 * The `extension_data` field of signature algorithm contains a `SignatureAndHashAlgorithm`
9575 * value (TLS 1.2 RFC5246):
9576 * enum {
9577 * none(0), md5(1), sha1(2), sha224(3), sha256(4), sha384(5),
9578 * sha512(6), (255)
9579 * } HashAlgorithm;
9580 *
9581 * enum { anonymous(0), rsa(1), dsa(2), ecdsa(3), (255) }
9582 * SignatureAlgorithm;
9583 *
9584 * struct {
9585 * HashAlgorithm hash;
9586 * SignatureAlgorithm signature;
9587 * } SignatureAndHashAlgorithm;
9588 *
9589 * SignatureAndHashAlgorithm
9590 * supported_signature_algorithms<2..2^16-2>;
9591 *
9592 * The TLS 1.3 signature algorithm extension was defined to be a compatible
9593 * generalization of the TLS 1.2 signature algorithm extension.
9594 * `SignatureAndHashAlgorithm` field of TLS 1.2 can be represented by
9595 * `SignatureScheme` field of TLS 1.3
9596 *
9597 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009598int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
9599 const unsigned char *end, size_t *out_len)
XiaokangQianeaf36512022-04-24 09:07:44 +00009600{
9601 unsigned char *p = buf;
9602 unsigned char *supported_sig_alg; /* Start of supported_signature_algorithms */
9603 size_t supported_sig_alg_len = 0; /* Length of supported_signature_algorithms */
9604
9605 *out_len = 0;
9606
Gilles Peskine449bd832023-01-11 14:50:10 +01009607 MBEDTLS_SSL_DEBUG_MSG(3, ("adding signature_algorithms extension"));
XiaokangQianeaf36512022-04-24 09:07:44 +00009608
9609 /* Check if we have space for header and length field:
9610 * - extension_type (2 bytes)
9611 * - extension_data_length (2 bytes)
9612 * - supported_signature_algorithms_length (2 bytes)
9613 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009614 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
XiaokangQianeaf36512022-04-24 09:07:44 +00009615 p += 6;
9616
9617 /*
9618 * Write supported_signature_algorithms
9619 */
9620 supported_sig_alg = p;
Gilles Peskine449bd832023-01-11 14:50:10 +01009621 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
9622 if (sig_alg == NULL) {
9623 return MBEDTLS_ERR_SSL_BAD_CONFIG;
9624 }
XiaokangQianeaf36512022-04-24 09:07:44 +00009625
Gilles Peskine449bd832023-01-11 14:50:10 +01009626 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
9627 MBEDTLS_SSL_DEBUG_MSG(3, ("got signature scheme [%x] %s",
9628 *sig_alg,
9629 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
9630 if (!mbedtls_ssl_sig_alg_is_supported(ssl, *sig_alg)) {
XiaokangQianeaf36512022-04-24 09:07:44 +00009631 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01009632 }
9633 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
9634 MBEDTLS_PUT_UINT16_BE(*sig_alg, p, 0);
XiaokangQianeaf36512022-04-24 09:07:44 +00009635 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009636 MBEDTLS_SSL_DEBUG_MSG(3, ("sent signature scheme [%x] %s",
9637 *sig_alg,
9638 mbedtls_ssl_sig_alg_to_str(*sig_alg)));
XiaokangQianeaf36512022-04-24 09:07:44 +00009639 }
9640
9641 /* Length of supported_signature_algorithms */
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009642 supported_sig_alg_len = (size_t) (p - supported_sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01009643 if (supported_sig_alg_len == 0) {
9644 MBEDTLS_SSL_DEBUG_MSG(1, ("No signature algorithms defined."));
9645 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
XiaokangQianeaf36512022-04-24 09:07:44 +00009646 }
9647
Gilles Peskine449bd832023-01-11 14:50:10 +01009648 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SIG_ALG, buf, 0);
9649 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len + 2, buf, 2);
9650 MBEDTLS_PUT_UINT16_BE(supported_sig_alg_len, buf, 4);
XiaokangQianeaf36512022-04-24 09:07:44 +00009651
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00009652 *out_len = (size_t) (p - buf);
XiaokangQianeaf36512022-04-24 09:07:44 +00009653
9654#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009655 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_SIG_ALG);
XiaokangQianeaf36512022-04-24 09:07:44 +00009656#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu0c354a22022-08-29 15:25:36 +08009657
Gilles Peskine449bd832023-01-11 14:50:10 +01009658 return 0;
XiaokangQianeaf36512022-04-24 09:07:44 +00009659}
Ronald Crone68ab4f2022-10-05 12:46:29 +02009660#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
XiaokangQianeaf36512022-04-24 09:07:44 +00009661
XiaokangQian40a35232022-05-07 09:02:40 +00009662#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
XiaokangQian9b2b7712022-05-17 02:57:00 +00009663/*
9664 * mbedtls_ssl_parse_server_name_ext
9665 *
9666 * Structure of server_name extension:
9667 *
9668 * enum {
9669 * host_name(0), (255)
9670 * } NameType;
9671 * opaque HostName<1..2^16-1>;
9672 *
9673 * struct {
9674 * NameType name_type;
9675 * select (name_type) {
9676 * case host_name: HostName;
9677 * } name;
9678 * } ServerName;
9679 * struct {
9680 * ServerName server_name_list<1..2^16-1>
9681 * } ServerNameList;
9682 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02009683MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009684int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
9685 const unsigned char *buf,
9686 const unsigned char *end)
XiaokangQian40a35232022-05-07 09:02:40 +00009687{
9688 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
9689 const unsigned char *p = buf;
XiaokangQian9b2b7712022-05-17 02:57:00 +00009690 size_t server_name_list_len, hostname_len;
9691 const unsigned char *server_name_list_end;
XiaokangQian40a35232022-05-07 09:02:40 +00009692
Gilles Peskine449bd832023-01-11 14:50:10 +01009693 MBEDTLS_SSL_DEBUG_MSG(3, ("parse ServerName extension"));
XiaokangQian40a35232022-05-07 09:02:40 +00009694
Gilles Peskine449bd832023-01-11 14:50:10 +01009695 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
9696 server_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian40a35232022-05-07 09:02:40 +00009697 p += 2;
9698
Gilles Peskine449bd832023-01-11 14:50:10 +01009699 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, server_name_list_len);
XiaokangQian9b2b7712022-05-17 02:57:00 +00009700 server_name_list_end = p + server_name_list_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009701 while (p < server_name_list_end) {
9702 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end, 3);
9703 hostname_len = MBEDTLS_GET_UINT16_BE(p, 1);
9704 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, server_name_list_end,
9705 hostname_len + 3);
XiaokangQian40a35232022-05-07 09:02:40 +00009706
Gilles Peskine449bd832023-01-11 14:50:10 +01009707 if (p[0] == MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME) {
XiaokangQian75fe8c72022-06-15 09:42:45 +00009708 /* sni_name is intended to be used only during the parsing of the
9709 * ClientHello message (it is reset to NULL before the end of
9710 * the message parsing). Thus it is ok to just point to the
9711 * reception buffer and not make a copy of it.
9712 */
XiaokangQianf2a94202022-05-20 06:44:24 +00009713 ssl->handshake->sni_name = p + 3;
9714 ssl->handshake->sni_name_len = hostname_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01009715 if (ssl->conf->f_sni == NULL) {
9716 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009717 }
Gilles Peskine449bd832023-01-11 14:50:10 +01009718 ret = ssl->conf->f_sni(ssl->conf->p_sni,
9719 ssl, p + 3, hostname_len);
9720 if (ret != 0) {
9721 MBEDTLS_SSL_DEBUG_RET(1, "ssl_sni_wrapper", ret);
9722 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME,
9723 MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME);
9724 return MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME;
9725 }
9726 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009727 }
9728
9729 p += hostname_len + 3;
9730 }
9731
Gilles Peskine449bd832023-01-11 14:50:10 +01009732 return 0;
XiaokangQian40a35232022-05-07 09:02:40 +00009733}
9734#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
9735
XiaokangQianacb39922022-06-17 10:18:48 +00009736#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02009737MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01009738int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
9739 const unsigned char *buf,
9740 const unsigned char *end)
XiaokangQianacb39922022-06-17 10:18:48 +00009741{
9742 const unsigned char *p = buf;
XiaokangQianc7403452022-06-23 03:24:12 +00009743 size_t protocol_name_list_len;
XiaokangQian95d5f542022-06-24 02:29:26 +00009744 const unsigned char *protocol_name_list;
9745 const unsigned char *protocol_name_list_end;
XiaokangQianc7403452022-06-23 03:24:12 +00009746 size_t protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009747
9748 /* If ALPN not configured, just ignore the extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01009749 if (ssl->conf->alpn_list == NULL) {
9750 return 0;
9751 }
XiaokangQianacb39922022-06-17 10:18:48 +00009752
9753 /*
XiaokangQianc7403452022-06-23 03:24:12 +00009754 * RFC7301, section 3.1
9755 * opaque ProtocolName<1..2^8-1>;
XiaokangQianacb39922022-06-17 10:18:48 +00009756 *
XiaokangQianc7403452022-06-23 03:24:12 +00009757 * struct {
9758 * ProtocolName protocol_name_list<2..2^16-1>
9759 * } ProtocolNameList;
XiaokangQianacb39922022-06-17 10:18:48 +00009760 */
9761
XiaokangQianc7403452022-06-23 03:24:12 +00009762 /*
XiaokangQian0b776e22022-06-24 09:04:59 +00009763 * protocol_name_list_len 2 bytes
9764 * protocol_name_len 1 bytes
9765 * protocol_name >=1 byte
XiaokangQianc7403452022-06-23 03:24:12 +00009766 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009767 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 4);
XiaokangQianacb39922022-06-17 10:18:48 +00009768
Gilles Peskine449bd832023-01-11 14:50:10 +01009769 protocol_name_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009770 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01009771 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, protocol_name_list_len);
XiaokangQian95d5f542022-06-24 02:29:26 +00009772 protocol_name_list = p;
9773 protocol_name_list_end = p + protocol_name_list_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009774
9775 /* Validate peer's list (lengths) */
Gilles Peskine449bd832023-01-11 14:50:10 +01009776 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009777 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009778 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, protocol_name_list_end,
9779 protocol_name_len);
9780 if (protocol_name_len == 0) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009781 MBEDTLS_SSL_PEND_FATAL_ALERT(
9782 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01009783 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
9784 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian95d5f542022-06-24 02:29:26 +00009785 }
9786
9787 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009788 }
9789
9790 /* Use our order of preference */
Gilles Peskine449bd832023-01-11 14:50:10 +01009791 for (const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++) {
9792 size_t const alpn_len = strlen(*alpn);
XiaokangQian95d5f542022-06-24 02:29:26 +00009793 p = protocol_name_list;
Gilles Peskine449bd832023-01-11 14:50:10 +01009794 while (p < protocol_name_list_end) {
XiaokangQian95d5f542022-06-24 02:29:26 +00009795 protocol_name_len = *p++;
Gilles Peskine449bd832023-01-11 14:50:10 +01009796 if (protocol_name_len == alpn_len &&
9797 memcmp(p, *alpn, alpn_len) == 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00009798 ssl->alpn_chosen = *alpn;
Gilles Peskine449bd832023-01-11 14:50:10 +01009799 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009800 }
XiaokangQian95d5f542022-06-24 02:29:26 +00009801
9802 p += protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009803 }
9804 }
9805
XiaokangQian95d5f542022-06-24 02:29:26 +00009806 /* If we get here, no match was found */
XiaokangQianacb39922022-06-17 10:18:48 +00009807 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01009808 MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL,
9809 MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL);
9810 return MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL;
XiaokangQianacb39922022-06-17 10:18:48 +00009811}
9812
Gilles Peskine449bd832023-01-11 14:50:10 +01009813int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
9814 unsigned char *buf,
9815 unsigned char *end,
9816 size_t *out_len)
XiaokangQianacb39922022-06-17 10:18:48 +00009817{
9818 unsigned char *p = buf;
XiaokangQian95d5f542022-06-24 02:29:26 +00009819 size_t protocol_name_len;
XiaokangQianc7403452022-06-23 03:24:12 +00009820 *out_len = 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009821
Gilles Peskine449bd832023-01-11 14:50:10 +01009822 if (ssl->alpn_chosen == NULL) {
9823 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009824 }
9825
Gilles Peskine449bd832023-01-11 14:50:10 +01009826 protocol_name_len = strlen(ssl->alpn_chosen);
9827 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 7 + protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009828
Gilles Peskine449bd832023-01-11 14:50:10 +01009829 MBEDTLS_SSL_DEBUG_MSG(3, ("server side, adding alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00009830 /*
9831 * 0 . 1 ext identifier
9832 * 2 . 3 ext length
9833 * 4 . 5 protocol list length
9834 * 6 . 6 protocol name length
9835 * 7 . 7+n protocol name
9836 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009837 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_ALPN, p, 0);
XiaokangQianacb39922022-06-17 10:18:48 +00009838
XiaokangQian95d5f542022-06-24 02:29:26 +00009839 *out_len = 7 + protocol_name_len;
XiaokangQianacb39922022-06-17 10:18:48 +00009840
Gilles Peskine449bd832023-01-11 14:50:10 +01009841 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 3, p, 2);
9842 MBEDTLS_PUT_UINT16_BE(protocol_name_len + 1, p, 4);
XiaokangQian0b776e22022-06-24 09:04:59 +00009843 /* Note: the length of the chosen protocol has been checked to be less
9844 * than 255 bytes in `mbedtls_ssl_conf_alpn_protocols`.
9845 */
Gilles Peskine449bd832023-01-11 14:50:10 +01009846 p[6] = MBEDTLS_BYTE_0(protocol_name_len);
XiaokangQianacb39922022-06-17 10:18:48 +00009847
Gilles Peskine449bd832023-01-11 14:50:10 +01009848 memcpy(p + 7, ssl->alpn_chosen, protocol_name_len);
Jerry Yub95dd362022-11-08 21:19:34 +08009849
9850#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01009851 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_ALPN);
Jerry Yub95dd362022-11-08 21:19:34 +08009852#endif
9853
Gilles Peskine449bd832023-01-11 14:50:10 +01009854 return 0;
XiaokangQianacb39922022-06-17 10:18:48 +00009855}
9856#endif /* MBEDTLS_SSL_ALPN */
9857
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009858#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00009859 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009860 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009861 defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01009862int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
9863 const char *hostname)
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009864{
9865 /* Initialize to suppress unnecessary compiler warning */
9866 size_t hostname_len = 0;
9867
9868 /* Check if new hostname is valid before
9869 * making any change to current one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009870 if (hostname != NULL) {
9871 hostname_len = strlen(hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009872
Gilles Peskine449bd832023-01-11 14:50:10 +01009873 if (hostname_len > MBEDTLS_SSL_MAX_HOST_NAME_LEN) {
9874 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9875 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009876 }
9877
9878 /* Now it's clear that we will overwrite the old hostname,
9879 * so we can free it safely */
Gilles Peskine449bd832023-01-11 14:50:10 +01009880 if (session->hostname != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009881 mbedtls_zeroize_and_free(session->hostname,
Gilles Peskine449bd832023-01-11 14:50:10 +01009882 strlen(session->hostname));
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009883 }
9884
9885 /* Passing NULL as hostname shall clear the old one */
Gilles Peskine449bd832023-01-11 14:50:10 +01009886 if (hostname == NULL) {
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009887 session->hostname = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01009888 } else {
9889 session->hostname = mbedtls_calloc(1, hostname_len + 1);
9890 if (session->hostname == NULL) {
9891 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9892 }
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009893
Gilles Peskine449bd832023-01-11 14:50:10 +01009894 memcpy(session->hostname, hostname, hostname_len);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009895 }
9896
Gilles Peskine449bd832023-01-11 14:50:10 +01009897 return 0;
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009898}
Xiaokang Qian03409292022-10-12 02:49:52 +00009899#endif /* MBEDTLS_SSL_PROTO_TLS1_3 &&
9900 MBEDTLS_SSL_SESSION_TICKETS &&
Xiaokang Qianed0620c2022-10-12 06:58:13 +00009901 MBEDTLS_SSL_SERVER_NAME_INDICATION &&
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00009902 MBEDTLS_SSL_CLI_C */
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00009903
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009904#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_EARLY_DATA) && \
9905 defined(MBEDTLS_SSL_ALPN)
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009906int mbedtls_ssl_session_set_ticket_alpn(mbedtls_ssl_session *session,
9907 const char *alpn)
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009908{
9909 size_t alpn_len = 0;
9910
9911 if (alpn != NULL) {
9912 alpn_len = strlen(alpn);
9913
9914 if (alpn_len > MBEDTLS_SSL_MAX_ALPN_NAME_LEN) {
9915 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
9916 }
9917 }
9918
9919 if (session->ticket_alpn != NULL) {
9920 mbedtls_zeroize_and_free(session->ticket_alpn,
9921 strlen(session->ticket_alpn));
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009922 session->ticket_alpn = NULL;
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009923 }
9924
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009925 if (alpn != NULL) {
9926 session->ticket_alpn = mbedtls_calloc(alpn_len + 1, 1);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009927 if (session->ticket_alpn == NULL) {
9928 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
9929 }
Waleed Elmelegy7dfba342024-03-12 16:22:39 +00009930 memcpy(session->ticket_alpn, alpn, alpn_len);
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00009931 }
9932
9933 return 0;
9934}
9935#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02009936#endif /* MBEDTLS_SSL_TLS_C */